Класс GCKCastSession

Справочник классов GCKCastSession

Обзор

Класс, который управляет сеансом Cast с устройством-приемником.

Сеансы создаются и управляются автоматически с помощью GCKSessionManager . Приложение не должно напрямую вызывать методы жизненного цикла сеанса, такие как start (GCKSession(Protected)) или endAndStopCasting: (GCKSession(Protected)) .

С
3.0

Наследует GCKSession .

Сводка метода экземпляра

(instancetype) - initWithDevice:sessionID:castOptions:
Назначенный инициализатор. Более...
(BOOL) - addChannel:
Регистрирует канал в сеансе. Более...
(BOOL) - removeChannel:
Удаляет ранее зарегистрированный канал из сеанса. Более...
(void) - addDeviceStatusListener:
Добавляет GCKCastDeviceStatusListener в список прослушивателей этого объекта. Более...
(void) - removeDeviceStatusListener:
Удаляет GCKCastDeviceStatusListener из списка прослушивателей этого объекта. Более...
( GCKRequest *) - setDeviceVolume:forMultizoneDevice:
Устанавливает громкость отдельного устройства в многозонной группе. Более...
( GCKRequest *) - setDeviceMuted:forMultizoneDevice:
Устанавливает состояние отключения звука отдельного устройства в многозонной группе. Более...
( GCKRequest *) - requestMultizoneStatus
Запросить статус мультизоны у мультизональной группы. Более...
(instancetype) - initWithDevice:traits:sessionID:
Инициализирует новый объект сеанса для данного устройства. Более...
( GCKRequest *) - setDeviceVolume:
Устанавливает громкость устройства. Более...
( GCKRequest *) - setDeviceMuted:
Устанавливает беззвучное состояние устройства. Более...
(void) - start
Запускает сеанс. Более...
(void) - endAndStopCasting:
Завершает сеанс. Более...
(void) - suspendWithReason:
Приостанавливает сеанс по указанной причине. Более...
(void) - resume
Возобновляет сеанс. Более...
(void) - notifyDidStartWithSessionID:
Вызывается подклассами для уведомления платформы о запуске сеанса. Более...
(void) - notifyDidFailToStartWithError:
Вызывается подклассами для уведомления платформы о том, что сеанс не удалось запустить. Более...
(void) - notifyDidResume
Вызывается подклассами для уведомления платформы о возобновлении сеанса. Более...
(void) - notifyDidSuspendWithReason:
Вызывается подклассами для уведомления платформы о приостановке сеанса. Более...
(void) - notifyDidEndWithError:
Вызывается подклассами для уведомления платформы о завершении сеанса. Более...
(void) - notifyDidReceiveDeviceVolume:muted:
Вызывается подклассами для уведомления платформы о том, что с устройства были получены обновленная громкость устройства и состояние отключения звука. Более...
(void) - notifyDidReceiveDeviceStatus:
Вызывается подклассами для уведомления платформы о получении обновленного статуса от устройства. Более...

Сводная информация о недвижимости

GCKActiveInputStatus   activeInputStatus
Текущий статус «активного входа» устройства. Более...
GCKStandbyStatus   standbyStatus
Текущий статус устройства в режиме ожидания. Более...
GCKApplicationMetadata applicationMetadata
Метаданные приложения-получателя, которое в данный момент работает на устройстве-получателе, если таковые имеются; в противном случае nil . Более...
GCKDevice device
Устройство, с которым связан этот сеанс. Более...
NSString *  sessionID
Текущий идентификатор сеанса, если таковой имеется. Более...
GCKConnectionState   connectionState
Текущее состояние соединения сеанса. Более...
BOOL  suspended
Флаг, указывающий, приостановлен ли сеанс в данный момент. Более...
NSString *  deviceStatusText
Текст текущего состояния устройства. Более...
GCKSessionTraits traits
Особенности сессии. Более...
float  currentDeviceVolume
Текущая громкость устройства в диапазоне [0,0, 1,0]. Более...
BOOL  currentDeviceMuted
Текущее состояние отключения звука устройства. Более...
GCKRemoteMediaClient remoteMediaClient
Объект GCKRemoteMediaClient , который можно использовать для управления воспроизведением мультимедиа в этом сеансе. Более...
GCKMediaMetadata mediaMetadata
Текущие метаданные мультимедиа, если таковые имеются. Более...

Подробности метода

- (instancetype) initWithDevice: ( GCKDevice *)  device
sessionID: (NSString *__nullable)  sessionID
castOptions: ( GCKCastOptions *)  castOptions  

Назначенный инициализатор.

Создает новый сеанс трансляции с заданными параметрами трансляции.

Parameters
deviceThe receiver device.
sessionIDThe session ID, if resuming; otherwise nil .
castOptionsThe Cast options.
- (BOOL) addChannel: ( GCKCastChannel *)  channel

Регистрирует канал в сеансе.

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

Parameters
channelThe channel to register.
Возврат
YES , если канал успешно зарегистрирован, в противном случае NO .
- (BOOL) removeChannel: ( GCKCastChannel *)  channel

Удаляет ранее зарегистрированный канал из сеанса.

Parameters
channelThe channel to unregister.
Возврат
YES , если канал был успешно отменен, в противном случае NO .
- (void) addDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

Добавляет GCKCastDeviceStatusListener в список прослушивателей этого объекта.

Parameters
listenerThe listener to add.
- (void) removeDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

Удаляет GCKCastDeviceStatusListener из списка прослушивателей этого объекта.

Parameters
listenerThe listener to remove.
- ( GCKRequest *) setDeviceVolume: (float)  volume
forMultizoneDevice: ( GCKMultizoneDevice *)  device  

Устанавливает громкость отдельного устройства в многозонной группе.

Это асинхронная операция.

Parameters
volumeThe new volume, in the range [0.0, 1.0].
deviceThe multizone device.
Возврат
Объект GCKRequest для отслеживания запроса.
- ( GCKRequest *) setDeviceMuted: (BOOL)  muted
forMultizoneDevice: ( GCKMultizoneDevice *)  device  

Устанавливает состояние отключения звука отдельного устройства в многозонной группе.

Это асинхронная операция.

Parameters
mutedThe new muted state.
deviceThe multizone device.
Возврат
Объект GCKRequest для отслеживания запроса.
- ( GCKRequest *) requestMultizoneStatus

Запросить статус мультизоны у мультизональной группы.

Это асинхронная операция. При получении статуса мультизоны методу делегата castSession:didReceiveMultizoneStatus: (GCKCastDeviceStatusListener-p) будет отправлено сообщение.

Возврат
Объект GCKRequest для отслеживания запроса.
- (instancetype) initWithDevice: ( GCKDevice *)  device
traits: ( GCKSessionTraits *)  traits
sessionID: (NSString *__nullable)  sessionID  

Инициализирует новый объект сеанса для данного устройства.

Parameters
deviceThe device.
traitsThe session traits.
sessionIDThe session ID of an existing session, if this object will be used to resume a session; otherwise nil if it will be used to start a new session.
- ( GCKRequest *) setDeviceVolume: (float)  volume

Устанавливает громкость устройства.

Это асинхронная операция. Реализация по умолчанию — это пустая операция, которая завершает запрос с ошибкой GCKErrorCodeUnsupportedFeature.

Parameters
volumeThe new volume.
Возврат
Объект GCKRequest для отслеживания запроса.
С
3,4; в предыдущих версиях платформы этот метод возвращал void .
- ( GCKRequest *) setDeviceMuted: (BOOL)  muted

Устанавливает беззвучное состояние устройства.

Это асинхронная операция. Реализация по умолчанию — это пустая операция, которая завершает запрос с ошибкой GCKErrorCodeUnsupportedFeature.

Parameters
mutedThe new mute state.
Возврат
Объект GCKRequest для отслеживания запроса.
С
3,4; в предыдущих версиях платформы этот метод возвращал void .
- (void) start

Запускает сеанс.

Это асинхронная операция. Должен быть переопределен подклассами.

Предоставлено категорией GCKSession(Protected) .

- (void) endAndStopCasting: (BOOL)  stopCasting

Завершает сеанс.

Это асинхронная операция. Должен быть переопределен подклассами.

Parameters
stopCastingWhether to stop casting content to the receiver.

Предоставлено категорией GCKSession(Protected) .

- (void) suspendWithReason: ( GCKConnectionSuspendReason reason

Приостанавливает сеанс по указанной причине.

Это асинхронная операция. Должен быть переопределен подклассами.

Предоставлено категорией GCKSession(Protected) .

- (void) resume

Возобновляет сеанс.

Это асинхронная операция. Должен быть переопределен подклассами.

Предоставлено категорией GCKSession(Protected) .

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

Вызывается подклассами для уведомления платформы о запуске сеанса.

Parameters
sessionIDThe session's unique ID.

Предоставлено категорией GCKSession(Protected) .

- (void) notifyDidFailToStartWithError: (NSError *)  error

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

Parameters
errorThe error that occurred.

Предоставлено категорией GCKSession(Protected) .

- (void) notifyDidResume

Вызывается подклассами для уведомления платформы о возобновлении сеанса.

Предоставлено категорией GCKSession(Protected) .

- (void) notifyDidSuspendWithReason: ( GCKConnectionSuspendReason reason

Вызывается подклассами для уведомления платформы о приостановке сеанса.

Parameters
reasonThe reason for the suspension.

Предоставлено категорией GCKSession(Protected) .

- (void) notifyDidEndWithError: (NSError *__nullable)  error

Вызывается подклассами для уведомления платформы о завершении сеанса.

Parameters
errorThe error that caused the session to end, if any. Should be nil if the session was ended intentionally.

Предоставлено категорией GCKSession(Protected) .

- (void) notifyDidReceiveDeviceVolume: (float)  volume
muted: (BOOL)  muted  

Вызывается подклассами для уведомления платформы о том, что с устройства были получены обновленная громкость устройства и состояние отключения звука.

Parameters
volumeThe device's current volume. Must be in the range [0, 1.0];
mutedThe device's current mute state.

Предоставлено категорией GCKSession(Protected) .

- (void) notifyDidReceiveDeviceStatus: (NSString *__nullable)  statusText

Вызывается подклассами для уведомления платформы о получении обновленного статуса от устройства.

Parameters
statusTextThe new status.

Предоставлено категорией GCKSession(Protected) .

Детали недвижимости

- ( GCKActiveInputStatus ) activeInputStatus
read nonatomic assign

Текущий статус «активного входа» устройства.

- ( GCKStandbyStatus ) standbyStatus
read nonatomic assign

Текущий статус устройства в режиме ожидания.

- ( GCKApplicationMetadata *) applicationMetadata
read nonatomic copy

Метаданные приложения-получателя, которое в данный момент работает на устройстве-получателе, если таковые имеются; в противном случае nil .

- ( GCKDevice *) device
read nonatomic strong inherited

Устройство, с которым связан этот сеанс.

- (NSString*) sessionID
read nonatomic copy inherited

Текущий идентификатор сеанса, если таковой имеется.

- ( GCKConnectionState ) connectionState
read nonatomic assign inherited

Текущее состояние соединения сеанса.

- (BOOL) suspended
read nonatomic assign inherited

Флаг, указывающий, приостановлен ли сеанс в данный момент.

- (NSString*) deviceStatusText
read nonatomic copy inherited

Текст текущего состояния устройства.

- ( GCKSessionTraits *) traits
read nonatomic copy inherited

Особенности сессии.

- (float) currentDeviceVolume
read nonatomic assign inherited

Текущая громкость устройства в диапазоне [0,0, 1,0].

- (BOOL) currentDeviceMuted
read nonatomic assign inherited

Текущее состояние отключения звука устройства.

- ( GCKRemoteMediaClient *) remoteMediaClient
read nonatomic strong inherited

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

Оно равно nil до начала сеанса или если сеанс не поддерживает API GCKRemoteMediaClient . Подклассы, предоставляющие интерфейс GCKRemoteMediaClient , должны переопределить метод получения.

- ( GCKMediaMetadata *) mediaMetadata
read nonatomic strong inherited

Текущие метаданные мультимедиа, если таковые имеются.

Будет равно nil , если сеанс не поддерживает пространство имен мультимедиа или если в данный момент на приемнике не загружено ни одного мультимедиа.