Класс: PlayerManager

каст. фреймворк . Менеджер игрока

статический класс

Осуществляет управление и мониторинг воспроизведения мультимедиа.

Броски

non-null Error Если конструктор используется напрямую. Доступ PlayerManager следует осуществлять только путем вызова cast.framework.CastReceiverContext#getPlayerManager .

Методы

addEventListener

addEventListener(eventType, eventListener)

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

Параметр
eventType	(ненулевой cast.framework.events.EventType или ненулевой массив ненулевых cast.framework.events.EventType ) Тип события или массив типов событий
eventListener	function(non-null cast.framework.events.Event )

Броски

non-null Error если предоставленные аргументы недействительны.

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Добавляет новые поддерживаемые команды к существующему списку поддерживаемых команд управления мультимедиа.

Параметр
supportedMediaCommands	число Битовая маска команд мультимедиа, поддерживаемых приложением.
broadcastStatus	Необязательный логический true указывает на то, что отправители должны быть уведомлены об изменении (если значение не указано, отправители будут уведомлены).

См. также

cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

Отправляет сообщение о состоянии медиафайла всем отправителям (широковещательная рассылка). Приложения используют это для отправки пользовательского изменения состояния.

Параметр
includeMedia	Необязательный логический true указывает на то, что сообщение должно содержать информацию о медиафайлах.
requestId	Необязательный число Идентификатор входящего запроса, вызвавшего данный ответ.
пользовательские данные	Необязательный Объект Пользовательские данные, специфичные для конкретного приложения, содержащиеся в сообщении о состоянии. Значение может быть нулевым.
includeQueueItems	Необязательный логический Включать ли элементы очереди в сообщение о состоянии. По умолчанию они не включаются.

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) возвращает число

Преобразует время воспроизведения медиафайла в абсолютное время. Абсолютное время применимо только для прямых трансляций.

Параметр
медиаТайм	число Время для СМИ.

Возвраты

nullable number Абсолютное время или null , если оно недоступно.

getAudioTracksManager

Метод getAudioTracksManager() возвращает cast.framework.AudioTracksManager

Получает экземпляр AudioTracksManager .

Возвраты

non-null cast.framework.AudioTracksManager

getBreakClipCurrentTimeSec

Функция getBreakClipCurrentTimeSec() возвращает число.

Возвращает текущее время воспроизводимого в данный момент фрагмента паузы в секундах.

Возвраты

nullable number Текущее время в секундах внутри текущего фрагмента паузы. null , когда Player не воспроизводит фрагмент паузы.

getBreakClipDurationSec

Метод getBreakClipDurationSec() возвращает число.

Возвращает продолжительность воспроизводимого в данный момент фрагмента паузы в секундах.

Возвраты

Длительность текущего фрагмента с паузой nullable number . null если Player не воспроизводит фрагмент с паузой.

getBreakManager

Метод getBreakManager() возвращает cast.framework.breaks.BreakManager

Получает экземпляр BreakManager .

Возвраты

non-null cast.framework.breaks.BreakManager

getBreaks

Метод getBreaks() возвращает массив ненулевых объектов. cast.framework.messages.Break

Возвращает список разрывов.

Возвраты

non-null Array of non-null cast.framework.messages.Break

getCurrentSupportedMediaCommands

Метод getCurrentSupportedMediaCommands() возвращает число.

Получает список поддерживаемых приемником медиакоманд. В отличие от метода getSupportedMediaCommands() , возвращаемое значение этого метода динамически изменяется в зависимости от текущего состояния воспроизведения. Например, во время воспроизведения рекламы команда SEEK может не поддерживаться. Этот метод следует вызывать только после вызова метода CastReceiverContext#start приемника, в противном случае он вернет 0 .

См. также

cast.framework.messages.Command

Возвраты

number — битовая маска команд мультимедиа, поддерживаемых приложением.

getCurrentTimeSec

Метод getCurrentTimeSec() возвращает число.

Получает информацию о прошедшем времени воспроизведения текущего медиафайла.

Возвраты

number прошедшее время в секундах. Если воспроизведение медиафайлов отсутствует, значение будет равно 0 .

getDurationSec

Метод getDurationSec() возвращает число.

Получает продолжительность воспроизводимого в данный момент медиафайла в секундах.

Возвраты

number воспроизведения медиафайла. NaN если воспроизведение медиафайла не запущено.

getLiveSeekableRange

Метод getLiveSeekableRange() возвращает cast.framework.messages.LiveSeekableRange

Возвращает диапазон прокрутки в реальном времени с указанием времени начала и окончания в секундах. Значения основаны на времени воспроизведения медиафайла.

Возвраты

nullable cast.framework.messages.LiveSeekableRange

получитьМедиаИнформация

Метод getMediaInformation() возвращает cast.framework.messages.MediaInformation

Получает информацию о текущих событиях в СМИ.

Возвраты

nullable cast.framework.messages.MediaInformation

getMediaTimeForAbsoluteTime

getMediaTimeForAbsoluteTime(absoluteTime) возвращает число

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

Параметр
абсолютное время	число Абсолютное время, указанное в СМИ, в формате UNIX Epoch time (секунды с начала эпохи Unix).

Возвраты

nullable number Время воспроизведения медиафайла или null , если оно недоступно.

getPlaybackConfig

Метод getPlaybackConfig() возвращает cast.framework.PlaybackConfig

Возвращает конфигурацию воспроизведения или null , если значения по умолчанию не были переопределены.

Возвраты

nullable cast.framework.PlaybackConfig

getPlaybackRate

Функция getPlaybackRate() возвращает число.

Возвращает текущую скорость воспроизведения. Возвращает 1 до вызова CastReceiverContext#start для приемника.

Возвраты

number скорость воспроизведения.

getPlayerState

Метод getPlayerState() возвращает cast.framework.messages.PlayerState

Получает состояние Player .

Возвраты

non-null cast.framework.messages.PlayerState Состояние текущего Player .

getPreferredPlaybackRate

Функция getPreferredPlaybackRate() возвращает число.

Получите предпочтительную частоту воспроизведения. Может использоваться при завершении работы программы для сохранения последней предпочтительной частоты воспроизведения в постоянном хранилище, чтобы ее можно было использовать в следующей сессии в параметрах трансляции.

Возвраты

number

getPreferredTextLanguage

Метод getPreferredTextLanguage() возвращает строку.

Получает предпочтительный язык текстовой дорожки.

Возвраты

nullable string

getPreferredTextStyle

Метод getPreferredTextStyle() возвращает cast.framework.messages.TextTrackStyle

Получает предпочтительный стиль дорожки текста.

Возвраты

nullable cast.framework.messages.TextTrackStyle

getQueueManager

Метод getQueueManager() возвращает ( cast.framework.QueueManager или undefined)

Получает экземпляр QueueManager .

Возвраты

(non-null cast.framework.QueueManager or undefined)

getRawCurrentTimeSec

Функция getRawCurrentTimeSec() возвращает число.

Получает прошедшее время воспроизведения текущего медиафайла, не вычитая время рекламной паузы.

Возвраты

number прошедшее время в секундах. Если воспроизведение медиафайлов отсутствует, значение будет равно 0 .

getRawSeekableRange

Метод getRawSeekableRange() возвращает cast.framework.messages.Range

Возвращает текущий диапазон перемещения курсора по медиафайлу.

ПРИМЕЧАНИЕ: Это соответствует единицам измерения функции getRawCurrentTimeSec() , но не seek() ! Это не учитывает рекламу или любые другие смещения медиафайлов. Если вы не уверены, что вам нужны необработанные значения, следует использовать getLiveSeekableRange() .

Возвраты

nullable cast.framework.messages.Range

getStartAbsoluteTime

Функция getStartAbsoluteTime() возвращает число.

Получает абсолютное время начала воспроизведения медиафайла в формате UNIX Epoch (в секундах с начала эпохи Unix). Абсолютное время применимо только для прямых трансляций.

Возвраты

nullable number

getStats

Метод getStats() возвращает cast.framework.stats.Stats

Возвращает статистику воспроизведения. При необходимости статистика агрегируется по всей сессии воспроизведения.

Возвраты

non-null cast.framework.stats.Stats

getSupportedMediaCommands

Метод getSupportedMediaCommands() возвращает число.

Получает поддерживаемые ресивером медиакоманды. Вызывается только после вызова CastReceiverContext#start() , в противном случае возвращает 0 Значение поддерживаемых медиакоманд контролируется исключительно приложением ресивера. Оно не обновляется автоматически на основе MediaStatus .

См. также

cast.framework.messages.Command

Возвраты

number — битовая маска команд мультимедиа, поддерживаемых приложением.

getTextTracksManager

Метод getTextTracksManager() возвращает cast.framework.TextTracksManager

Получает экземпляр TextTracksManager .

Возвраты

non-null cast.framework.TextTracksManager

getTimedMetadata

Метод getTimedMetadata() возвращает массив ненулевых объектов, полученных путем приведения типа данных к типу framework.TimedMetadata.

Возвращает временные метаданные, обнаруженные во время анализа манифеста. Это #EXT-X-DATERANGE в HLS и EventStream в DASH.

Возвраты

non-null Array of non-null cast.framework.TimedMetadata

нагрузка

Функция `load(loadRequest)` возвращает `Promise`, содержащий `void`.

Инициирует запрос на загрузку медиафайлов.

Параметр
loadRequest	cast.framework.messages.LoadRequestData Запрос на загрузку медиафайла. Значение не должно быть нулевым.

Возвраты

non-null Promise containing void Promise, который разрешается при успешном выполнении операции или отклоняется при неудаче.

пауза

пауза()

Приостанавливает воспроизведение текущего медиафайла.

играть

играть()

Воспроизводит приостановленный в данный момент медиафайл.

removeEventListener

removeEventListener(eventType, eventListener)

Удаляет обработчик событий, добавленный для заданного события воспроизведения. Если соответствующего обработчика событий не существует, этот вызов игнорируется.

Параметр
eventType	(ненулевой cast.framework.events.EventType или ненулевой массив ненулевых cast.framework.events.EventType ) Тип события или массив типов событий
eventListener	function(non-null cast.framework.events.Event )

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Удалить команды из списка поддерживаемых команд управления мультимедиа.

Параметр
supportedMediaCommands	число Битовая маска команд мультимедиа, поддерживаемых приложением.
broadcastStatus	Необязательный логический true указывает на то, что отправители должны быть уведомлены об изменении (если значение не указано, отправители будут уведомлены).

См. также

cast.framework.messages.Command

искать

seek(seekTime)

Ищет информацию в современных СМИ.

Параметр
seekTime	число

sendCustomState

sendCustomState(state)

Этот метод передает пользовательское состояние из логики воспроизведения приложения в логику пользовательского интерфейса. Он помогает разделить логику воспроизведения и пользовательский интерфейс. Поддержание разделения между логикой и пользовательским интерфейсом позволяет использовать одну и ту же логику пользовательского интерфейса как для локального воспроизведения, так и для удаленного управления. Пользовательское состояние, передаваемое этим методом, доступно пользовательскому интерфейсу через PlayerData .

Параметр
состояние	Объект Пользовательский объект состояния. Значение не должно быть нулевым.

См. также

cast.framework.ui.PlayerData#customState

sendError

sendError(senderId, requestId, type, reason, customData)

Отправляет сообщение об ошибке конкретному отправителю.

Параметр
senderId	нить Идентификатор отправителя.
requestId	число Идентификатор входящего запроса, вызвавшего эту ошибку.
тип	cast.framework.messages.ErrorType Тип ошибки. Значение не должно быть нулевым.
причина	Необязательный cast.framework.messages.ErrorReason Причина ошибки. Значение может быть нулевым.
пользовательские данные	Необязательный Объект Сообщение об ошибке, относящееся к пользовательским данным, специфичным для приложения. Значение может быть нулевым.

sendLocalMediaRequest

sendLocalMediaRequest(request)

Отправляет запрос местным СМИ.

Параметр
запрос	cast.framework.messages.RequestData Значение не должно быть нулевым.

sendStatus

sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)

Отправляет сообщение о состоянии носителя конкретному отправителю.

Параметр
senderId	нить Идентификатор отправителя.
requestId	число Идентификатор входящего запроса, вызвавшего данный ответ.
includeMedia	Необязательный логический true указывает, что сообщение должно содержать экземпляр MediaInformation .
пользовательские данные	Необязательный Объект Пользовательские данные, специфичные для конкретного приложения, содержащиеся в сообщении о состоянии. Значение может быть нулевым.
includeQueueItems	Необязательный логический Включать ли элементы очереди в сообщение о состоянии. По умолчанию они не включаются.

setIdleReason

setIdleReason(idleReason)

Задает причину перехода плеера в состояние IDLE ). Это позволяет приложениям, которые хотят принудительно перевести плеер в состояние IDLE , указывать причину этого (например, пользовательскую ошибку). Причина ожидания отправляется в следующем сообщении о состоянии. Примечание: Большинству приложений не нужно устанавливать это значение. Оно необходимо только в том случае, если приложению нужно перевести Player в состояние IDLE в особых обстоятельствах, и значение idleReason по умолчанию не соответствует желаемому поведению.

Параметр
idleReason	cast.framework.messages.IdleReason Причина находиться в состоянии IDLE . Значение не должно быть нулевым.

setMediaElement

setMediaElement(mediaElement)

Задает используемый HTMLMediaElement . Если задан Promise объекта HTMLMediaElement , воспроизведение медиафайлов начнется после выполнения Promise .

Параметр
медиаэлемент	(ненулевой HTMLMediaElement или ненулевой Promise, содержащий ненулевой HTMLMediaElement) MediaElement , который будет использовать Player .

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

Задает информацию о медиафайлах.

Параметр
медиаИнформация	cast.framework.messages.MediaInformation Значение не должно быть нулевым.
opt_broadcast	Необязательный логический

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler (обработчик)

Задает обработчик для возврата или изменения cast.framework.PlaybackConfig для конкретного запроса на загрузку. Параметры обработчика — это LoadRequestData и PlaybackConfig по умолчанию для приемника (предоставляются в CastReceiverOptions ). Обработчик должен возвращать измененную конфигурацию воспроизведения или null , чтобы предотвратить воспроизведение медиафайлов. Возвращаемое значение также может быть Promise , позволяющим ожидать данных от сервера.

Параметр
обработчик	function(non-null cast.framework.messages.LoadRequestData , non-null cast.framework.PlaybackConfig ) Функция для предоставления конфигурации воспроизведения, специфичной для конкретного запроса. Значение может быть нулевым.

setMediaUrlResolver

setMediaUrlResolver(resolver)

Задает обработчик для возврата URL-адреса медиафайла для запроса LOAD . Этот обработчик можно использовать, чтобы избежать публикации URL-адреса медиаконтента в статусе медиафайла. По умолчанию в качестве URL-адреса контента используется идентификатор медиаконтента (media contentId ).

Параметр
резольвер	function(non-null cast.framework.messages.LoadRequestData ) Функция для определения URL-адреса медиаконтента. Значение может быть нулевым.

setMessageInterceptor

setMessageInterceptor(type, interceptor)

Устанавливает перехватчик входящих и исходящих сообщений. Перехватчик может обновлять данные запроса и должен возвращать либо обновленные данные, либо Promise с обновленными данными (если данные не могут быть возвращены немедленно), либо null , если запрос не должен обрабатываться. Примечание : если указан перехватчик сообщений LOAD , но не указан отдельный перехватчик PRELOAD , то для сообщений PRELOAD будет вызываться перехватчик LOAD .

Параметр
тип	cast.framework.messages.MessageType Значение не должно быть нулевым.
перехватчик	function(non-null cast.framework.messages.RequestData ) Значение может быть нулевым.

Броски

non-null Error Если тип сообщения недопустим или если перехватчик не является функцией.

setPlaybackConfig

setPlaybackConfig(playbackConfig)

Задает конфигурацию воспроизведения в PlayerManager .

Параметр
playbackConfig	cast.framework.PlaybackConfig Значение не должно быть нулевым.

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Задает параметры команд воспроизведения мультимедиа, поддерживаемых ресивером.

Параметр
supportedMediaCommands	число Битовая маска команд мультимедиа, поддерживаемых приложением.
broadcastStatus	Необязательный логический true указывает на то, что отправители должны быть уведомлены об изменении (если значение не указано, отправители будут уведомлены).

См. также

cast.framework.messages.Command

останавливаться

останавливаться()

Останавливает воспроизведение текущего медиафайла.