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

хром. бросать

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

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

Классы

Апиконфиг

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

Данные учетных данных

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

Запрос набора номера

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

Ошибка

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

Изображение

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

Получатель

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

ПолучательDisplayStatus

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

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

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

Сессия

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

Сеансрекуест

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

Тайм-аут

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

Объем

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

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

СМИ

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

AutoJoinPolicy

статический

нить

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

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

Возможность

статический

нить

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

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

ДефолтАкшнПолиси

статический

нить

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

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

DialAppState

статический

нить

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

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

Код ошибки

статический

нить

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

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

ПолучательДействие

статический

нить

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

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

Доступность получателя

статический

нить

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

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

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

статический

нить

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

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

статический

нить

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

Ценить
ХРОМ	нить
iOS	нить
АНДРОИД	нить

Статус сессии

статический

нить

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

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

Типконтроля тома

статический

нить

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

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

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

AutoJoinPolicy

статический

нить

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

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

Возможность

статический

нить

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

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

ДефолтАкшнПолиси

статический

нить

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

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

DialAppState

статический

нить

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

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

Код ошибки

статический

нить

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

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

доступен

статический

логическое значение

Флаг, позволяющий клиентам проверять, загружен ли API.

ПолучательДействие

статический

нить

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

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

Доступность получателя

статический

нить

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

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

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

статический

нить

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

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

статический

нить

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

Ценить
ХРОМ	нить
iOS	нить
АНДРОИД	нить

Статус сессии

статический

нить

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

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

тайм-аут

статический

ненулевое значение chrome.cast.Timeout

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

ВЕРСИЯ

постоянная статика

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

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

Типконтроля тома

статический

нить

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

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

Методы

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. Обратите внимание, что успехCallback и errorCallback будут вызваны после завершения инициализации API. SessionListener и ReceiveListener могут быть вызваны в любое время впоследствии и, возможно, более одного раза.

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

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

logMessage

статический

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

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

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

Устарело

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

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

статический

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

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

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

Устарело

Не поддерживается.

удалитьReceiverActionListener

статический

RemoveReceiverActionListener (прослушиватель)

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

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

запроссессия

статический

requestSession (successCallback, errorCallback, sessionRequest)

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

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

Параметр
успехОбратный вызов	функция (ненулевая chrome.cast.Session )
ошибкаОбратный вызов	функция (ненулевое значение 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 (идентификатор сеанса)

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

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

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

setCustomReceivers

статический

setCustomReceivers (приемники, SuccessCallback, errorCallback)

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

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

Устарело

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

сбежать

статический

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

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

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

Возврат

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

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

ПолучательActionListener

статический

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