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:
 非推奨。NoOps として実装された - は使用しないでください。詳細...
 
(void) - notifyDidResume
 非推奨。NoOps として実装された - は使用しないでください。詳細...
 

プロパティの概要

GCKDevice * device
 このセッションが関連付けられているデバイス。その他...
 
NSString * sessionID
 現在のセッション ID（ある場合）。その他...
 
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 エラーでリクエストが失敗する NoOps です。

Parameters
volumeThe new volume.
戻り値
リクエストを追跡するための GCKRequest オブジェクト。
開始:
3.4。以前のフレームワーク バージョンでは、このメソッドは void を返していました。
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

デバイスのミュート状態を設定します。

これは非同期処理です。デフォルトの実装では、GCKErrorCodeUnsupportedFeature エラーでリクエストが失敗する NoOps です。

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

非推奨。使用しないでください - NoOps として実装されます。

Deprecated:
電話はしないでください。

カテゴリ GCKSession(Protected) で提供されます。

- (void) notifyDidResume

非推奨。使用しないでください - NoOps として実装されます。

Deprecated:
電話はしないでください。

カテゴリ GCKSession(Protected) で提供されます。

物件の詳細

- (GCKDevice*) device
readnonatomicstrong

このセッションが関連付けられているデバイス。

- (NSString*) sessionID
readnonatomiccopy

現在のセッション ID（ある場合）。

- (GCKSessionOptions*) sessionOptions
readnonatomicstrong

セッション オプション（ある場合）。

開始:
4.0
- (GCKConnectionState) connectionState
readnonatomicassign

現在のセッションの接続状態。

- (BOOL) suspended
readnonatomicassign

セッションが現在一時停止されているかどうかを示すフラグ。

Deprecated:
GCKSession は停止状態のサポート対象外となりました。必要に応じて、この機能をサブクラスに移動します。
- (NSString*) deviceStatusText
readnonatomiccopy

現在のデバイス ステータスのテキスト。

- (GCKSessionTraits*) traits
readnonatomiccopy

セッション トレイト。

- (float) currentDeviceVolume
readnonatomicassign

デバイスの現在の音量（0.0 ～ 1.0 の範囲）。

- (BOOL) currentDeviceMuted
readnonatomicassign

デバイスの現在のミュート状態。

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstrong

このセッションでのメディア再生のコントロールに使用できる GCKRemoteMediaClient オブジェクト。

セッションが開始する前に nil になる場合、またはセッションが GCKRemoteMediaClient API をサポートしていない場合は、GCKRemoteMediaClient インターフェースを提供するサブクラスは、ゲッター メソッドをオーバーライドする必要があります。

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

現在のメディア メタデータ（存在する場合）。

セッションがメディア名前空間をサポートしていない場合、または現在レシーバーにメディアが読み込まれていない場合は、nil になります。