Interface: PlayerSdkApi
Methods
destroy
▸ destroy(): Promise<void>
Уничтожает (destroy) плеер и освобождает занимаемые им ресурсы.
Returns
Promise<void>
Промис (promise), который переводится в состояние fulfilled, когда плеер удален.
getState
▸ getState(): PlayerSdkState
Возвращает состояние PlayerSdk.
Returns
off
▸ off<EventName>(eventName, handler): void
Отписывает от события плеера.
Type parameters
| Name | Type |
|---|---|
EventName |
extends PlayerSdkEvents |
Parameters
| Name | Type | Description |
|---|---|---|
eventName |
EventName |
имя события |
handler |
PlayerSdkEventHandlers[EventName] |
обработчик события |
Returns
void
on
▸ on<EventName>(eventName, handler): void
Подписывает на событие плеера.
Type parameters
| Name | Type |
|---|---|
EventName |
extends PlayerSdkEvents |
Parameters
| Name | Type | Description |
|---|---|---|
eventName |
EventName |
имя события |
handler |
PlayerSdkEventHandlers[EventName] |
обработчик события |
Returns
void
once
▸ once<EventName>(eventName, handler): void
Подписывает на однократное срабатывание события плеера.
Type parameters
| Name | Type |
|---|---|
EventName |
extends PlayerSdkEvents |
Parameters
| Name | Type | Description |
|---|---|---|
eventName |
EventName |
имя события |
handler |
PlayerSdkEventHandlers[EventName] |
обработчик события |
Returns
void
pause
▸ pause(): void
Ставит воспроизведение на паузу.
Returns
void
play
▸ play(): Promise<void>
Запускает воспроизведение видео.
Returns
Promise<void>
Промис (promise), который переводится в состояние fulfilled, когда видео начинает воспроизводиться.
seek
▸ seek(time): void
Перематывает видео в заданную позицию.
Parameters
| Name | Type | Description |
|---|---|---|
time |
Seconds |
время в секундах |
Returns
void
setMuted
▸ setMuted(muted): void
Выключает/включает звук в видео.
Parameters
| Name | Type | Description |
|---|---|---|
muted |
boolean |
true, если нужно выключить звук, и false — если нужно включить звук |
Returns
void
setSource
▸ setSource(sourceConfig): Promise<void>
Задает источник видео.
Parameters
| Name | Type | Description |
|---|---|---|
sourceConfig |
PlayerSdkSourceConfig |
источник видео, на который нужно переключиться, и параметры |
Returns
Promise<void>
Промис (promise), который переводится в состояние fulfilled, когда освобождаются основные ресурсы.
setVolume
▸ setVolume(volume): void
Устанавливает уровень громкости звука в видео.
Parameters
| Name | Type | Description |
|---|---|---|
volume |
Volume |
громкость видео от 0 (звук не слышен) до 1 (максимальная громкость) |
Returns
void