import "@arcgis/map-components/components/arcgis-video-player";The Video Player component provides a user interface for interacting with a VideoLayer. It displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.
The Video Player component provides the following capabilities:
- Control operations (play, pause, seek)
- Time and duration display
- Customizable graphics colors
- Following options (sensor, frame, video)
- Adjustable speed and quality
- Access to frame metadata
The VideoPlayerViewModel class provides the logic for the Video Player.
Known limitations
- Not supported in 3D Scenes.
- Not supported on macOS and iOS devices.
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
following-mode | "follow-both" | "follow-frame" | "follow-sensor" | "none" | |
hide-header | boolean | |
icon | string | |
label | string | |
| ||
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
statereadonly | state | "can-play" | "data-loaded" | "error" | "not-ready" | "paused" | "playing" | "ready" | "waiting" |
autoDestroyDisabled
autoDestroyDisabled: booleanIf true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.
- Attribute
- auto-destroy-disabled
- Default value
- false
followingMode
followingMode: "follow-both" | "follow-frame" | "follow-sensor" | "none"Determines which telemetry elements to follow when the video layer is playing.
- Attribute
- following-mode
- Default value
- "follow-both"
hideHeader
hideHeader: booleanIndicates whether to display the video player's header information.
- Attribute
- hide-header
- Default value
- false
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "video-web"
layer
layer: VideoLayerThe VideoLayer to use as the data source for the video player.
Example
// Create a new Video Player with a VideoLayer
videoPlayer.layer = videoLayer;- Default value
- null
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "top-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
- Attribute
- reference-element
state
state: "can-play" | "data-loaded" | "error" | "not-ready" | "paused" | "playing" | "ready" | "waiting"The current state of the component.
- Attribute
- state
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state" | "layer"; }> | |
CustomEvent<void> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state" | "layer"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisVideoReady
arcgisVideoReady: CustomEvent<void>Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisVideoPlayer = document.querySelector("arcgis-video-player");
document.body.append(arcgisVideoPlayer);
await arcgisVideoPlayer.componentOnReady();
console.log("arcgis-video-player is ready to go!");- Returns
- Promise<void>