VideoSource

A data source containing video. (See the Style Specification for detailed documentation of options.)

Example

// add to map
map.addSource('some id', {
   type: 'video',
   url: [
       'https://www.mapbox.com/blog/assets/baltimore-smoke.mp4',
       'https://www.mapbox.com/blog/assets/baltimore-smoke.webm'
   ],
   coordinates: [
       [-76.54, 39.18],
       [-76.52, 39.18],
       [-76.52, 39.17],
       [-76.54, 39.17]
   ]
});

// update
let mySource = map.getSource('some id');
mySource.setCoordinates([
    [-76.54335737228394, 39.18579907229748],
    [-76.52803659439087, 39.1838364847587],
    [-76.5295386314392, 39.17683392507606],
    [-76.54520273208618, 39.17876344106642]
]);

map.removeSource('some id');  // remove

See

Add a video

Note that when rendered as a raster layer, the layer's raster-fade-duration property will cause the video to fade in. This happens when playback is started, paused and resumed, or when the video's coordinates are updated. To avoid this behavior, set the layer's raster-fade-duration property to 0.

Extends

ImageSource

Methods

fire()

Call Signature

fire(event: ErrorEvent | MapSourceDataEvent): this

Defined in: util/evented.ts:156

Calls every listener registered for the event's type.

Parameters

Parameter	Type
`event`	`ErrorEvent` \| `MapSourceDataEvent`

Returns

this

Inherited from

ImageSource.fire

Call Signature

fire(type: keyof SourceEventType, properties?: object): this

Defined in: util/evented.ts:162

Compatibility with the (type: string, properties: Object) signature from previous versions. See https://github.com/mapbox/mapbox-gl-js/issues/6522, https://github.com/mapbox/mapbox-gl-draw/issues/766

Parameters

Parameter	Type
`type`	keyof `SourceEventType`
`properties?`	`object`

Returns

this

Inherited from

ImageSource.fire

getVideo()

getVideo(): HTMLVideoElement

Defined in: source/video_source.ts:139

Returns the HTML video element.

Returns

HTMLVideoElement

The HTML video element.

getWarp()

getWarp(): ImageSourceWarp

Defined in: source/image_source.ts:387

Experimental

Returns how the image is warped onto its coordinates.

Returns

ImageSourceWarp

The warp in use, see ImageSourceWarp.

Inherited from

ImageSource.getWarp

listens()

listens(type: keyof SourceEventType): boolean

Defined in: util/evented.ts:206

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

Parameters

Parameter	Type	Description
`type`	keyof `SourceEventType`	The event type

Returns

boolean

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

Inherited from

ImageSource.listens

loaded()

loaded(): boolean

Defined in: source/image_source.ts:259

True if the source is loaded, false otherwise.

Returns

boolean

Inherited from

ImageSource.loaded

loadTile()

loadTile(tile: Tile): Promise<void>

Defined in: source/image_source.ts:468

This method does the heavy lifting of loading a tile. In most cases it will defer the work to the relevant worker source.

Parameters

Parameter	Type	Description
`tile`	`Tile`	The tile to load

Returns

Promise<void>

Inherited from

ImageSource.loadTile

off()

off<T>(type: T, listener: (event: SourceEventType[T]) => void): this

Defined in: util/evented.ts:117

Removes a previously registered event listener.

Type Parameters

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to remove listeners for.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	The listener function to remove.

Returns

this

Inherited from

ImageSource.off

on()

on<T>(type: T, listener: (event: SourceEventType[T]) => void): Subscription

Defined in: util/evented.ts:100

Adds a listener to a specified event type.

Type Parameters

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to add a listen for.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	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

Subscription

Inherited from

ImageSource.on

once()

Call Signature

once<T>(type: T): Promise<SourceEventType[T]>

Defined in: util/evented.ts:132

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.

Type Parameters

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to listen for.

Returns

Promise<SourceEventType[T]>

a promise that resolves with the event

Inherited from

ImageSource.once

Call Signature

once<T>(type: T, listener: (event: SourceEventType[T]) => void): this

Defined in: util/evented.ts:142

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.

Type Parameters

Type Parameter
`T` extends keyof `SourceEventType`

Parameters

Parameter	Type	Description
`type`	`T`	The event type to listen for.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	The function to be called when the event is fired the first time.

Returns

this

this when a listener is provided

Inherited from

ImageSource.once

pause()

pause(): void

Defined in: source/video_source.ts:107

Pauses the video.

Returns

void

play()

play(): void

Defined in: source/video_source.ts:116

Plays the video.

Returns

void

prepare()

prepare(): this

Defined in: source/video_source.ts:164

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

Returns

this

Overrides

ImageSource.prepare

seek()

seek(seconds: number): void

Defined in: source/video_source.ts:125

Sets playback to a timestamp, in seconds.

Parameters

Parameter	Type
`seconds`	`number`

Returns

void

setCoordinates()

setCoordinates(coordinates: Coordinates): this

Defined in: source/image_source.ts:399

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

Parameters

Parameter	Type	Description
`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

this

Inherited from

ImageSource.setCoordinates

setEventedParent()

setEventedParent(parent?: Evented<EventTypeMap>, data?: EventedParentData | (() => EventedParentData)): this

Defined in: util/evented.ts:217

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

Parameters

Parameter	Type
`parent?`	`Evented`<`EventTypeMap`>
`data?`	`EventedParentData` \| (() => `EventedParentData`)

Returns

this

Inherited from

ImageSource.setEventedParent

setWarp()

setWarp(warp: ImageSourceWarp): this

Defined in: source/image_source.ts:370

Experimental

Sets how the image is warped onto its coordinates and re-renders the map.

This only has an effect while the coordinates do not form a rectangle, and it is not part of the style specification, so it does not survive map.setStyle.

Parameters

Parameter	Type	Description
`warp`	`ImageSourceWarp`	The warp to use, see ImageSourceWarp.

Returns

this

Example

// Keep the image pinned to its corners while the user drags them around.
map.getSource('some id').setWarp('flat');

Inherited from

ImageSource.setWarp

updateImage()

updateImage(options: UpdateImageOptions): this

Defined in: source/image_source.ts:273

Updates the image 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.

Provide exactly one of url (to fetch a new image over the network) or image (an already-decoded HTMLImageElement, HTMLCanvasElement, ImageBitmap or ImageData to display directly, without a network request).

Parameters

Parameter	Type	Description
`options`	`UpdateImageOptions`	The options object.

Returns

this

Inherited from

ImageSource.updateImage

Properties

id

id: string

Defined in: source/image_source.ts:179

The id for the source. Must not be used by any existing source.

Inherited from

ImageSource.id

maxzoom

maxzoom: number

Defined in: source/image_source.ts:181

The maximum zoom level for the source.

Inherited from

ImageSource.maxzoom

minzoom

minzoom: number

Defined in: source/image_source.ts:180

The minimum zoom level for the source.

Inherited from

ImageSource.minzoom

terrainTileRanges

terrainTileRanges: object

Defined in: source/image_source.ts:188

This object is used to store the range of terrain tiles that overlap with this tile. It is relevant for image tiles, as the image exceeds single tile boundaries.

Index Signature

[zoom: string]: CanonicalTileRange

Inherited from

ImageSource.terrainTileRanges

tileSize

tileSize: number

Defined in: source/image_source.ts:182

The tile size for the source.

Inherited from

ImageSource.tileSize