VideoSource

Источник данных, содержащий видео. (Подробную документацию по параметрам см. в спецификации стилей.)

Пример

// 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

См. также

Добавление видео

Обратите внимание, что при отображении в виде растрового слоя свойство raster-fade-duration слоя вызывает постепенное появление видео. Это происходит при начале воспроизведения, его приостановке и возобновлении, а также при обновлении координат видео. Чтобы избежать такого поведения, задайте для свойства raster-fade-duration слоя значение 0.

Наследует

• ImageSource

Методы

fire()

Сигнатура вызова

fire(event: ErrorEvent | MapSourceDataEvent): this

Вызывает все обработчики, зарегистрированные для типа события.

Параметры

Возвращает

this

Унаследовано от

ImageSource.fire

Сигнатура вызова

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

Совместимость с сигнатурой (type: string, properties: Object) из предыдущих версий. См. https://github.com/mapbox/mapbox-gl-js/issues/6522, https://github.com/mapbox/mapbox-gl-draw/issues/766

Параметры

Возвращает

this

Унаследовано от

ImageSource.fire

getVideo()

getVideo(): HTMLVideoElement

Возвращает элемент HTML video.

Возвращает

HTMLVideoElement

Элемент HTML video.

getWarp()

getWarp(): ImageSourceWarp

Experimental

Возвращает способ проецирования изображения на его координаты.

Возвращает

ImageSourceWarp

Используемый способ проецирования; см. ImageSourceWarp.

Унаследовано от

ImageSource.getWarp

listens()

listens(type: keyof SourceEventType): boolean

Возвращает true, если у этого экземпляра Evented или у любого перенаправленного экземпляра Evented есть обработчик указанного типа.

Параметры

Возвращает

boolean

true, если для указанного типа события зарегистрирован хотя бы один обработчик, и false в противном случае

Унаследовано от

ImageSource.listens

loaded()

loaded(): boolean

Возвращает true, если источник загружен, и false в противном случае.

Возвращает

boolean

Унаследовано от

ImageSource.loaded

loadTile()

loadTile(tile: Tile): Promise<void>

Этот метод выполняет основную работу по загрузке тайла. В большинстве случаев он передаёт эту задачу соответствующему источнику-обработчику.

Параметры

Возвращает

Promise<void>

Унаследовано от

ImageSource.loadTile

off()

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

Удаляет ранее зарегистрированный обработчик события.

Параметры типа

Параметры

Возвращает

this

Унаследовано от

ImageSource.off

on()

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

Добавляет обработчик для указанного типа события.

Параметры типа

Параметры

Возвращает

Subscription

Унаследовано от

ImageSource.on

once()

Сигнатура вызова

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

Добавляет обработчик для указанного типа события, который будет вызван только один раз.

Обработчик будет вызван при первом срабатывании события после регистрации обработчика.

Параметры типа

Параметры

Возвращает

Promise<SourceEventType[T]>

промис, который разрешается с событием

Унаследовано от

ImageSource.once

Сигнатура вызова

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

Добавляет обработчик для указанного типа события, который будет вызван только один раз.

Обработчик будет вызван при первом срабатывании события после регистрации обработчика.

Параметры типа

Параметры

Возвращает

this

this, если передан обработчик

Унаследовано от

ImageSource.once

pause()

pause(): void

Приостанавливает воспроизведение видео.

Возвращает

void

play()

play(): void

Воспроизводит видео.

Возвращает

void

prepare()

prepare(): this

Задаёт координаты видео и повторно отрисовывает карту.

Возвращает

this

Переопределяет

ImageSource.prepare

seek()

seek(seconds: number): void

Устанавливает позицию воспроизведения по временной метке в секундах.

Параметры

Возвращает

void

setCoordinates()

setCoordinates(coordinates: Coordinates): this

Задаёт координаты изображения и повторно отрисовывает карту.

Параметры

Возвращает

this

Унаследовано от

ImageSource.setCoordinates

setEventedParent()

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

Передаёт все события, отправленные этим экземпляром Evented, родительскому экземпляру Evented.

Параметры

Возвращает

this

Унаследовано от

ImageSource.setEventedParent

setWarp()

setWarp(warp: ImageSourceWarp): this

Experimental

Задаёт способ деформации изображения при размещении по его координатам и повторно визуализирует карту.

Это действует только тогда, когда координаты не образуют прямоугольник, и не является частью спецификации стиля, поэтому настройка не сохраняется после map.setStyle.

Параметры

Возвращает

this

Пример

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

Унаследовано от

ImageSource.setWarp

updateImage()

updateImage(options: UpdateImageOptions): this

Обновляет изображение и, при необходимости, координаты. Чтобы изображение не мигало после изменения, установите для свойства рисования raster-fade-duration растрового слоя значение 0.

Укажите ровно один из параметров: url (чтобы загрузить новое изображение по сети) или image (уже декодированный HTMLImageElement, HTMLCanvasElement, ImageBitmap или ImageData для отображения напрямую, без сетевого запроса).

Параметры

Возвращает

this

Унаследовано от

ImageSource.updateImage

Свойства

id

id: string

Идентификатор источника. Не должен совпадать с идентификатором существующего источника.

Унаследовано от

ImageSource.id

maxzoom

maxzoom: number

Максимальный уровень масштабирования источника.

Унаследовано от

ImageSource.maxzoom

minzoom

minzoom: number

Минимальный уровень масштабирования источника.

Унаследовано от

ImageSource.minzoom

terrainTileRanges

terrainTileRanges: object

Этот объект используется для хранения диапазона тайлов рельефа, перекрывающихся с этим тайлом. Он имеет значение для тайлов изображений, поскольку изображение выходит за границы отдельного тайла.

Сигнатура индекса

[zoom: string]: CanonicalTileRange

Унаследовано от

ImageSource.terrainTileRanges

tileSize

tileSize: number

Размер тайла источника.

Унаследовано от

ImageSource.tileSize