Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RamblerPlayer

JavaScript API для встраиваемых видео

const player = new RamblerPlayer({
  parentId: '#player',
  id: 1
})
player.on(RamblerPlayer.Events.PLAYER_READY, () => {
  // плеер полностью готов к старту
})

Hierarchy

  • RamblerPlayer

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Events

Events: typeof Events = ...

Интерфейс плеера предоставляет часть методов EventEmitter, что позволяет прослушивать события плеера с помощью JavaScript API.

const player = new RamblerPlayer({
  parentId: '#player',
  id: 1
})
player.on(RamblerPlayer.Events.PLAYER_READY, () => {
  // плеер готов к старту
})
player.on(RamblerPlayer.Events.PLAYER_PLAY, () => {
  // плеер начал проигрывание
})
player.on(RamblerPlayer.Events.PLAYER_PAUSE, () => {
  // плеер встал на паузу
})

Methods

configure

  • configure(options: Options): Promise<void>

  • Настройка плеера после его создания

    Parameters

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

  • Уничтожение текущего плеер и удаление его из DOM

    Returns Promise<void>

getCurrentTime

  • getCurrentTime(): Promise<number>

  • Получение текущего времени проигрывания в секундах

    Returns Promise<number>

getDuration

  • getDuration(): Promise<number>

  • Получение длительности видео в секундах

    Returns Promise<number>

getStartTimeOffset

  • getStartTimeOffset(): Promise<number>

  • Время, которое представляет "0" относительно начала воспроизведения. Для потока с sliding window это значение будет увеличиваться по мере удаления содержимого с начала

    Returns Promise<number>

getVolume

  • getVolume(): Promise<number>

  • Получение громкости текущего видео. Громкость должна быть числом между 0 и 100, где 0 - без звука, 100 - максимальная громкость.

    Returns Promise<number>

isPlaying

  • isPlaying(): Promise<boolean>

  • Проверка, что плеер проигрывает видео

    Returns Promise<boolean>

isReady

  • isReady(): Promise<boolean>

  • Проверка, что плеер готов к запуску

    Returns Promise<boolean>

mute

  • mute(): Promise<void>

  • Выключение звука текущего видео

    Returns Promise<void>

on

  • on(eventType: string, listener: (...args: any[]) => void): void

  • Постоянное прослушивание события

    Parameters

    • eventType: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

once

  • once(eventType: string, listener: (...args: any[]) => void): void

  • Прослушивание события один раз

    Parameters

    • eventType: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

pause

  • pause(): Promise<void>

  • Установка паузы текущего видео

    Returns Promise<void>

play

  • play(): Promise<void>

  • Запуск проигрывания текущего видео

    Returns Promise<void>

removeListener

  • removeListener(eventType: string, listener: (...args: any[]) => void): void

  • Остановка прослушивания события

    Parameters

    • eventType: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

resize

  • resize(size: Pick<Size, "height">): Promise<void>

  • Изменение размера текущего видео

    Parameters

    • size: Pick<Size, "height">

    Returns Promise<void>

seek

  • seek(value: number): Promise<void>

  • Перемотка текущего видео до указанного времени. Например, player.seek(120) перемотает к времени 120 секунд (2 минуты).

    Parameters

    • value: number

    Returns Promise<void>

seekPercentage

  • seekPercentage(percentage: number): Promise<void>

  • Перемотка текущего видео до указанного времени в процентах. Например, player.seekPercentage(50) перемотает к середине видео.

    Parameters

    • percentage: number

    Returns Promise<void>

setVolume

  • setVolume(value: number): Promise<void>

  • Установка громкости текущего видео. Громкость должна быть числом между 0 и 100, где 0 - без звука, 100 - максимальная громкость.

    Parameters

    • value: number

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Остановка воспроизведения текущего видео

    Returns Promise<void>

toggleFullscreen

  • toggleFullscreen(): Promise<void>

  • Переключение полноэкранного режима

    Returns Promise<void>

unmute

  • unmute(): Promise<void>

  • Включение звука текущего видео

    Returns Promise<void>

Static push

  • push(callback: () => void): void

  • Позволяет инициализировать плеер в любое время, например, перед асинхронной загрузкой скрипта SDK.

    <div id="player"></div>
<script>
  window.RamblerPlayer = window.RamblerPlayer || []
  window.RamblerPlayer.push(() => {
    const player = new RamblerPlayer({
      parentId: '#player',
      id: 1
    })
    player.on(RamblerPlayer.Events.PLAYER_READY, () => {
      // плеер полностью готов к старту
    })
  })
</script>
<script async src="https://vp.rambler.ru/player/sdk.js"></script>

    Parameters

    • callback: () => void
        • (): void

        • Returns void

    Returns void

Generated using TypeDoc