хром. литой . Сессия
Описывает состояние работающего в данный момент приложения Cast. Обычно эти объекты не должны создаваться клиентом.
Конструктор
Сессия
новая сессия (sessionId, appId, displayName, appImages, приемник)
Параметр | |
---|---|
идентификатор сессии | нить Идентификатор сеанса. |
идентификатор приложения | нить Идентификатор приложения получателя. |
показать имя | нить Отображаемое имя приложения. |
appImages | Массив ненулевого chrome.cast.Image Изображения, связанные с приложением. Значение не должно быть нулевым. |
получатель | Получатель, на котором запущено приложение. Значение не должно быть нулевым. |
Характеристики
идентификатор приложения
нить
Идентификатор приложения Cast. Не для показа.
appImages
non-null Массив ненулевого chrome.cast.Image
Массив доступных изображений, описывающих приложение.
показать имя
нить
Удобочитаемое имя приложения Cast, например «YouTube».
СМИ
non-null Массив ненулевых chrome.cast.media.Media
Медиафайлы, принадлежащие этому сеансу Cast, в том числе загруженные другими отправителями.
пространства имен
ненулевой массив {имя: строка}
Список пространств имен, поддерживаемых приложением-получателем.
получатель
ненулевой chrome.cast.Receiver
Получатель, на котором запущено приложение.
senderApps
non-null Массив ненулевого chrome.cast.SenderApplication
Приложения-отправители, поддерживаемые приложением-получателем. Это может быть использовано, чтобы предложить пользователю установить или посетить приложение-отправитель.
идентификатор сессии
нить
Уникально идентифицирует этот экземпляр приложения-получателя.
статус
ненулевой chrome.cast.SessionStatus
Статус этого сеанса трансляции в приложение-получатель.
статусТекст
обнуляемая строка
Описательный текст для текущего содержимого приложения, например «Мое свадебное слайд-шоу».
идентификатор транспорта
нить
Идентификатор, однозначно описывающий этот сеанс для транспортных целей. Это внутренний канал связи.
Методы
addMediaListener
addMediaListener (слушатель)
Добавляет прослушиватель, который вызывается, когда мультимедийный сеанс создается другим отправителем.
Параметр | |
---|---|
слушатель | функция ( ненулевая chrome.cast.media.Media ) Слушатель для добавления. |
addMessageListener
addMessageListener (пространство имен, прослушиватель)
Добавляет прослушиватель, который вызывается при получении сообщения от приложения-получателя. Слушатель вызывается с пространством имен в качестве первого аргумента и сообщением в качестве второго аргумента.
Параметр | |
---|---|
пространство имен | нить Пространство имен для прослушивания, например, 'urn:x-cast:com.example.namespace'. |
слушатель | функция(строка, строка) Слушатель для добавления. |
addUpdateListener
addUpdateListener (слушатель)
Добавляет прослушиватель, который вызывается при изменении сеанса. Изменения следующих свойств активируют прослушиватель: statusText, пространства имен, статус и громкость приемника.
Слушатели должны проверить свойство слушатель функция (логическая) Слушатель для добавления. status
сеанса, чтобы определить его состояние соединения. Логический параметр isAlive
устарел в пользу свойства Session status
. Параметр isAlive
по-прежнему передается для обратной совместимости и имеет значение true, если только status = chrome.cast.SessionStatus.STOPPED
. Параметр
getDialAppInfo
getDialAppInfo (успехCallback, errorCallback)
Получает информацию о приложении DIAL.
Параметр | |
---|---|
успехОбратный вызов | функция (ненулевая chrome.cast.DialLaunchData) |
errorCallback | функция ( ненулевая chrome.cast.Error ) |
оставлять
оставить (успехCallback, errorCallback)
Уходит (отключается) от работающего приложения-приемника, связанного с сеансом.
Существующие клиенты в области, определенной AutoJoinPolicy этого клиента, будут отключены. Будущие клиенты не будут автоматически присоединяться к оставшемуся сеансу.
У всех отключенных клиентов будут вызываться прослушиватели обновления сеанса с успехОбратный вызов функция() errorCallback функция ( ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR и EXTENSION_MISSING. isAlive = true
. Слушатели должны проверить свойство status
сеанса, чтобы определить его статус соединения, поскольку isAlive
устарел. В этом случае status = chrome.cast.SessionStatus.DISCONNECTED
. Параметр
loadMedia
loadMedia (loadRequest, SuccessCallback, errorCallback)
Загружает мультимедиа в работающее приложение-приемник.
Параметр | |
---|---|
loadRequest | Запрос на загрузку медиа. Значение не должно быть нулевым. |
успехОбратный вызов | функция ( ненулевая chrome.cast.media.Media ) Вызывается с загруженным носителем в случае успеха. |
errorCallback | функция ( ненулевая chrome.cast.Error ) Вызывается при ошибке. Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR и EXTENSION_MISSING. |
очередьЗагрузить
queueLoad (queueLoadRequest, successCallback, errorCallback)
Загружает и при необходимости запускает воспроизведение новой очереди элементов мультимедиа в работающее приложение-приемник.
Параметр | |
---|---|
очередьLoadRequest | chrome.cast.media.QueueLoadRequest Запрос на загрузку новой очереди элементов мультимедиа. Значение не должно быть нулевым. |
успехОбратный вызов | функция ( ненулевая chrome.cast.media.Media ) Вызывается с загруженным носителем в случае успеха. |
errorCallback | функция ( ненулевая chrome.cast.Error ) Вызывается при ошибке. Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR и EXTENSION_MISSING. |
- Устаревший
- Используйте cast.framework.CastSession#loadMedia и укажите соответствующий chrome.cast.media.LoadRequest#queueData .
удалитьMediaListener
удалитьMediaListener (слушатель)
Удаляет прослушиватель, ранее добавленный с помощью addMediaListener.
Параметр | |
---|---|
слушатель | функция ( ненулевая chrome.cast.media.Media ) Слушатель, который нужно удалить. |
removeMessageListener
removeMessageListener (пространство имен, прослушиватель)
Удаляет ранее добавленный прослушиватель сообщений.
Параметр | |
---|---|
пространство имен | нить Прослушиваемое пространство имен, например, 'urn:x-cast:com.example.namespace'. |
слушатель | функция(строка, строка) Слушатель, который нужно удалить. |
удалитьобновлениеслушателя
removeUpdateListener (слушатель)
Удаляет ранее добавленный прослушиватель для этого сеанса.
Параметр | |
---|---|
слушатель | функция (логическая) Слушатель, который нужно удалить. |
Отправить сообщение
sendMessage (пространство имен, сообщение, successCallback, errorCallback)
Отправляет сообщение приложению-получателю в заданном пространстве имен. SuccessCallback вызывается, когда сообщение отправлено в канал обмена сообщениями. Доставка в приложение-получатель осуществляется с максимальной эффективностью и не гарантируется.
Параметр | |
---|---|
пространство имен | нить Пространство имен для отправки сообщения, например, 'urn:x-cast:com.example.namespace'. |
сообщение | (ненулевой объект или строка) |
успехОбратный вызов | функция() Вызывается при отправке сообщения. |
errorCallback | функция ( ненулевая chrome.cast.Error ) Вызывается при ошибке. Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR и EXTENSION_MISSING. |
setReceiverMuted
setReceiverMuted (приглушенный, SuccessCallback, errorCallback)
Устанавливает громкость приемника.
Параметр | |
---|---|
приглушенный | логический Новый приглушенный статус. |
успехОбратный вызов | функция() |
errorCallback | функция ( ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR и EXTENSION_MISSING. |
setReceiverVolumeLevel
setReceiverVolumeLevel (newLevel, successCallback, errorCallback)
Устанавливает громкость приемника.
Параметр | |
---|---|
новый уровень | количество Новый уровень громкости между 0.0 и 1.0. |
успехОбратный вызов | функция() |
errorCallback | функция ( ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR и EXTENSION_MISSING. |
остановка
стоп (успехCallback, errorCallback)
Останавливает работающее приложение-приемник, связанное с сеансом.
Параметр | |
---|---|
успехОбратный вызов | функция() |
errorCallback | функция ( ненулевая chrome.cast.Error ) Возможные ошибки: TIMEOUT, API_NOT_INITIALIZED, CHANNEL_ERROR, SESSION_ERROR и EXTENSION_MISSING. |