PlaybackInfo | References | ArcGIS Maps SDK for JavaScript

import PlaybackInfo from "@arcgis/core/layers/support/PlaybackInfo.js";

Inheritance:: PlaybackInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.33

The PlaybackInfo class provides information about the playback of a video. This information includes the framerate, container format, group of pictures (GOP), aspect ratio, and key length value (KLV).

See also

VideoLayer.playbackInfo

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`PlaybackInfoProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`aspectRatio`	`string \| null \| undefined`
`containerFormat`	`string \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`framerate`	`string \| null \| undefined`
`gop`	`number \| null \| undefined`
`klv`	`Record<string, string> \| null \| undefined`

aspectRatio

Property

Type: string | null | undefined

Describes the relationship between the layers video data width and height. The value is expressed as X

containerFormat

Property

Type: string | null | undefined

The file format that holds and organizes video content including the video data, audio data and metadata. The container acts as a wrapper that defines details about how the video content is constructed.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

framerate

Property

Type: string | null | undefined

The framerate of the video represents the number of frames per second of the video layer media source.

gop

Property

Type: number | null | undefined

The group of pictures (GOP) of the video. The GOP is a value representing a count of successive frames within then coded video stream. Each coded video stream consists of successive GOPs, from which the visible frames are generated.

klv

Property

Type: Record<string, string> | null | undefined

Defines the key length value (KLV) data encoding standard applied to the available metadata content within the stream.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.