Пространство имен: приведение

хром. В ролях

статическое пространство имен

Это пространство имен chrome.cast.

Классы

АпиКонфиг

Содержит конфигурацию для API при инициализации.

Учетные данныеДанные

Данные учетных данных, используемые для идентификации учетных данных отправителя.

DialRequest

Запрос на запуск приложения DIAL.

Ошибка

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

Изображение

Изображение, описывающее приложение-приемник или элемент мультимедиа. Это может быть значок приложения, обложка или миниатюра.

Получатель

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

ReceiverDisplayStatus

Статус приемника отображается пользователю в пользовательском интерфейсе расширения. Действительно только для CUSTOM приемников.

ОтправительПриложение

Описывает приложение-отправитель. Обычно эти объекты не должны создаваться клиентом.

Сессия

Описывает состояние работающего в данный момент приложения Cast. Обычно эти объекты не должны создаваться клиентом.

SessionRequest

Запрос на запуск или подключение к сеансу.

Тайм-аут

Определяет значения времени ожидания по умолчанию в миллисекундах для методов API.

Объем

Громкость устройства или медиапотока.

Пространство имен

СМИ

Перечисления

AutoJoinPolicy

статический

нить

Политика автоматического присоединения определяет, когда SDK будет автоматически подключать приложение-отправитель к существующему сеансу после инициализации API.

Ценность
TAB_AND_ORIGIN_SCOPED	нить Автоматически подключается, когда сеанс был запущен с тем же appId, на той же вкладке и исходной странице.
ORIGIN_SCOPED	нить Автоматически подключается, когда сеанс был запущен с тем же appId и тем же источником страницы (независимо от вкладки).
PAGE_SCOPED	нить Нет автоматического подключения.

Возможности

статический

нить

Возможности, поддерживаемые принимающим устройством.

Ценность
ВИДЕО ВЫХОД	нить Ресивер поддерживает вывод видео.
АУДИО ВЫХОД	нить Ресивер поддерживает аудиовыход.
ВИДЕО_IN	нить Ресивер поддерживает видеовход (камера).
АУДИО_IN	нить Ресивер поддерживает аудиовход (микрофон).
MULTIZONE_GROUP	нить Приемник представляет собой многозонную группу.

Политика действия по умолчанию

статический

нить

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

Ценность
CREATE_SESSION	нить Если вкладка, содержащая приложение, преобразуется при инициализации API, пакет SDK останавливает преобразование вкладок и автоматически запускает приложение. Всплывающее окно расширения предлагает пользователю транслировать приложение.
CAST_THIS_TAB	нить После инициализации API автоматический запуск не выполняется, даже если вкладка транслируется. Всплывающее окно расширения предлагает пользователю открыть вкладку.

DialAppState

статический

нить

Возможные состояния приложения DIAL.

Ценность
БЕГ	нить
ОСТАНОВЛЕНО	нить
ОШИБКА	нить Не является частью спецификации, используется для сигнализации об ошибках.

Код ошибки

статический

нить

Ошибки, которые может возвращать SDK.

Ценность
ОТМЕНИТЬ	нить Операция отменена пользователем.
ТАЙМ-АУТ	нить Время операции вышло.
API_NOT_INITIALIZED	нить API не инициализирован.
НЕВЕРНЫЙ ПАРАМЕТР	нить Недопустимые параметры операции.
РАСШИРЕНИЕ_НЕ_СОВМЕСТИМО	нить Сценарий API несовместим с установленным расширением Cast.
EXTENSION_MISSING	нить Расширение Cast недоступно.
ПОЛУЧАТЕЛЬ_НЕДОСТУПЕН	нить Ни один получатель не был совместим с запросом сеанса.
SESSION_ERROR	нить Сеанс не может быть создан, или сеанс недействителен.
КАНАЛ_ОШИБКА	нить Канал к ресиверу недоступен.
LOAD_MEDIA_FAILED	нить Не удалось загрузить носитель.

ReceiverAction

статический

нить

Действия, которые пользователь может выполнять с получателем в расширении. Их можно использовать для отображения перехода в пользовательском интерфейсе приложения-отправителя до того, как действие приведения полностью завершится (или завершится сбоем).

Ценность
В РОЛЯХ	нить Пользователь выбрал получателя с намерением приведения к нему с помощью приложения-отправителя. Точная личность получателя может быть неизвестна.
ОСТАНОВКА	нить Пользователь запросил остановку сеанса на приемнике.

ПриемникДоступность

статический

нить

Описывает доступность приемника Cast.

Ценность
ДОСТУПНЫЙ	нить Доступен как минимум один получатель, совместимый с запросом сеанса.
НЕДОСТУПЕН	нить Ресиверов нет.

Тип приемника

статический

нить

Ценность
В РОЛЯХ	нить Приемник трансляции, например Chromecast
НАБИРАТЬ НОМЕР	нить DIAL-устройство, например, Smart TV
ТУСОВАТЬСЯ	нить Тусоваться
ОБЫЧАЙ	нить Пользовательский приемник предоставляется клиентом

Платформа Отправителя

статический

нить

Описывает платформу приложения отправителя.

Ценность
ХРОМ	нить
IOS	нить
АНДРОИД	нить

Статус сеанса

статический

нить

Описывает состояние сеанса Cast для приложения-получателя.

Ценность
СВЯЗАНО	нить Сеанс подключается к приложению-получателю.
ОТКЛЮЧЕН	нить Сеанс отключается от приложения-получателя. Приложение получателя может быть запущено или не запущено.
ОСТАНОВЛЕНО	нить Приложение-приемник было остановлено.

VolumeControlType

статический

нить

Описывает типы регулировки громкости.

Ценность
ЗАТУХАНИЕ	нить Громкость транслируемого устройства можно изменить.
ИСПРАВЛЕНО	нить Громкость устройства трансляции фиксирована и не может быть изменена.
МАСТЕР	нить Регулятор громкости основной системы, т. е. громкость телевизора или аудиоустройства изменяется.

Характеристики

AutoJoinPolicy

статический

нить

Политика автоматического присоединения определяет, когда SDK будет автоматически подключать приложение-отправитель к существующему сеансу после инициализации API.

Ценность
TAB_AND_ORIGIN_SCOPED	нить Автоматически подключается, когда сеанс был запущен с тем же appId, на той же вкладке и исходной странице.
ORIGIN_SCOPED	нить Автоматически подключается, когда сеанс был запущен с тем же appId и тем же источником страницы (независимо от вкладки).
PAGE_SCOPED	нить Нет автоматического подключения.

Возможности

статический

нить

Возможности, поддерживаемые принимающим устройством.

Ценность
ВИДЕО ВЫХОД	нить Ресивер поддерживает вывод видео.
АУДИО ВЫХОД	нить Ресивер поддерживает аудиовыход.
ВИДЕО_IN	нить Ресивер поддерживает видеовход (камера).
АУДИО_IN	нить Ресивер поддерживает аудиовход (микрофон).
MULTIZONE_GROUP	нить Приемник представляет собой многозонную группу.

Политика действия по умолчанию

статический

нить

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

Ценность
CREATE_SESSION	нить Если вкладка, содержащая приложение, преобразуется при инициализации API, пакет SDK останавливает преобразование вкладок и автоматически запускает приложение. Всплывающее окно расширения предлагает пользователю транслировать приложение.
CAST_THIS_TAB	нить После инициализации API автоматический запуск не выполняется, даже если вкладка транслируется. Всплывающее окно расширения предлагает пользователю открыть вкладку.

DialAppState

статический

нить

Возможные состояния приложения DIAL.

Ценность
БЕГ	нить
ОСТАНОВЛЕНО	нить
ОШИБКА	нить Не является частью спецификации, используется для сигнализации об ошибках.

Код ошибки

статический

нить

Ошибки, которые может возвращать SDK.

Ценность
ОТМЕНИТЬ	нить Операция отменена пользователем.
ТАЙМ-АУТ	нить Время операции вышло.
API_NOT_INITIALIZED	нить API не инициализирован.
НЕВЕРНЫЙ ПАРАМЕТР	нить Недопустимые параметры операции.
РАСШИРЕНИЕ_НЕ_СОВМЕСТИМО	нить Сценарий API несовместим с установленным расширением Cast.
EXTENSION_MISSING	нить Расширение Cast недоступно.
ПОЛУЧАТЕЛЬ_НЕДОСТУПЕН	нить Ни один получатель не был совместим с запросом сеанса.
SESSION_ERROR	нить Сеанс не может быть создан, или сеанс недействителен.
КАНАЛ_ОШИБКА	нить Канал к ресиверу недоступен.
LOAD_MEDIA_FAILED	нить Не удалось загрузить носитель.

доступен

статический

логический

Отметьте, чтобы клиенты проверяли, загружен ли API.

ReceiverAction

статический

нить

Действия, которые пользователь может выполнять с получателем в расширении. Их можно использовать для отображения перехода в пользовательском интерфейсе приложения-отправителя до того, как действие приведения полностью завершится (или завершится сбоем).

Ценность
В РОЛЯХ	нить Пользователь выбрал получателя с намерением приведения к нему с помощью приложения-отправителя. Точная личность получателя может быть неизвестна.
ОСТАНОВКА	нить Пользователь запросил остановку сеанса на приемнике.

ПриемникДоступность

статический

нить

Описывает доступность приемника Cast.

Ценность
ДОСТУПНЫЙ	нить Доступен как минимум один получатель, совместимый с запросом сеанса.
НЕДОСТУПЕН	нить Ресиверов нет.

Тип приемника

статический

нить

Ценность
В РОЛЯХ	нить Приемник трансляции, например Chromecast
НАБИРАТЬ НОМЕР	нить DIAL-устройство, например, Smart TV
ТУСОВАТЬСЯ	нить Тусоваться
ОБЫЧАЙ	нить Пользовательский приемник предоставляется клиентом

Платформа Отправителя

статический

нить

Описывает платформу приложения отправителя.

Ценность
ХРОМ	нить
IOS	нить
АНДРОИД	нить

Статус сеанса

статический

нить

Описывает состояние сеанса Cast для приложения-получателя.

Ценность
СВЯЗАНО	нить Сеанс подключается к приложению-получателю.
ОТКЛЮЧЕН	нить Сеанс отключается от приложения-получателя. Приложение получателя может быть запущено или не запущено.
ОСТАНОВЛЕНО	нить Приложение-приемник было остановлено.

тайм-аут

статический

ненулевой chrome.cast.Timeout

Значения времени ожидания по умолчанию в миллисекундах для методов API.

ВЕРСИЯ

постоянный статический

ненулевой массив чисел

Версия API. Первое число — это основная версия, а второе — дополнительная версия.

VolumeControlType

статический

нить

Описывает типы регулировки громкости.

Ценность
ЗАТУХАНИЕ	нить Громкость транслируемого устройства можно изменить.
ИСПРАВЛЕНО	нить Громкость устройства трансляции фиксирована и не может быть изменена.
МАСТЕР	нить Регулятор громкости основной системы, т. е. громкость телевизора или аудиоустройства изменяется.

Методы

addReceiverActionListener

статический

addReceiverActionListener (слушатель)

Добавляет функцию прослушивания, которая будет вызываться, когда пользователь действовал через пользовательский интерфейс, чтобы начать или остановить кастинг. Приложение-отправитель может использовать это, чтобы показать переход в своем пользовательском интерфейсе (т. е. приостановить локальное воспроизведение мультимедиа) до того, как действие приведения завершится или завершится ошибкой.

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

При использовании Framework API используйте вместо этого cast.framework.CastContext#addEventListener и прослушивайте события cast.framework.CastContextEventType#CAST_STATE_CHANGED.

Параметр
слушатель	chrome.cast.ReceiverActionListener Добавляемая функция слушателя. Первым аргументом слушателя является получатель, на который воздействовали. Второй аргумент прослушивателя — запрошенное действие (см. chrome.cast.ReceiverAction). Значение не должно быть нулевым.

инициализировать

статический

инициализировать (apiConfig, successCallback, errorCallback)

Инициализирует API. Обратите внимание, что как successCallback, так и errorCallback будут вызываться после завершения инициализации API. SessionListener и ReceiverListener могут быть вызваны в любое время после этого и, возможно, более одного раза.

При использовании API Framework используйте вместо этой функции cast.framework.CastContext#setOptions .

Параметр
апиконфиг	chrome.cast.ApiConfig Объект с параметрами для инициализации API. Значение не должно быть нулевым.
успехОбратный вызов	функция()
errorCallback	функция (ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, INVALID_PARAMETER, EXTENSION_MISSING.

logMessage

статический

logMessage(сообщение)

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

Параметр
сообщение	нить Сообщение для регистрации.

Устаревший

Не поддерживается с Cast SDK на основе Presentation API.

предварительное кэширование

статический

предварительный кэш (данные)

Отправить запрос на предварительное кэширование данных. Если сеанс подключен, он отправит прямой запрос, в противном случае он будет отправлен на все устройства в сети.

Параметр
данные	нить Данные для предварительного кэширования.

удалитьReceiverActionListener

статический

removeReceiverActionListener (слушатель)

Удаляет функцию прослушивателя, которая ранее была добавлена ​​с помощью addReceiverActionListener.

Параметр
слушатель	chrome.cast.ReceiverActionListener Функция слушателя, которую нужно удалить. Значение не должно быть нулевым.

requestSession

статический

requestSession(successCallback, errorCallback, sessionRequest)

Запрашивает создание сеанса приложения-получателя или присоединение к нему. По умолчанию используется SessionRequest, переданный API во время инициализации; это можно переопределить, передав другой запрос сеанса в sessionRequest.

При использовании API Framework используйте вместо этой функции cast.framework.CastContext#requestSession .

Параметр
успехОбратный вызов	функция (ненулевая chrome.cast.Session )
errorCallback	функция (ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED, CANCEL, CHANNEL_ERROR, SESSION_ERROR, RECEIVER_UNAVAILABLE и EXTENSION_MISSING. Обратите внимание, что таймер тайм-аута запускается после того, как пользователи выбирают получателя. Выбор получателя требует действия пользователя, которое не имеет тайм-аута. Если запрос сеанса уже выполняется, вызывается errorCallback с кодом ошибки INVALID_PARAMETER и описанием, объясняющим ошибку.
сеансзапрос	По желанию chrome.cast.SessionRequest Значение не должно быть нулевым.

requestSessionById

статический

requestSessionById (идентификатор сеанса)

Запросы на присоединение к существующему сеансу с заданным идентификатором. После присоединения сеанс будет передан в sessionListener, заданный chrome.cast.initialize.

Если сеанс с данным sessionId уже известен при вызове этой функции, то sessionListener вызывается немедленно. В противном случае, как только будет обнаружен сеанс с заданным идентификатором sessionId, будет вызван sessionListener.

Параметр
идентификатор сессии	нить Идентификатор сеанса, к которому необходимо присоединиться.

setCustomReceivers

статический

setCustomReceivers (получатели, SuccessCallback, errorCallback)

Устанавливает пользовательский список получателей

Параметр
приемники	Массив ненулевого chrome.cast.Receiver Новый список. Значение не должно быть нулевым.
успехОбратный вызов	функция()
errorCallback	функция (ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR и EXTENSION_MISSRING.

Устаревший

Не поддерживается с Cast SDK на основе Presentation API.

setPageContext

статический

setPageContext (выигрыш)

Инициализирует функцию Cast для страницы, загружающей Cast SDK в iframe. Должен вызываться после инициализации SDK.

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

setReceiverDisplayStatus

статический

setReceiverDisplayStatus (получатель, SuccessCallback, errorCallback)

Устанавливает имя приемника и состояние дисплея. Чтобы приемник отображался как бездействующий, установите для displayStatus значение null.

Действительно только для CUSTOM приемников. DisplayStatus приемника игнорируется, если этот приемник является CAST; Статус приемника трансляции обновляется приложением приемника.

Параметр
получатель	chrome.cast.Receiver Получатель. Значение не должно быть нулевым.
успехОбратный вызов	функция() Обратный вызов при успешной установке статуса.
errorCallback	функция (ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, INVALID_PARAMETER, API_NOT_INITIALIZED и EXTENSION_MISSING.

Устаревший

Не поддерживается с Cast SDK на основе Presentation API.

не убежать

статический

unescape (экранированный) возвращает строку

Служебный метод для отмены экранирования строк с экранированием URI. Например, понятное имя получателя возвращается в виде строки с экранированием URI. Используйте этот метод, чтобы отменить экранирование этой строки, если это необходимо.

Параметр
сбежал	нить Строка для удаления

Возвращает

string Неэкранированная строка

Абстрактный тип

ReceiverActionListener

статический

Слушатель Действия Приемника()