概要
レシーバー デバイスとのセッションを表す抽象基底クラス。
サブクラスでは、start (GCKSession(Protected))、endAndStopCasting: (GCKSession(Protected))、suspendWithReason: (GCKSession(Protected))、resume (GCKSession(Protected)) の各メソッドを実装し、適切な Notifier メソッド(notifyDidStartWithSessionID: (GCKSession(Protected)) など)を呼び出して、セッション状態における対応する変更を示す必要があります。デバイスがそのようなオペレーションをサポートしている場合、setDeviceVolume: (GCKSession)、setDeviceMuted: (GCKSession)、remoteMediaClient をサブクラスで実装することもできます。
セッションは GCKSessionManager のセッション メソッドを使用して作成および制御されます。このメソッドは、適切な GCKDeviceProvider を使用してセッションを作成し、その GCKSession オブジェクトにセッション リクエストを委任します。
- シンセ
- 3.0
NSObject を継承します。
GCKCastSession から継承しました。
インスタンス メソッドの概要 | |
(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: |
更新されたステータスがデバイスから受信されたことをフレームワークに通知するために、サブクラスによって呼び出されます。その他... | |
プロパティの概要 | |
GCKDevice * | device |
このセッションが関連付けられているデバイス。その他... | |
NSString * | sessionID |
現在のセッション ID(ある場合)。その他... | |
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: | (GCKSessionTraits *) | traits | |
sessionID: | (NSString *__nullable) | sessionID | |
指定されたデバイスの新しいセッション オブジェクトを初期化します。
- Parameters
-
device The device. traits The session traits. sessionID The 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 |
デバイスの音量を設定します。
これは非同期オペレーションです。デフォルトの実装では、GCKErrorCodeSupportedFeature エラーでリクエストが失敗します。
- Parameters
-
volume The new volume.
- 戻り値
- リクエストをトラッキングするための GCKRequest オブジェクト。
- シンセ
- 3.4: 以前のフレームワーク バージョンでは、このメソッドは
void
を返しました。
- (GCKRequest *) setDeviceMuted: | (BOOL) | muted |
デバイスのミュート状態を設定します。
これは非同期オペレーションです。デフォルトの実装では、GCKErrorCodeSupportedFeature エラーでリクエストが失敗します。
- Parameters
-
muted The new mute state.
- 戻り値
- リクエストをトラッキングするための GCKRequest オブジェクト。
- シンセ
- 3.4: 以前のフレームワーク バージョンでは、このメソッドは
void
を返しました。
- (void) start |
- (void) endAndStopCasting: | (BOOL) | stopCasting |
セッションを終了します。
これは非同期オペレーションです。サブクラスでオーバーライドする必要があります。
- Parameters
-
stopCasting Whether to stop casting content to the receiver.
カテゴリ GCKSession(Protected) によって提供されます。
- (void) suspendWithReason: | (GCKConnectionSuspendReason) | reason |
指定された理由でセッションを一時停止します。
これは非同期オペレーションです。サブクラスでオーバーライドする必要があります。
カテゴリ GCKSession(Protected) によって提供されます。
- (void) resume |
- (void) notifyDidStartWithSessionID: | (NSString *) | sessionID |
サブクラスから呼び出され、セッションが開始されたことをフレームワークに通知します。
- Parameters
-
sessionID The session's unique ID.
カテゴリ GCKSession(Protected) によって提供されます。
- (void) notifyDidFailToStartWithError: | (NSError *) | error |
サブクラスから呼び出され、セッションが開始されなかったことをフレームワークに通知します。
- Parameters
-
error The error that occurred.
カテゴリ GCKSession(Protected) によって提供されます。
- (void) notifyDidResume |
サブクラスから呼び出され、セッションが再開されたことをフレームワークに通知します。
カテゴリ GCKSession(Protected) によって提供されます。
- (void) notifyDidSuspendWithReason: | (GCKConnectionSuspendReason) | reason |
セッションが一時停止されたことをフレームワークに通知するためにサブクラスから呼び出されます。
- Parameters
-
reason The reason for the suspension.
カテゴリ GCKSession(Protected) によって提供されます。
- (void) notifyDidEndWithError: | (NSError *__nullable) | error |
サブクラスから呼び出され、セッションが終了したことをフレームワークに通知します。
- Parameters
-
error The 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
-
volume The device's current volume. Must be in the range [0, 1.0]; muted The device's current mute state.
カテゴリ GCKSession(Protected) によって提供されます。
- (void) notifyDidReceiveDeviceStatus: | (NSString *__nullable) | statusText |
更新されたステータスがデバイスから受信されたことをフレームワークに通知するために、サブクラスによって呼び出されます。
- Parameters
-
statusText The new status.
カテゴリ GCKSession(Protected) によって提供されます。
プロパティの詳細
|
readnonatomicstrong |
このセッションが関連付けられているデバイス。
|
readnonatomiccopy |
現在のセッション ID(ある場合)。
|
readnonatomicassign |
現在のセッション接続状態。
|
readnonatomicassign |
セッションが現在停止されているかどうかを示すフラグ。
|
readnonatomiccopy |
現在のデバイスのステータス テキスト。
|
readnonatomiccopy |
セッション トレイト。
|
readnonatomicassign |
現在のデバイスの音量の範囲(0.0 ~ 1.0)です。
|
readnonatomicassign |
デバイスの現在のミュート状態。
|
readnonatomicstrong |
このセッションのメディア再生の制御に使用できる GCKRemoteMediaClient オブジェクト。
セッションの開始前が nil
の場合。または、セッションが GCKRemoteMediaClient API をサポートしていない場合。GCKRemoteMediaClient インターフェースを提供するサブクラスは、ゲッター メソッドをオーバーライドする必要があります。
|
readnonatomicstrong |
現在のメディア メタデータ(存在する場合)。
セッションがメディア名前空間をサポートしていない場合、またはレシーバに現在メディアが読み込まれていない場合は nil
になります。