Класс CastReceiverContext

cast.framework.CastReceiverContext

class   static

Управляет загрузкой базовых библиотек и инициализирует базовый SDK Cast Receiver.

Исключения

non-null Error Если MediaElement не создан в теле документа. Если создано несколько элементов мультимедиа, разработчик должен назначить класс castMediaElement одному из них, который будет использоваться приемником CAF.

Методы

getInstance

static

getInstance() возвращает cast.framework.CastReceiverContext

Возвращает экземпляр синглтона CastReceiverContext.

Возвраты

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Настраивает прослушиватель сообщений для собственного канала сообщений. Для пространства имен можно указать несколько прослушивателей.

Параметр
пространство имен	string Пространство имен. Обратите внимание, что перед действительным пространством имен должен быть указан префикс urn:x-cast:.
прослушиватель	function(non-null cast.framework.system.Message)

Исключения

Error Если система не готова или пространство имен не поддерживается этим приложением.

addEventListener

addEventListener(type, handler)

Добавьте прослушиватель для системных событий Cast.

Параметр
тип	cast.framework.system.EventType Значение не может быть нулевым.
обработчик	function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) возвращает логическое значение

Проверяет, поддерживаются ли платформой заданные параметры медиафайлов для видео- или аудиопотоков.

Параметр
mimeType	string MIME-тип медиафайла. Состоит из типа и подтипа, разделенных косой чертой. Это могут быть MIME-типы видео или аудио.
кодеки	Необязательно string Строка в кавычках содержит список форматов, разделенных запятыми. Каждый формат указывает тип медиаобъекта, присутствующего в потоке.
ширина	Необязательно число Горизонтальное разрешение потока в пикселях.
высота	Необязательно число Вертикальное разрешение потока в пикселях.
framerate;	Необязательно число Частота кадров в трансляции.

Возвраты

boolean Можно ли воспроизвести трансляцию на Chromecast.

getApplicationData

getApplicationData() возвращает cast.framework.system.ApplicationData

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

Возвраты

nullable cast.framework.system.ApplicationData Информация о приложении или null, если система не готова.

getDeviceCapabilities

getDeviceCapabilities() возвращает cast.framework.system.DeviceCapabilitiesObj

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

Возвраты

nullable cast.framework.system.DeviceCapabilitiesObj Информация о возможностях устройства (пары "ключ-значение"). Если система ещё не готова, значение будет нулевым. Если платформа не предоставляет информацию о возможностях устройства, объект может быть пустым.

getDeviceInformation

getDeviceInformation() возвращает cast.framework.system.DeviceInformationObj

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

Возвраты

nullable cast.framework.system.DeviceInformationObj Информация об устройстве (пары "ключ-значение"). Если система ещё не готова, значение будет нулевым. Если платформа не предоставляет эту информацию, объект может быть пустым.

getPlayerManager

getPlayerManager() возвращает cast.framework.PlayerManager

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

Возвраты

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) возвращает cast.framework.system.Sender

Получить отправителя по идентификатору

Параметр
senderId	string Идентификатор отправителя, которого нужно вернуть.

Возвраты

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

Получает список подключенных отправителей.

Возвраты

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() возвращает cast.framework.system.StandbyState

Сообщает, находится ли вход HDMI приложения Cast в режиме ожидания.

Возвраты

non-null cast.framework.system.StandbyState Находится ли вход HDMI приложения в режиме ожидания. Если определить это невозможно, например телевизор не поддерживает команды CEC, возвращается значение UNKNOWN.

getSystemState

getSystemState() возвращает cast.framework.system.SystemState

Предоставляет приложению информацию о состоянии системы.

Возвраты

non-null cast.framework.system.SystemState Состояние системы.

getVisibilityState

getVisibilityState() возвращает cast.framework.system.VisibilityState

Сообщает, является ли приложение для трансляции активным входом HDMI.

Возвраты

non-null cast.framework.system.VisibilityState Является ли приложение активным входом HDMI. Если определить это невозможно, например телевизор не поддерживает команды CEC, возвращается значение UNKNOWN.

isSystemReady

isSystemReady() возвращает логическое значение

Когда приложение вызывает start, система отправляет событие ready, чтобы указать, что информация о приложении готова и приложение может отправлять сообщения, как только подключится один отправитель.

Возвраты

boolean Готова ли система к обработке сообщений.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Начало загрузки JS-кода проигрывателя. Это можно использовать, чтобы начать загрузку JS-кода проигрывателя на раннем этапе запуска приемника, до вызова start. Если проигрыватели уже загружены (вызвана функция start), то эта функция не выполняет никаких действий.

Параметр
useLegacyDashSupport	Необязательно Логическое значение Укажите, что для контента DASH нужно использовать MPL.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Удаляет прослушиватель сообщений, ранее зарегистрированный с помощью CastReceiverContext#addCustomMessageListener.

Параметр
пространство имен	string Пространство имен. Обратите внимание, что перед действительным пространством имен должен быть указан префикс urn:x-cast:.
прослушиватель	function(non-null cast.framework.system.Message) Функция прослушивателя сообщений, регистрацию которой нужно отменить.

Исключения

Error Если система не готова или пространство имен не поддерживается этим приложением.

removeEventListener

removeEventListener(type, handler)

Удалить прослушиватель системных событий Cast.

Параметр
тип	cast.framework.system.EventType Значение не может быть нулевым.
обработчик	function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

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

Параметр
пространство имен	string Пространство имен. Обратите внимание, что перед действительным пространством имен должна быть указана строка "urn:x-cast:".
senderId	(строка или неопределенное значение) Идентификатор senderId или undefined для трансляции всем отправителям.
делал.	любые Полезная нагрузка сообщения. Значение не может быть нулевым.

Исключения

Error Если при подготовке сообщения произошла ошибка.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

Параметр
feedbackMessage	string

Поддержка прекращена

Используйте cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Задает статус приложения. Приложение должно вызывать этот метод при изменении своего состояния. Если значение не задано или указана пустая строка, по умолчанию используется название приложения, указанное при его регистрации.

Параметр
statusText	string Текст статуса.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Настройте обработчик, чтобы добавить дополнительные данные в отчет об отзыве. Обработчик будет вызываться при создании отзыва и должен возвращать дополнительные данные в виде строки или обещания строки. Чтобы данные были включены в отчет, возвращаемый промис должен быть разрешен в течение пяти секунд.

Параметр
feedbackHandler	function() Значение может быть нулевым.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Задает время ожидания при бездействии приемника. Рекомендуется задать максимальное значение бездействия при вызове Start и не менять его. Этот API предназначен только для разработки и отладки.

Параметр
maxInactivity	число Интервал в секундах, по истечении которого закрывается неотвечающее подключение.

setLoggerLevel

setLoggerLevel(level)

Задает уровень детализации журнала.

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

start

start(options) возвращает cast.framework.CastReceiverContext

Инициализирует системный менеджер и медиа-менеджер, чтобы приложение-получатель могло получать запросы от отправителей.

Параметр
Параметры	(ненулевой cast.framework.CastReceiverOptions или необязательный ненулевой объект)

Возвраты

non-null cast.framework.CastReceiverContext 

пересадка

stop(closeReason)

Выключить приложение-получатель.

Параметр

closeReason

Необязательно cast.framework.common.CloseReason Необязательная причина закрытия, указывающая, почему приложение-получатель остановлено. Если причина не указана, фреймворк определит ее на основе недавних событий медиапроигрывателя или вернет значение APP_REQUEST. Передает одно из следующих числовых значений: 13 (APP_CUSTOM_STOP) – для действий в интерфейсе или бизнес-действий пользовательского приемника (например, пользователь нажимает кнопку "Выход" или "Закрыть" в приложении, пользовательский приемник переходит к другому действию). 15 (APP_ERROR) – критические ошибки на уровне приложения, например сбои аутентификации, получения лицензии или DRM, а также сбои API серверной части, которые происходят за пределами событий ошибок встроенного проигрывателя CAF. 14 (APP_PLAYBACK_FINISHED): приложение завершило воспроизведение плейлиста/очереди или отдельного медиаконтента. 6 (APP_REQUEST): общий/устаревший резервный вариант, когда приложение запрашивает завершение без указания более конкретной причины. Значение не может быть нулевым.