Class VideoSource

constructor

• new VideoSource(id, options, dispatcher, eventedParent): VideoSource

• Parameters

  • id: string

  • options: VideoSourceSpecification

  • dispatcher: Dispatcher

  • eventedParent: Evented

  Returns VideoSource

_listeners

_oneTimeListeners

_eventedParent

_eventedParentData

type

id

minzoom

maxzoom

tileSize

url

coordinates

tiles

dispatcher

map

texture

image

tileID

_boundsArray

boundsBuffer

boundsSegments

_loaded

_request

options

urls

video

roundZoom

on

• on(type, listener): VideoSource

• Adds a listener to a specified event type.

  Parameters

  • type: string

    The event type to add a listen for.

  • listener: Listener

    The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.

  Returns VideoSource

  this

off

• off(type, listener): VideoSource

• Removes a previously registered event listener.

  Parameters

  • type: string

    The event type to remove listeners for.

  • listener: Listener

    The listener function to remove.

  Returns VideoSource

  this

once

• once(type, listener?): Promise<any> | VideoSource

• Adds a listener that will be called only once to a specified event type.

  The listener will be called first time the event fires after the listener is registered.

  Parameters

  • type: string

    The event type to listen for.

  • Optional listener: Listener

    The function to be called when the event is fired the first time.

  Returns Promise<any> | VideoSource

  this or a promise if a listener is not provided

fire

• fire(event, properties?): VideoSource

• Parameters

  • event: string | Event$1

  • Optional properties: any

  Returns VideoSource

listens

• listens(type): boolean

• Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

  Parameters

  • type: string

    The event type

  Returns boolean

  true if there is at least one registered listener for specified event type, false otherwise

setEventedParent

• setEventedParent(parent?, data?): VideoSource

• Bubble all events fired by this instance of Evented to this parent instance of Evented.

  Parameters

  • Optional parent: Evented

  • Optional data: any

  Returns VideoSource

  this

loaded

• loaded(): boolean

• Returns boolean

updateImage

• updateImage(options): VideoSource

• Updates the image URL and, optionally, the coordinates. To avoid having the image flash after changing, set the raster-fade-duration paint property on the raster layer to 0.

  Parameters

  • options: UpdateImageOptions

    The options object.

  Returns VideoSource

  this

_finishLoading

• _finishLoading(): void

• Returns void

onRemove

• onRemove(): void

• Returns void

setCoordinates

• setCoordinates(coordinates): VideoSource

• Sets the image's coordinates and re-renders the map.

  Parameters

  • coordinates: Coordinates

    Four geographical coordinates, represented as arrays of longitude and latitude numbers, which define the corners of the image. The coordinates start at the top left corner of the image and proceed in clockwise order. They do not have to represent a rectangle.

  Returns VideoSource

  this

loadTile

• loadTile(tile): Promise<void>

• Parameters

  • tile: Tile

  Returns Promise<void>

load

• load(): Promise<void>

• Returns Promise<void>

pause

• pause(): void

• Pauses the video.

  Returns void

play

• play(): void

• Plays the video.

  Returns void

seek

• seek(seconds): void

• Sets playback to a timestamp, in seconds.

  Parameters

  • seconds: number

  Returns void

getVideo

• getVideo(): HTMLVideoElement

• Returns the HTML video element.

  Returns HTMLVideoElement

  The HTML video element.

onAdd

• onAdd(map): void

• Parameters

  • map: Map$1

  Returns void

prepare

• prepare(): VideoSource

• Sets the video's coordinates and re-renders the map.

  Returns VideoSource

  this

serialize

• serialize(): VideoSourceSpecification

• Returns VideoSourceSpecification

hasTransition

• hasTransition(): boolean

• Returns boolean