Класс GCKSession

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

Обзор

Абстрактный базовый класс, представляющий сеанс с устройством-приемником.

Подклассы должны реализовать методы start (GCKSession(Protected)) и endWithAction: (GCKSession(Protected)) и должны вызывать соответствующие методы уведомителя (например, notifyDidStartWithSessionID: (GCKSession(Protected)) , чтобы указать соответствующие изменения в состоянии сеанса. . Подклассы также могут реализовывать setDeviceVolume: (GCKSession) , setDeviceMuted: (GCKSession) и remoteMediaClient , если устройство поддерживает такие операции.

Сеанс создается и управляется с помощью методов сеанса в GCKSessionManager , который использует соответствующий GCKDeviceProvider для создания сеанса, а затем делегирует запросы сеанса этому объекту GCKSession .

С
3.0

Наследует NSObject.

Унаследовано GCKCastSession .

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

(instancetype) - initWithDevice:traits:sessionID:
Инициализирует новый объект сеанса для данного устройства с параметрами по умолчанию. Более...
(instancetype) - initWithDevice:traits:sessionID:sessionOptions:
Инициализирует новый объект сеанса для данного устройства. Более...
( GCKRequest *) - setDeviceVolume:
Устанавливает громкость устройства. Более...
( GCKRequest *) - setDeviceMuted:
Устанавливает беззвучное состояние устройства. Более...
(void) - start
Запускает сеанс. Более...
(void) - endWithAction:
Завершает сеанс указанным действием. Более...
(void) - notifyDidStartWithSessionID:
Вызывается подклассами для уведомления платформы о запуске сеанса. Более...
(void) - notifyDidFailToStartWithError:
Вызывается подклассами для уведомления платформы о том, что сеанс не удалось запустить. Более...
(void) - notifyDidEndWithError:willTryToResume:
Вызывается подклассами для уведомления платформы о завершении сеанса. Более...
(void) - notifyDidReceiveDeviceVolume:muted:
Вызывается подклассами для уведомления платформы о том, что с устройства были получены обновленная громкость устройства и состояние отключения звука. Более...
(void) - notifyDidReceiveDeviceStatus:
Вызывается подклассами для уведомления платформы о получении обновленного статуса от устройства. Более...
(void) - notifyDidSuspendWithReason:
Устарело, не используйте - реализовано как неактивное. Более...
(void) - notifyDidResume
Устарело, не используйте - реализовано как неактивное. Более...

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

GCKDevice device
Устройство, с которым связан этот сеанс. Более...
NSString *  sessionID
Текущий идентификатор сеанса, если таковой имеется. Более...
GCKSessionOptions *  sessionOptions
Параметры сеанса, если таковые имеются. Более...
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
traits: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  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.
- (instancetype) initWithDevice: ( GCKDevice *)  device
traits: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  sessionID
sessionOptions: (nullable GCKSessionOptions *)  sessionOptions  

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

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.
sessionOptionsThe session options, if any; otherwise nil .
С
4.0
- ( 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) endWithAction: ( GCKSessionEndAction action

Завершает сеанс указанным действием.

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

Parameters
actionThe action to take when ending the session; see GCKSessionEndAction for more details.

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

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

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

Parameters
sessionIDThe session's unique ID.

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

- (void) notifyDidFailToStartWithError: ( GCKError *)  error

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

Parameters
errorThe error that occurred.

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

- (void) notifyDidEndWithError: (nullable NSError *)  error
willTryToResume: (BOOL)  willTryToResume  

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

Parameters
errorThe error that caused the session to end, if any. Should be nil if the session was ended intentionally.
willTryToResumeWhether the session will try to resume itself automatically.

Предоставлено категорией 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: (nullable NSString *)  statusText

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

Parameters
statusTextThe new status.

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

- (void) notifyDidSuspendWithReason: ( GCKConnectionSuspendReason reason

Устарело, не используйте - реализовано как неактивное.

Deprecated:
Не звони.

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

- (void) notifyDidResume

Устарело, не используйте - реализовано как неактивное.

Deprecated:
Не звони.

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

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

- ( GCKDevice *) device
read nonatomic strong

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

- (NSString*) sessionID
read nonatomic copy

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

- (GCKSessionOptions*) sessionOptions
read nonatomic strong

Параметры сеанса, если таковые имеются.

С
4.0
- (GCKConnectionState) connectionState
read nonatomic assign

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

- (BOOL) suspended
read nonatomic assign

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

Deprecated:
GCKSession больше не поддерживает пребывание в приостановленном состоянии. При необходимости переместите эту функциональность в подкласс.
- (NSString*) deviceStatusText
read nonatomic copy

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

- ( GCKSessionTraits *) traits
read nonatomic copy

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

- (float) currentDeviceVolume
read nonatomic assign

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

- (BOOL) currentDeviceMuted
read nonatomic assign

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

- ( GCKRemoteMediaClient *) remoteMediaClient
read nonatomic strong

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

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

- ( GCKMediaMetadata *) mediaMetadata
read nonatomic strong

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

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