GCKCastSession クラス

インスタンス メソッド | プロパティ
GCKCastSession クラス リファレンス

概要

受信デバイスを使用するキャスト セッションを管理するクラス。

セッションは GCKSessionManager によって自動的に作成、管理されます。アプリは、start (GCKSession(Protected)) や endWithAction: (GCKSession(Protected)) などのセッション ライフサイクル メソッドを直接呼び出すべきではありません。

開始:
3.0

GCKSession を継承します。

インスタンス メソッドの概要

(instancetype) - initWithDevice:sessionID:sessionOptions:castOptions:
 指定されたキャスト オプションを使用して新しいキャスト セッションを作成します。その他
 
(BOOL) - addChannel:
 セッションにチャンネルを登録します。その他
 
(BOOL) - removeChannel:
 セッションから以前に登録したチャンネルを削除します。その他
 
(void) - addDeviceStatusListener:
 このオブジェクトのリスナーのリストに GCKCastDeviceStatusListener を追加します。その他
 
(void) - removeDeviceStatusListener:
 このオブジェクトのリスナーのリストから GCKCastDeviceStatusListener を削除します。その他
 
(GCKRequest *) - setDeviceVolume:forMultizoneDevice:
 マルチゾーン グループで個々のデバイスの音量を設定します。その他
 
(GCKRequest *) - setDeviceMuted:forMultizoneDevice:
 マルチゾーン グループで個々のデバイスのミュート状態を設定します。その他
 
(GCKRequest *) - requestMultizoneStatus
 マルチゾーン グループのマルチゾーン ステータスをリクエストします。その他
 
(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 として実装。詳細...
 

プロパティの概要

GCKActiveInputStatus activeInputStatus
 デバイスの現在の「アクティブ入力」ステータス。その他
 
GCKStandbyStatus standbyStatus
 デバイスの現在の「スタンバイ」ステータス。その他
 
GCKApplicationMetadata * applicationMetadata
 現在レシーバ デバイスで実行中のレシーバ アプリケーションのメタデータ（存在する場合）。それ以外の場合は nil。その他
 
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
sessionID: (nullable NSString *)  sessionID
sessionOptions: (nullable GCKSessionOptions *)  sessionOptions
castOptions: (GCKCastOptions *)  castOptions 

指定されたキャスト オプションを使用して新しいキャスト セッションを作成します。

Parameters
deviceThe receiver device.
sessionIDThe session ID, if resuming; otherwise nil.
sessionOptionsThe session options, if any; otherwise nil.
castOptionsThe Cast options.
開始:
4.0
- (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: (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

デバイスの音量を設定します。

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

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

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

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

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) から提供されます。

宿泊施設の詳細

- (GCKActiveInputStatus) activeInputStatus
readnonatomicassign

デバイスの現在の「アクティブ入力」ステータス。

- (GCKStandbyStatus) standbyStatus
readnonatomicassign

デバイスの現在の「スタンバイ」ステータス。

- (GCKApplicationMetadata*) applicationMetadata
readnonatomiccopy

現在レシーバ デバイスで実行中のレシーバ アプリケーションのメタデータ（存在する場合）。それ以外の場合は nil。

- (GCKDevice*) device
readnonatomicstronginherited

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

- (NSString*) sessionID
readnonatomiccopyinherited

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

- (GCKSessionOptions*) sessionOptions
readnonatomicstronginherited

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

開始:
4.0
- (GCKConnectionState) connectionState
readnonatomicassigninherited

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

- (BOOL) suspended
readnonatomicassigninherited

セッションが現在停止中かどうかを示すフラグ。

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

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

- (GCKSessionTraits*) traits
readnonatomiccopyinherited

セッション トレイト。

- (float) currentDeviceVolume
readnonatomicassigninherited

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

- (BOOL) currentDeviceMuted
readnonatomicassigninherited

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

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstronginherited

このセッションでメディアの再生を制御するために使用できる GCKRemoteMediaClient オブジェクト。

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

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstronginherited

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

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