types | References | ArcGIS Maps SDK for JavaScript

Types

import type { VideoState, SensorOrientationSource, SensorOrientationInfo, VideoMetadataEntry, LivestreamStatus } from "@arcgis/core/layers/video/types.js";

Type definitions

VideoState

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the possible states of a video layer.

Type: "can-play" | "not-ready" | "paused" | "playing" | "ready" | "waiting" | "data-loaded"

SensorOrientationSource

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the possible sources for the sensor orientation.

Type: "platformHeading" | "cameraAzimuth"

SensorOrientationInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the orientation source and symbol offset for the sensor symbol.

source

Property

Type: SensorOrientationSource

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the orientation source for the sensor symbol. Possible values are "platformHeading" and "cameraAzimuth".

symbolOffset

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines the offset angle in degrees to apply to the sensor symbol.

VideoMetadataEntry

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines an object that represents a metadata entry for the video layer.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the metadata entry.

tagId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The tag id of the metadata entry.

value

Property

Type: any

Since: ArcGIS Maps SDK for JavaScript 5.0

The value of the metadata entry.

LivestreamStatus

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.34

Defines an object that represents the livestream status of a video layer.

atLiveEdge

Property

Type: boolean | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if the video layer is at the live edge.

behindLiveEdge

Property

Type: boolean | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if the video layer is behind the live edge.

liveCurrentTime

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The current time of the livestream in seconds.

liveWindow

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The live window of the livestream in seconds.

pastSeekEnd

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The time in seconds that the video layer is past the seek end.

seekableEnd

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The end time of the seekable range in seconds.

seekableStart

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The start time of the seekable range in seconds.

Coverage

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Defines an object that represents the available coverage data of the layer.

area

Property

Type: Polygon | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

A single polygon dataset representing the geometric union of all individual video frame extents collected over the duration of the video collection.

path

Property

Type: Polyline | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

A single polyline representing the continuous spatial path traveled by the collecting sensor.

PreviewsInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Defines an object that contains metadata defining layer previews information.

count

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The number of preview thumbnails in the sprite sheet.

height

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The height in pixels of each preview thumbnail in the sprite sheet.

interval

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The time in milliseconds between each preview thumbnail in the sprite sheet.

numCols

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The number of columns of preview thumbnails in the sprite sheet.

numRows

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The number of rows of preview thumbnails in the sprite sheet.

thumbnailInfo

Property

Type: { offset: number; }[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of objects containing metadata for each preview thumbnail in the sprite sheet, including the time offset of each thumbnail in milliseconds.

urlFragment

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The URL fragment for fetching the sprite sheet containing the thumbnails. This URL is relative to the video source URL and can be used to construct the full URL to the sprite sheet.

width

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.1

The width in pixels of each preview thumbnail in the sprite sheet.