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

device	The receiver device.
sessionID	The session ID, if resuming; otherwise nil.
sessionOptions	The session options, if any; otherwise nil.
castOptions	The Cast options.

開始:

4.0

- (BOOL) addChannel:

(GCKCastChannel *)

channel

チャネルをセッションに登録します。

セッションが接続され、受信側アプリケーションがチャネルの名前空間をサポートしている場合、チャネルは自動的に接続されます。セッションが接続されていない場合、セッションが開始されるまでチャンネルは切断状態のままになります。

Parameters

channel

The channel to register.

戻り値

チャンネルが正常に登録された場合は YES、そうでない場合は NO。

- (BOOL) removeChannel:

(GCKCastChannel *)

channel

以前に登録したチャンネルをセッションから削除します。

Parameters

channel

The channel to unregister.

戻り値

チャンネルの登録が正常に解除された場合は YES、そうでない場合は NO。

- (void) addDeviceStatusListener:

(id< GCKCastDeviceStatusListener >)

listener

このオブジェクトのリスナーのリストに GCKCastDeviceStatusListener を追加します。

追加されたリスナーは弱く保持されるため、予期しない割り当て解除を避けるために保持する必要があります。

Parameters

listener

The listener to add.

- (void) removeDeviceStatusListener:

(id< GCKCastDeviceStatusListener >)

listener

このオブジェクトのリスナーのリストから GCKCastDeviceStatusListener を削除します。

Parameters

listener

The listener to remove.

- (GCKRequest *) setDeviceVolume:		(float)	volume
forMultizoneDevice:		(GCKMultizoneDevice *)	device

マルチゾーン グループ内の個々のデバイスの音量を設定します。

これは非同期処理です。

Parameters

volume	The new volume, in the range [0.0, 1.0].
device	The multizone device.

戻り値

リクエストを追跡するための GCKRequest オブジェクト。

- (GCKRequest *) setDeviceMuted:		(BOOL)	muted
forMultizoneDevice:		(GCKMultizoneDevice *)	device

マルチゾーン グループ内の個々のデバイスのミュート状態を設定します。

これは非同期処理です。

Parameters

muted	The new muted state.
device	The multizone device.

戻り値

リクエストを追跡するための GCKRequest オブジェクト。

- (GCKRequest *) requestMultizoneStatus

マルチゾーン グループからマルチゾーン ステータスをリクエストします。

これは非同期処理です。マルチゾーン ステータスを受信すると、castSession:didReceiveMultizoneStatus: (GCKCastDeviceStatusListener-p) デリゲート メソッドにメッセージが送信されます。

戻り値

リクエストを追跡するための GCKRequest オブジェクト。

- (instancetype) initWithDevice:		(GCKDevice *)	device
traits:		(nullable GCKSessionTraits *)	traits
sessionID:		(nullable NSString *)	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.

- (instancetype) initWithDevice:		(GCKDevice *)	device
traits:		(nullable GCKSessionTraits *)	traits
sessionID:		(nullable NSString *)	sessionID
sessionOptions:		(nullable GCKSessionOptions *)	sessionOptions

指定されたデバイスの新しいセッション オブジェクトを初期化します。

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.
sessionOptions	The session options, if any; otherwise nil.

開始:

4.0

- (GCKRequest *) setDeviceVolume:

(float)

volume

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

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

Parameters

volume

The new volume.

戻り値

リクエストを追跡するための GCKRequest オブジェクト。

開始:

3.4。以前のフレームワーク バージョンでは、このメソッドは void を返していました。

- (GCKRequest *) setDeviceMuted:

(BOOL)

muted

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

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

Parameters

muted

The new mute state.

戻り値

リクエストを追跡するための GCKRequest オブジェクト。

開始:

3.4。以前のフレームワーク バージョンでは、このメソッドは void を返していました。

- (void) start

セッションを開始します。

これは非同期処理です。サブクラスでオーバーライドする必要があります。

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

- (void) endWithAction:

(GCKSessionEndAction)

action

指定したアクションのセッションを終了します。

これは非同期処理です。サブクラスでオーバーライドする必要があります。

Parameters

action

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

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

- (void) notifyDidStartWithSessionID:

(NSString *)

sessionID

セッションが開始されたことをフレームワークに通知するためにサブクラスによって呼び出されます。

Parameters

sessionID

The session's unique ID.

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

- (void) notifyDidFailToStartWithError:

(GCKError *)

error

セッションの開始に失敗したことをフレームワークに通知するために、サブクラスによって呼び出されます。

Parameters

error

The error that occurred.

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

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

セッションが終了したことをフレームワークに通知するために、サブクラスによって呼び出されます。

Parameters

error	The error that caused the session to end, if any. Should be nil if the session was ended intentionally.
willTryToResume	Whether the session will try to resume itself automatically.

カテゴリ 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:

(nullable NSString *)

statusText

サブクラスによって呼び出され、更新されたステータスをデバイスから受け取ったことをフレームワークに通知します。

Parameters

statusText

The 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 になります。