概要
レシーバー デバイスとのセッションを表す抽象基本クラス。
サブクラスは、start (GCKSession(Protected))、endAndStopCasting: (GCKSession(Protected))、suspendWithReason: (GCKSession(Protected))、resume (GCKSession(Protected)) の各メソッドを実装し、適切な通知メソッド（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 nilif it will be used to start a new session.
| - (GCKRequest *) setDeviceVolume: | (float) | volume |
デバイスの音量を設定します。
これは非同期オペレーションです。デフォルトの実装は、GCKErrorCodeUnsupportedFeature エラーでリクエストを失敗させる no-op です。
- Parameters
-
volume The new volume.
- 戻り値
- リクエストをトラッキングするための GCKRequest オブジェクト。
- 発足
- 3.4。以前のフレームワーク バージョンでは、このメソッドは
voidを返していました。
| - (GCKRequest *) setDeviceMuted: | (BOOL) | muted |
デバイスのミュート状態を設定します。
これは非同期オペレーションです。デフォルトの実装は、GCKErrorCodeUnsupportedFeature エラーでリクエストを失敗させる no-op です。
- 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 |
| - (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 nilif 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 オブジェクト。
セッションが開始する前、またはセッションが GCKRemoteMediaClient API をサポートしていない場合は nil です。GCKRemoteMediaClient インターフェースを提供するサブクラスは、getter メソッドをオーバーライドする必要があります。
|
readnonatomicstrong |
現在のメディアのメタデータ（存在する場合）。
セッションがメディア名前空間をサポートしていない場合、または現在レシーバーにメディアが読み込まれていない場合は、nil になります。