литой каркас . PlayerManager
Управляет и контролирует воспроизведение мультимедиа.
- Броски
 non-null Errorесли конструктор используется напрямую. Доступ кPlayerManagerследует осуществлять только путем вызова cast.framework.CastReceiverContext#getPlayerManager .
Методы
addEventListener
addEventListener(eventType, eventListener)
Добавляет прослушиватель событий, который прослушивает события воспроизведения.
Параметр | |
|---|---|
eventType  | (ненулевой cast.framework.events.EventType или ненулевой массив ненулевых cast.framework.events.EventType ) Тип события или массив типов событий  | 
EventListener  | функция (ненулевой cast.framework.events.Event )  | 
- Броски
 non-null Error. Если заданные аргументы недопустимы.
addSupportedMediaCommands
addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Добавляет новые поддерживаемые команды в существующий список поддерживаемых медиа-команд.
Параметр | |
|---|---|
поддерживаемыеMediaCommands  | число Битовая маска медиа-команд, поддерживаемых приложением.  | 
трансляцияСтатус  | Необязательный булев    | 
- Смотрите также
 - cast.framework.messages.Command
 
трансляцияСтатус
broadcastStatus(includeMedia, requestId, customData, includeQueueItems)
Отправляет сообщение о состоянии медиа-контента всем отправителям (широковещательная рассылка). Приложения используют это для отправки пользовательских изменений состояния.
Параметр | |
|---|---|
includeMedia  | Необязательный булев    | 
requestId  | Необязательный число Идентификатор входящего запроса, вызвавшего данный ответ.  | 
customData  | Необязательный Объект Пользовательские данные, специфичные для приложения, в сообщении о состоянии. Значение может быть нулевым.  | 
includeQueueItems  | Необязательный булев Включать ли элементы очереди в сообщение о статусе. По умолчанию они не включаются.  | 
получитьAbsoluteTimeForMediaTime
getAbsoluteTimeForMediaTime(mediaTime) возвращает число
Преобразует время медиафайлов в абсолютное время медиафайлов. Абсолютное время применимо только для прямых трансляций.
Параметр | |
|---|---|
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не воспроизводит клип-брейк.
получитьBreakManager
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Битовая маска медиа-команд, поддерживаемых приложением.
получитьCurrentTimeSec
getCurrentTimeSec() возвращает число
Возвращает прошедшее время воспроизведения текущего медиафайла.
- Возврат
 numberПрошедшее время в секундах. Значение будет равно0, если медиафайл не воспроизводится.
получитьПродолжительностьСек
getDurationSec() возвращает число
Получает длительность текущего воспроизводимого медиафайла в секундах.
- Возврат
 numberПродолжительность воспроизведения медиа.NaN, если медиа не воспроизводится.
getLiveSeekableRange
getLiveSeekableRange() возвращает cast.framework.messages.LiveSeekableRange
Возвращает диапазон поиска в реальном времени с начальным и конечным временем в секундах. Значения основаны на времени воспроизведения медиафайлов.
- Возврат
 
getMediaInformation
getMediaInformation() возвращает cast.framework.messages.MediaInformation
Получает медиа-информацию о текущих медиа.
- Возврат
 
getMediaTimeForAbsoluteTime
getMediaTimeForAbsoluteTime(absoluteTime) возвращает число
Преобразует абсолютное время медиафайла в время медиафайла. Абсолютное время применимо только для прямых трансляций.
Параметр | |
|---|---|
absoluteTime  | число Абсолютное время носителя, такое как время эпохи UNIX (секунды с начала эпохи Unix).  | 
- Возврат
 nullable numberМедиа-время илиnull, если недоступно.
getPlaybackConfig
getPlaybackConfig() возвращает cast.framework.PlaybackConfig
 Возвращает конфигурацию воспроизведения или null если значения по умолчанию не были переопределены.
- Возврат
 nullable cast.framework.PlaybackConfig
getPlaybackRate
getPlaybackRate() возвращает число
 Возвращает текущую скорость воспроизведения. Возвращает 1 перед вызовом CastReceiverContext#start приёмника.
- Возврат
 numberТекущая скорость воспроизведения.
получитьPlayerState
getPlayerState() возвращает cast.framework.messages.PlayerState
 Получает состояние Player .
- Возврат
 non-null cast.framework.messages.PlayerStateСостояние текущегоPlayer.
getPreferredPlaybackRate
getPreferredPlaybackRate() возвращает число
Получите предпочтительную скорость воспроизведения. Можно использовать при завершении работы, чтобы сохранить последнюю предпочтительную скорость воспроизведения в постоянном хранилище, чтобы использовать её в следующем сеансе в параметрах трансляции.
- Возврат
 number
получитьPreferredTextLanguage
getPreferredTextLanguage() возвращает строку
Получает предпочтительный язык текстовой дорожки.
- Возврат
 nullable string
получитьPreferredTextStyle
getPreferredTextStyle() возвращает cast.framework.messages.TextTrackStyle
Получает предпочтительный стиль текстовой дорожки.
- Возврат
 
получитьQueueManager
getQueueManager() возвращает ( cast.framework.QueueManager или неопределено)
 Получает экземпляр QueueManager .
- Возврат
 (non-null cast.framework.QueueManager or undefined)
получитьRawCurrentTimeSec
getRawCurrentTimeSec() возвращает число
Получает прошедшее время воспроизведения текущего медиафайла без вычета времени рекламной паузы.
- Возврат
 numberПрошедшее время в секундах. Значение будет равно0, если медиафайл не воспроизводится.
getRawSeekableRange
getRawSeekableRange() возвращает cast.framework.messages.Range
Возвращает текущий диапазон поиска медиафайлов.
 ПРИМЕЧАНИЕ: Это соответствует единицам измерения getRawCurrentTimeSec() , но не seek() ! Это не учитывает рекламу и другие смещения медиа-данных. Если вы не уверены, что вам нужны необработанные значения, используйте getLiveSeekableRange() .
- Возврат
 nullable cast.framework.messages.Range
getStartAbsoluteTime
getStartAbsoluteTime() возвращает число
Получает абсолютное время начала медиафайла в формате UNIX Epoch Time (в секундах с начала эпохи UNIX). Абсолютное время применимо только для прямых трансляций.
- Возврат
 nullable number
получитьСтатистика
getStats() возвращает cast.framework.stats.Stats
Возвращает статистику воспроизведения. Статистика суммируется за весь сеанс воспроизведения, где это применимо.
- Возврат
 non-null cast.framework.stats.Stats
getSupportedMediaCommands
getSupportedMediaCommands() возвращает число
 Получает поддерживаемые приёмником медиа-команды. Вызывается только после вызова CastReceiverContext#start() , в противном случае возвращает 0 Поддерживаемые медиа-команды контролируются исключительно приложением-приёмником. Они не обновляются автоматически на основе MediaStatus .
- Смотрите также
 - cast.framework.messages.Command
 - Возврат
 numberБитовая маска медиа-команд, поддерживаемых приложением.
получитьTextTracksManager
getTextTracksManager() возвращает cast.framework.TextTracksManager
 Получает экземпляр TextTracksManager .
- Возврат
 non-null cast.framework.TextTracksManager
getTimedMetadata
getTimedMetadata() возвращает массив ненулевых cast.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обещание, которое разрешается при успешном завершении операции или отклоняется в случае неудачи.
пауза
пауза()
Приостанавливает воспроизведение текущего медиафайла.
играть
играть()
Воспроизводит приостановленный в данный момент медиафайл.
removeEventListener
removeEventListener(eventType, eventListener)
Удаляет прослушиватель событий, добавленный для заданного события воспроизведения. Если подходящего прослушивателя событий не существует, этот вызов игнорируется.
Параметр | |
|---|---|
eventType  | (ненулевой cast.framework.events.EventType или ненулевой массив ненулевых cast.framework.events.EventType ) EventType или массив типов событий  | 
EventListener  | функция (ненулевой cast.framework.events.Event )  | 
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Удалить команды из списка поддерживаемых медиа-команд.
Параметр | |
|---|---|
поддерживаемыеMediaCommands  | число Битовая маска медиа-команд, поддерживаемых приложением.  | 
трансляцияСтатус  | Необязательный булев    | 
- Смотрите также
 - cast.framework.messages.Command
 
искать
seek(время_искать)
Ищет в современных СМИ.
Параметр | |
|---|---|
seekTime  | число  | 
sendCustomState
sendCustomState(состояние)
 Передаёт пользовательское состояние из логики воспроизведения приложения в логику пользовательского интерфейса. Этот метод помогает разделить логику воспроизведения и пользовательский интерфейс. Разделение логики и пользовательского интерфейса позволяет использовать одну и ту же логику пользовательского интерфейса как для локального воспроизведения, так и для удалённого управления. Пользовательское состояние, отправляемое этим методом, доступно пользовательскому интерфейсу через PlayerData . 
Параметр | |
|---|---|
состояние  | Объект Пользовательский объект состояния. Значение не должно быть нулевым.  | 
- Смотрите также
 - cast.framework.ui.PlayerData#customState
 
sendError
sendError(senderId, requestId, тип, причина, customData)
Отправляет сообщение об ошибке определенному отправителю.
Параметр | |
|---|---|
идентификатор отправителя  | нить Идентификатор отправителя.  | 
requestId  | число Идентификатор входящего запроса, вызвавшего эту ошибку.  | 
тип  | cast.framework.messages.ErrorType Тип ошибки. Значение не должно быть нулевым.  | 
причина  | Необязательный cast.framework.messages.ErrorReason Причина ошибки. Значение может быть нулевым.  | 
customData  | Необязательный Объект Сообщение об ошибке пользовательских данных, специфичных для приложения. Значение может быть нулевым.  | 
sendLocalMediaRequest
sendLocalMediaRequest(запрос)
Отправляет запрос местным СМИ.
Параметр | |
|---|---|
запрос  | cast.framework.messages.RequestData Значение не должно быть нулевым.  | 
sendStatus
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
Отправляет сообщение о статусе мультимедиа определенному отправителю.
Параметр | |
|---|---|
идентификатор отправителя  | нить Идентификатор отправителя.  | 
requestId  | число Идентификатор входящего запроса, вызвавшего данный ответ.  | 
includeMedia  | Необязательный булев    | 
customData  | Необязательный Объект Пользовательские данные, специфичные для приложения, в сообщении о состоянии. Значение может быть нулевым.  | 
includeQueueItems  | Необязательный булев Включать ли элементы очереди в сообщение о статусе. По умолчанию они не включаются.  | 
setIdleReason
setIdleReason(idleReason)
 Задаёт причину перехода проигрывателя в состояние IDLE . Это позволяет приложениям, которые хотят принудительно перевести проигрыватель в состояние IDLE , указывать причину (например, пользовательскую ошибку). Причина перехода в состояние IDLE отправляется в следующем сообщении о состоянии. Примечание. Большинству приложений не требуется задавать это значение. Оно необходимо только в том случае, если приложению необходимо перевести Player в состояние IDLE в особых обстоятельствах, а значение idleReason по умолчанию не отражает предполагаемое поведение. 
Параметр | |
|---|---|
Причина простоя  | cast.framework.messages.IdleReason  Причина нахождения в состоянии  Значение не должно быть нулевым.  | 
setMediaElement
setMediaElement(mediaElement)
 Задаёт используемый HTMLMediaElement . Если установлено Promise для элемента HTMLMediaElement , воспроизведение медиафайла начинается после выполнения Promise . 
Параметр | |
|---|---|
mediaElement  | (ненулевой HTMLMediaElement или ненулевой Promise, содержащий ненулевой HTMLMediaElement)    | 
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
Устанавливает информацию о медиа.
Параметр | |
|---|---|
медиаИнформация  | cast.framework.messages.MediaInformation Значение не должно быть нулевым.  | 
opt_broadcast  | Необязательный булев  | 
setMediaPlaybackInfoHandler
setMediaPlaybackInfoHandler (обработчик)
 Устанавливает обработчик для возврата или изменения cast.framework.PlaybackConfig для конкретного запроса на загрузку. Параметры обработчика — LoadRequestData и PlaybackConfig по умолчанию для приёмника (указаны в CastReceiverOptions ). Обработчик должен вернуть изменённую конфигурацию воспроизведения или null , чтобы предотвратить воспроизведение медиафайла. Возвращаемое значение также может быть Promise , позволяющим ожидать данные от сервера. 
Параметр | |
|---|---|
обработчик  | функция (ненулевой cast.framework.messages.LoadRequestData , ненулевой cast.framework.PlaybackConfig ) Функция для предоставления специфичной для запроса конфигурации воспроизведения. Значение может быть нулевым.  | 
setMediaUrlResolver
setMediaUrlResolver(резольвер)
 Устанавливает обработчик для возврата URL-адреса медиа-контента для запроса LOAD . Этот обработчик можно использовать, чтобы избежать публикации URL-адреса медиа-контента в составе статуса медиа-контента. По умолчанию в качестве URL-адреса медиа-контента используется contentId медиа-контента. 
Параметр | |
|---|---|
резольвер  | функция (ненулевой cast.framework.messages.LoadRequestData ) Функция для разрешения URL-адреса медиа-контента. Значение может быть нулевым.  | 
setMessageInterceptor
setMessageInterceptor(тип, перехватчик)
 Устанавливает перехватчик входящих и исходящих сообщений. Перехватчик может обновлять данные запроса и должен возвращать либо обновлённые данные, либо Promise с обновлёнными данными (если данные не могут быть возвращены немедленно), либо null , если запрос не требуется обрабатывать. Примечание : если предусмотрен перехватчик сообщений LOAD , но не предусмотрен отдельный перехватчик PRELOAD , для сообщений PRELOAD будет вызван перехватчик LOAD . 
Параметр | |
|---|---|
тип  | cast.framework.messages.MessageType Значение не должно быть нулевым.  | 
перехватчик  | функция (ненулевой cast.framework.messages.RequestData ) Значение может быть нулевым.  | 
setPlaybackConfig
setPlaybackConfig(playbackConfig)
 Устанавливает конфигурацию воспроизведения в PlayerManager . 
Параметр | |
|---|---|
playbackConfig  | Значение не должно быть нулевым.  | 
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Устанавливает медиа-команды, поддерживаемые приемником.
Параметр | |
|---|---|
поддерживаемыеMediaCommands  | число Битовая маска медиа-команд, поддерживаемых приложением.  | 
трансляцияСтатус  | Необязательный булев    | 
- Смотрите также
 - cast.framework.messages.Command
 
останавливаться
останавливаться()
Останавливает текущее воспроизведение медиафайла.