ESM: import VideoLayer from "@arcgis/core/layers/VideoLayer.js";
CDN: const VideoLayer = await $arcgis.import("@arcgis/core/layers/VideoLayer.js");
Class: @arcgis/core/layers/VideoLayer
Since: ArcGIS Maps SDK for JavaScript 4.30
The VideoLayer provides video content from on-demand and livestream feeds from an ArcGIS Video Server. Application developers using VideoLayer can display the video georeferenced on a Map, and control the playback with the VideoPlayer widget.
Known Limitations
Example
const videoLayer = new VideoLayer({ url }); new VideoLayer(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Example
// Create a new VideoLayer instance referencing a video service
const videoLayer = new VideoLayer({ url });Show inherited properties Hide inherited properties
Property DetailsSince: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, autoplay added at 4.33.
Indicates if the video layer is configured to start playback when ready.
Example
// Configure the layer to start playback when ready
videoLayer.autoplay = true; blendMode String
Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. Unlike the method of using transparency which can result in a washed-out top layer, blend modes can create a variety of very vibrant and intriguing results by blending a layer with the layer(s) below it.
When blending layers, a top layer is a layer that has a blend mode applied. All layers underneath the top layer are background layers. The default blending mode is normal where the top layer is simply displayed over the background layer. While this default behavior is perfectly acceptable, the use of blend modes on layers open up a world of endless possibilities to generate creative maps.
The layers in a GroupLayer are blended together in isolation from the rest of the map.
In the following screenshots, the vintage shaded relief layer is displayed over a firefly world imagery layer. The color blend mode is applied to the vintage shaded relief and the result looks like a new layer.
The following factors will affect the blend result:
average blend mode is often similar to the effect of setting the layer's opacity to 50%.
Lighten blend modes:
The following blend modes create lighter results than all layers. In lighten blend modes, pure black colors in the top layer become transparent allowing the background layer to show through. White in the top layer will stay unchanged. Any color that is lighter than pure black is going to lighten colors in the top layer to varying degrees all way to pure white.
Lighten blend modes can be useful when lightening dark colors of the top layer or removing black colors from the result. The plus, lighten and screen modes can be used to brighten layers that have faded or dark colors on a dark background.
darken blend mode. lighter Colors in top and background layers are multiplied by their alphas (layer opacity and layer's data opacity. Then the resulting colors are added together. All overlapping midrange colors are lightened in the top layer. The opacity of layer and layer's data will affect the blend result. plus Colors in top and background layers are added together. All overlapping midrange colors are lightened in the top layer. This mode is also known as add or linear-dodge. screen Multiplies inverted colors in top and background layers then inverts the colors again. The resulting colors will be lighter than the original color with less contrast. Screen can produce many different levels of brightening depending on the luminosity values of the top layer. Can be thought of as the opposite of the multiply mode. color-dodge Divides colors in background layer by the inverted top layer. This lightens the background layer depending on the value of the top layer. The brighter the top layer, the more its color affects the background layer. Decreases the contrast between top and background layers resulting in saturated mid-tones and blown highlights.
Darken blend modes:
The following blend modes create darker results than all layers. In darken blend modes, pure white in the top layer will become transparent allowing the background layer to show through. Black in the top layer will stay unchanged. Any color that is darker than pure white is going to darken a top layer to varying degrees all the way to pure black.
The multiply blend mode is often used to highlight shadows, show contrast, or accentuate an aspect of a map. For example, you can use multiply blend mode on a topographic map displayed over hillshade when you want to have your elevation show through the topographic layer. See the intro to layer blending sample.
The multiply and darken modes can be used to have dark labels of the basemap to show through top layers. See the darken blending sample.
The color-burn mode works well with colorful top and background layers since it increases saturation in mid-tones. It increases the contrast by tinting pixels in overlapping areas in top and bottom layers more towards the top layer color. Use this blend mode, when you want an effect with more contrast than multiply or darken.
The following screenshots show how the multiply blend mode used for creating a physical map of the world that shows both boundaries and elevation.
Contrast blend modes:
The following blend modes create contrast by both lightening the lighter areas and darkening the darker areas in the top layer by using lightening or darkening blend modes to create the blend. The contrast blend modes will lighten the colors lighter than 50% gray ([128,128,128]), and darken the colors darker than 50% gray. 50% gray will be transparent in the top layer. Each mode can create a variety of results depending on the colors of top and background layers being blended together. The overlay blend mode makes its calculations based on the brightness of the colors in the background layer while all of the other contrast blend modes make their calculations based on the brightness of the top layer. Some of these modes are designed to simulate the effect of shining a light through the top layer, effectively projecting upon the layers beneath it.
Contrast blend modes can be used to increase the contrast and saturation to have more vibrant colors and give a punch to your layers. For example, you can duplicate a layer and set overlay blend mode on the top layer to increase the contrast and tones of your layer. You can also add a polygon layer with a white fill symbol over a dark imagery layer and apply soft-light blend mode to increase the brightness in the imagery layer.
The following screenshots show an effect of the overlay blend mode on a GraphicsLayer. The left image shows when the buffer graphics layer has the normal blend mode. As you can see, the gray color for the buffer polygon is blocking the intersecting census tracts. The right image shows when the overlay blend mode is applied to the buffer graphics layer. The overlay blend mode darkens or lightens the gray buffer polygon depending on the colors of the background layer while the census tracts layer is shining through. See this in action.
multiply and screen modes to darken and lighten colors in the top layer with the background layer always shining through. The result is darker color values in the background layer intensify the top layer, while lighter colors in the background layer wash out overlapping areas in the top layer. soft-light Applies a half strength screen mode to lighter areas and half strength multiply mode to darken areas of the top layer. You can think of the soft-light as a softer version of the overlay mode. hard-light Multiplies or screens the colors, depending on colors of the top layer. The effect is similar to shining a harsh spotlight on the top layer. vivid-light Uses a combination of color-burn or color-dodge by increasing or decreasing the contrast, depending on colors in the top layer.
Component blend modes:
The following blend modes use primary color components, which are hue, saturation and luminosity to blend top and background layers. You can add a feature layer with a simple renderer over any layer and set hue, saturation, color or luminosity blend mode on this layer. With this technique, you create a brand new looking map.
The following screenshots show where the topo layer is blended with world hillshade layer with luminosity blend mode. The result is a drastically different looking map which preserves the brightness of the topo layer while adapting the hue and saturation of the hillshade layer.
color blend mode. color Creates an effect with the hue and saturation of the top layer and the luminosity of the background layer. Can be thought of as the opposite of luminosity blend mode.
Composite blend modes:
The following blend modes can be used to mask the contents of top, background or both layers.
Destination modes are used to mask the data of the top layer with the data of the background layer.Source modes are used to mask the data of the background layer with the data of the top layer.The destination-in blend mode can be used to show areas of focus such as earthquakes, animal migration, or point-source pollution by revealing the underlying map, providing a bird's eye view of the phenomenon. Check out multiple blending and groupLayer blending samples to see composite blend modes in action.
The following screenshots show feature and imagery layers on the left side on their own in the order they are drawn in the view. The imagery layer that contains land cover classification rasters. The feature layer contains 2007 county crops data. The right image shows the result of layer blending where destination-in blendMode is set on the imagery layer. As you can see, the effect is very different from the original layers. The blended result shows areas of cultivated crops only (where both imagery and feature layers overlap).
Invert blend modes:
The following blend modes either invert or cancel out colors depending on colors of the background layer. These blend modes look for variations between top and background layers. For example, you can use difference or exclusion blend modes on two imagery layers of forest covers to visualize how forest covers changed from one year to another.
The invert blend mode can be used to turn any light basemap into a dark basemap to accommodate those who work in low-light conditions. The following screenshots show how setting the invert blend mode set on a feature layer with a simple renderer turns the world terrain basemap into a dark themed basemap in no time.
difference blend mode, except that the resulting image is lighter overall. Overlapping areas with lighter color values are lightened, while darker overlapping color values become transparent. minus Subtracts colors of the top layer from colors of the background layer making the blend result darker. In the case of negative values, black is displayed. invert Inverts the background colors wherever the top and background layers overlap. The invert blend mode inverts the layer similar to a photographic negative. reflect This blend mode creates effects as if you added shiny objects or areas of light in the layer. Black pixels in the background layer are ignored as if they were transparent.
Possible Values:"average" |"color-burn" |"color-dodge" |"color" |"darken" |"destination-atop" |"destination-in" |"destination-out" |"destination-over" |"difference" |"exclusion" |"hard-light" |"hue" |"invert" |"lighten" |"lighter" |"luminosity" |"minus" |"multiply" |"normal" |"overlay" |"plus" |"reflect" |"saturation" |"screen" |"soft-light" |"source-atop" |"source-in" |"source-out" |"vivid-light" |"xor"
buffered Numberreadonly
Represents the length of the currently buffered video in seconds. The buffered time is updated as the video is played.
The capabilities of the video layer. The capabilities describe the operations the video layer supports and are defined by the video service.
The operations capabilities of the video layer.
Indicates if the video layer supports appending data.
Indicates if the video layer supports coverage queries.
Indicates if the video layer supports exporting clips.
Indicates if the video layer supports exporting frames.
Indicates if the video layer supports mensuration.
Indicates if the video layer supports display of frame previews.
Indicates if the video layer supports updating data.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, codecs added at 4.33.
Defines the codecs on the media content of the video layer. The codec for audio, text and video are defined on the video service during layer creation. Media type and formats are described in more detail here.
The copyright information for the video layer.
Example
// Set the copyright
videoLayer.copyright = "© 2024 Esri";The date the video layer was created.
currentTime Number
The current time of the video layer in seconds.
Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
The description of the video layer.
Example
// Set the description
videoLayer.description = "This is a video layer"; duration Numberreadonly
The duration of the video layer in seconds.
Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. This powerful capability allows you to apply css filter-like functions to layers to create custom visual effects to enhance the cartographic quality of your maps. This is done by applying the desired effect to the layer's effect property as a string or an array of objects to set scale dependent effects.
Notes
featureEffect, effect, opacity and blendMode.Known Limitations
cluster enabled.Examples
// the following effect will be applied to the layer at all scales
// brightness will be applied first, then hue-rotate followed by contrast
// changing order of the effects will change the final result
layer.effect = "brightness(5) hue-rotate(270deg) contrast(200%)";// set a scale dependent bloom effect on the layer
layer.effect = [
{
scale: 36978595,
value: "drop-shadow(3px, 3px, 4px)"
},
{
scale: 18489297,
value: "drop-shadow(2px, 2px, 3px)"
},
{
scale: 4622324,
value: "drop-shadow(1px, 1px, 2px)"
}
]; ended Booleanreadonly
Indicates if the video layer has ended and the current time is equal to the duration of the video.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, frameCenterSymbol added at 4.33.
A SimpleMarkerSymbol used for representing the center point of a video frame.
The total number of frames in the video layer.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, frameEffect added at 4.33.
Provides filter functions that can be performed on the video frame to achieve different visual effects.
frameOpacity Number
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, frameOpacity added at 4.33.
The opacity of the video frame draped on the map. Value can be a number between 0 and 1 where 0 is 100% transparent, 0.5 is 50% transparent and 1 is fully opaque.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, frameOutlineSymbol added at 4.33.
A SimpleFillSymbol used for representing the coverage area of a video frame.
The full extent of the video layer.
Example
// Set the map view's extent to the full extent of the video layer
await layer.load();
view.goTo(layer.fullExtent);Inherited
Property id String
The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.
The initial extent of the video layer.
Example
// Set the map view's extent to the initial extent of the video layer
await layer.load();
view.goTo(layer.initialExtent); isLive Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, isLive added at 4.33.
The active stream is loaded as a livestream video layer
The layer id of the video layer.
Inherited
Property listMode String
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
Possible Values:"show" |"hide" |"hide-children"
The Error object returned if an error occurred while loading.
Inherited
Property loadStatus Stringreadonly
Represents the status of a load operation.
Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details.Possible Values:"not-loaded" |"loading" |"failed" |"loaded"
Default Value:"not-loaded"
Inherited
Property loadWarnings Object[]readonly
A list of warnings which occurred while loading.
Inherited
Property loaded Booleanreadonly
Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.
Indicates if the video layer should loop. If the video layer is set to loop, the video will restart from the beginning once it reaches the end. Otherwise, the video will stop playing once it reaches the end.
Example
// Loop the video layer
videoLayer.loop = true; maxScale Number
The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.
Examples
// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
layer.maxScale = 1000;// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;The metadata for the video layer. The metadata includes information such as the telemetry data, sensor model, and video frame information.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, mimeType added at 4.33.
Defines the mime type of the active playback source
minScale Number
The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.
Examples
// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
layer.minScale = 3000000;// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;Indicates if the video layer is muted.
Example
// Mute the video layer
videoLayer.muted = true;Inherited
Property opacity Number
The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.
Example
// Makes the layer 50% transparent
layer.opacity = 0.5;The parent to which the layer belongs.
Inherited
Property persistenceEnabled Booleanreadonly
When true, the layer can be persisted. This property only has an effect for layers that are part of the WebMap or WebScene spec.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, playbackInfo added at 4.33.
The playback information for the video layer. The playback information includes the framerate, container format, group of pictures (GOP), aspect ratio, and key length value (KLV).
playbackRate Number
The playback rate of the video layer. The playback rate is the speed at which the video is played.
Example
// Set the playback rate of the video layer
videoLayer.playbackRate = 2; playing Booleanreadonly
Indicates if the video layer is playing.
The URL to the poster image for the video layer.
The available video qualities for the video layer.
Quality Resolution Description sd 720x480 Standard Definition hd 1280x720 High Definition fhd 1920x1080 Full High Definition qhd 2560x1440 Quad High Definition uhd 3840x2160 Ultra High DefinitionPossible Values:"sd" |"hd" |"fhd" |"qhd" |"uhd"
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, sensorSightLineSymbol added at 4.33.
A SimpleLineSymbol used for representing the line of sight from the sensor to the center of the frame coverage area.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, sensorSymbol added at 4.33.
A SimpleMarkerSymbol, PictureMarkerSymbol or CIMSymbol used for representing the point position geometry of the video sensor.
The default sensor symbol is the following:
{
type: "simple-marker",
style: "circle",
size: 16,
color: [255, 127, 0],
outline: {
color: [255, 255, 255],
width: 1.33
}
}
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, sensorTrailSymbol added at 4.33.
A SimpleLineSymbol used for representing the trailing line of travel of a moving video collection sensor.
The ArcGIS Enterprise Portal item id of the video service.
The source quality of the video layer.
Quality Resolution Description sd 720x480 Standard Definition hd 1280x720 High Definition qhd 2560x1440 Quad High Definition uhd 3840x2160 Ultra High DefinitionPossible Values:"sd" |"hd" |"fhd" |"qhd" |"uhd"
The source type of the video layer.
Possible Values:"ondemand" |"livestream"
The spatial reference of the video layer.
Example
// Set the spatial reference of the video layer
videoLayer.spatialReference = new SpatialReference({
wkid: 4326
});Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, start added at 4.33.
The playback start time in seconds since the beginning of the video.
started Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, started added at 4.33.
The layer play operation has been invoked at least one time.
The current state of the video layer.
Possible Values:"can-play" |"not-ready" |"paused" |"playing" |"ready" |"waiting" |"data-loaded"
The telemetry data for the video layer. The telemetry data is used to display the frame and sensor location on the map and is updated as the video is played.
The telemetry display for the video layer. The telemetry display is used to determine what telemetry data to display on the video layer.
Example
// Display only the frame outline
videoLayer.telemetryDisplay = new TelemetryDisplay({
frame: false,
frameCenter: false,
frameOutline: true,
lineOfSight: false,
sensorLocation: false,
sensorTrail: false,
});The title of the layer used to identify it in places such as the Legend and LayerList widgets.
Example
// Set the title of the video layer
videoLayer.title = "My Video Layer";Inherited
Property uid Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 Layer since 4.0, uid added at 4.33.
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
The URL to the REST endpoint of the video service.
Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, version added at 4.33.
The video service version of this layer.
The height of the video in pixels.
Defines layer information for video layers published within the same video service
The time extent of the video.
The width of the video in pixels.
Specifies a fixed time extent during which a layer should be visible. This property can be used to configure a layer that does not have time values stored in an attribute field to work with time. Once configured, the TimeSlider widget will display the layer within the set time extent. In the case that only one of the start or end date values are available, the layer remains visible indefinitely in the direction where there is no time value.
Aerial imagery can capture seasonal variations in vegetation, water bodies, and land use patterns. For example, in agricultural regions, aerial imageries taken during different growing seasons provide insights into crop health and productivity. Defining a fixed time extent on imageries from specific time periods provides temporal context and facilitates focused analysis based on specific time periods or events.
Inherited
Property visible Boolean
Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.
Example
// The layer is no longer visible in the view
layer.visible = false;
// Watch for changes in the layer's visibility
// and set the visibility of another layer when it changes
reactiveUtils.watch(
() => layer.visible,
(visible) => {
if (visible) {
anotherLayer.visible = true;
} else {
anotherLayer.visible = false;
}
}
);Since: ArcGIS Maps SDK for JavaScript 4.33 VideoLayer since 4.30, volume added at 4.33.
The volume property sets or returns the audio volume of a video, from 0.0 (silent) to 1.0 (loudest). The default value is 0.0.
Indicates if the video layer is waiting for data. If true, the video layer is waiting for data; otherwise, it is not waiting for data.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles
const handle = reactiveUtils.when(
() => !view.updating,
() => {
wkidSelect.disabled = false;
},
{ once: true }
);
this.addHandles(handle);
// Destroy the object
this.destroy();
Parameters
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
Inherited
Method cancelLoad()
Cancels a load() operation if it is already in progress.
Inherited
Method createLayerView(view, options){Promise<LayerView>}
Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.
Parameters
view *
The parent view.
optionalAn object specifying additional options. See the object specification table below for the required properties of this object.
Returns
Inherited
Method destroy()
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.
The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method fetchAttributionData(){Promise<Object>}
Fetches custom attribution data for the layer when it becomes available.
Returns
Type Description Promise<Object> Resolves to an object containing custom attribution data for the layer.Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
obj.removeHandles("watch-view-updates");
}Inherited
Method isFulfilled(){Boolean}
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method isRejected(){Boolean}
isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method isResolved(){Boolean}
isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been resolved.Inherited
Method load(options){Promise}
Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.
It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.
Parameters
optionalAdditional options.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
Type Description Promise Resolves when the resources have loaded.Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() method that should be called to stop listening for the event(s). Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
// event is the event handle returned after the event fires.
console.log(event.mapPoint);
});Pauses the video layer.
Example
// Pause the video layer
videoLayer.pause();Plays the video layer.
Example
// Play the video layer
videoLayer.play();Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");Resets the video layer to its initial state.
Example
// Reset the video layer
videoLayer.reset(); setCurrentTime(timestamp)
Sets the current time, in seconds, of the video layer.
Parameter
The timestamp to set the video layer to.
Example
// Set the current time of the video layer to 30 seconds
videoLayer.setCurrentTime(30); updateTelemetryColor(color)
Updates the telemetry color of all telemetry symbol elements to the provided color value.
Parameter
The color to set the video telemetry symbol color to.
Example
// Set the telemetry color to red
videoLayer.updateTelemetryColor(new Color("red"));Inherited
Method when(callback, errback){Promise}
when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.
Parameters
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new promise for the result ofcallback that may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
// This function will execute once the promise is resolved
}, function(error){
// This function will execute if the promise is rejected due to an error
}); Codecs
The Codecs is an object that represents the codecs used by the video layer.
The audio codec used in the video layer.
The text codec used in the video layer.
The video codec used in the video layer.
VideoMetadataEntry
The VideoMetadataEntry is an object that represents a metadata entry for the video layer.
The name of the metadata entry.
The tag id of the metadata entry.
The value of the metadata entry.
VideoPoint
The VideoPoint is an object that represents a point on the current video frame.
The x coordinate on the current video frame in pixels from the top left corner
The y coordinate on the current video frame in pixels from the top left corner
VideoServiceLayerInfo
The VideoServiceLayerInfo defines layer information for video layers published within the same video service.
The layer id of the video layer.
The URL to the poster image for the video layer.
The source type of the video layer.
Possible Values:"ondemand"|"livestream"
The title of the video layer.
The layer type. The type is always "Video Layer" for VideoLayers.
The value is always "Video Layer".
Show inherited events Hide inherited events
Event DetailsInherited
Event layerview-create
Fires after the layer's LayerView is created and rendered in a view.
The view in which the layerView was created.
The LayerView rendered in the view representing the layer in layer.
Example
// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
// The LayerView for the layer that emitted this event
event.layerView;
});Inherited
Event layerview-create-error
Fires when an error emits during the creation of a LayerView after a layer has been added to the map.
The view that failed to create a layerview for the layer emitting this event.
An error object describing why the layer view failed to create.
Example
// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});Inherited
Event layerview-destroy
Fires after the layer's LayerView is destroyed and no longer renders in a view.
The view in which the layerView was destroyed.
The destroyed LayerView representing the layer.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4