概要

キャストデバイスのコントローラ。

このクラスは、キャストデバイスで実行されているアプリケーションに対して、メッセージの送信、受信、起動、終了を行えます。

キャストデバイスへの接続が確立されているか、作成中または破棄中の間は、GCKDeviceManager インスタンスをスコープに維持する必要があります。connect (GCKDeviceManager) で接続を開始する前に、または deviceManager:didDisconnectWithError: (GCKDeviceManagerDelegate-p)、deviceManager:didSuspendConnectionWithReason: (GCKDeviceManagerDelegate-p)、deviceManager:didFailToConnectWithError: (GCKDeviceManagerDelegate-p) デリゲートコールバックが呼び出された後に、オブジェクトを解放しても安全です。

Deprecated:: GCKSessionManager と GCKCastSession を使用してキャストレシーバを操作します。

NSObject を継承します。

インスタンスメソッドの概要
(instancetype)	- initWithDevice:clientPackageName:
	指定されたデバイスを使用して新しい GCKDeviceManager を作成します。その他...

(instancetype)	- initWithDevice:clientPackageName:ignoreAppStateNotifications:
	指定されたイニシャライザ。その他...

(void)	- connect
	デバイスに接続します。その他...

(void)	- disconnect
	デバイスの接続が解除されます。その他...

(void)	- disconnectWithLeave:
	デバイスの接続が解除されます。その他...

(BOOL)	- addChannel:
	このデバイスのメッセージを特定の名前空間で送受信できるチャンネルを追加します。その他...

(BOOL)	- removeChannel:
	以前に追加したチャンネルを削除します。その他...

(NSInteger)	- launchApplication:
	アプリを起動します。その他...

(NSInteger)	- launchApplication:withLaunchOptions:
	指定された起動オプションを使用してアプリを起動します。その他...

(NSInteger)	- launchApplication:relaunchIfRunning:
	アプリを起動します。すでに実行中の場合は、必要に応じて再起動します。その他...

(NSInteger)	- joinApplication:
	アプリケーションに参加します。その他...

(NSInteger)	- joinApplication:sessionID:
	特定のアプリケーションセッション ID でアプリケーションに結合します。その他...

(BOOL)	- leaveApplication
	現在のアプリから移動します。その他...

(NSInteger)	- stopApplication
	実行中のアプリケーションをすべて停止します。その他...

(NSInteger)	- stopApplicationWithSessionID:
	指定されたアプリケーションセッション ID でアプリケーションを停止します。その他...

(NSInteger)	- setVolume:
	システムボリュームを設定します。その他...

(NSInteger)	- setMuted:
	ミュートのオンとオフを切り替えます。詳細...

(NSInteger)	- requestDeviceStatus
	デバイスの現在のステータスをリクエストします。その他...

プロパティの概要
BOOL	ignoreAppStateNotifications
	このオブジェクトがアプリの状態通知をリッスンするかどうか。その他...

GCKConnectionState	connectionState
	デバイスマネージャーの現在の接続状態。その他...

GCKConnectionState	applicationConnectionState
	デバイスマネージャーの現在のアプリの接続状態。その他...

BOOL	isConnected
	デバイスマネージャーがデバイスへの接続を確立した場合は true。その他...

BOOL	isConnectedToApp
	デバイスマネージャーがデバイス上のアプリへの接続を確立した場合は true。その他...

BOOL	isReconnecting
	一時的なイベントが発生するとデバイスマネージャーが接続解除された場合（アプリがバックグラウンドで実行されている場合や、再接続することで解決できるネットワークエラーが発生した場合など）は true。その他...

NSTimeInterval	reconnectTimeout
	一時的なエラーによってソケットが切断されると、この間再接続が再試行されます。その他...

GCKDevice *	device
	この GCKDeviceManager によって制御されているデバイス。その他...

id< GCKDeviceManagerDelegate >	delegate
	GCKDeviceManager から通知を受け取るためのデリゲート。その他...

float	deviceVolume
	既知のデバイスのボリューム（既知の場合は [0.0、1.0]、それ以外の場合は 0）その他...

BOOL	deviceMuted
	デバイスの現在のミュート状態（既知の場合）。それ以外の場合は `NO`。その他...

GCKActiveInputStatus	activeInputStatus
	デバイスの現在の「アクティブ入力」ステータス。その他...

GCKStandbyStatus	standbyStatus
	デバイスの現在の「スタンバイ」ステータス。その他...

NSString *	applicationSessionID
	現在接続されているレシーバアプリケーションのアプリケーションセッション ID（存在する場合）。それ以外の場合は `nil`。その他...

GCKApplicationMetadata *	applicationMetadata
	現在レシーバーで実行されているレシーバーアプリのメタデータ（存在する場合）。`nil`。その他...

NSString *	applicationStatusText
	現在実行中のレシーバーアプリからの最新のステータステキスト（存在する場合）。それ以外の場合は `nil`。その他...

メソッドの詳細

- (instancetype) initWithDevice:	(GCKDevice *)	device
clientPackageName:	(NSString *)	clientPackageName

指定されたデバイスを使用して新しい GCKDeviceManager を作成します。

オブジェクトはアプリの状態通知をリッスンし、アプリがバックグラウンドに移行するとデバイスとの接続を自動的に解除し、アプリがフォアグラウンドに戻るとデバイスへの再接続を試みます。

Parameters

device	The device to control.
clientPackageName	The client package name.

- (instancetype) initWithDevice:	(GCKDevice *)	device
clientPackageName:	(NSString *)	clientPackageName
ignoreAppStateNotifications:	(BOOL)	ignoreAppStateNotifications

指定されたイニシャライザ。

指定されたデバイスを制御するための新しい GCKDeviceManager を作成します。

ignoreAppStateNotifications が NO の場合、オブジェクトはアプリの状態の変化をリッスンし、アプリがバックグラウンドに移行するとデバイスとの接続を自動的に解除し、アプリがフォアグラウンドに戻るとデバイスへの再接続を試みます。

ignoreAppStateNotifications が YES の場合、オブジェクトはこれらの通知をリッスンしないので、接続のライフサイクルを管理するのはアプリの役割です。一般に、バックグラウンドの iOS アプリは無期限に実行し続けることはできないため、最終的にアプリのアクティブなネットワーク接続はオペレーティングシステムによって閉じられます。

Parameters

device	The device to control.
clientPackageName	The client package name.
ignoreAppStateNotifications	Whether this object will ignore app state notifications.

- (void) connect

デバイスに接続します。

- (void) disconnect

デバイスの接続が解除されます。

これは明示的な接続解除です。

切断メソッドの 1 つが、connect が呼び出された後、このオブジェクトが所有者によって解放される前のある時点で呼び出す必要があります。

- (void) disconnectWithLeave: (BOOL) leaveApplication

デバイスの接続が解除されます。

切断メソッドの 1 つが、connect が呼び出された後、このオブジェクトが所有者によって解放される前のある時点で呼び出す必要があります。

Parameters

leaveApplication YES if this is an explicit disconnect that should disconnect from ("leave") the receiver application before closing the connection; NO if this is an implicit disconnect that should just close the connection.

- (BOOL) addChannel: (GCKCastChannel *) channel

このデバイスのメッセージを特定の名前空間で送受信できるチャンネルを追加します。

Parameters

channel The channel.

戻り値: YES。チャンネルが追加された場合は NO、追加されなかった名前空間は、その名前空間にチャンネルが接続されていたためです。

- (BOOL) removeChannel: (GCKCastChannel *) channel

以前に追加したチャンネルを削除します。

Parameters

channel The channel.

戻り値: YES: チャンネルが削除された場合、NO。特定のチャンネルが以前に接続されていなかったために削除されていない場合。

- (NSInteger) launchApplication: (NSString *) applicationID

アプリを起動します。

Parameters

applicationID The application ID.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) launchApplication:	(NSString *)	applicationID
withLaunchOptions:	(GCKLaunchOptions *__nullable)	launchOptions

指定された起動オプションを使用してアプリを起動します。

Parameters

applicationID	The application ID.
launchOptions	The launch options for this request. If `nil`, defaults will be used.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) launchApplication:	(NSString *)	applicationID
relaunchIfRunning:	(BOOL)	relaunchIfRunning

アプリを起動します。すでに実行中の場合は、必要に応じて再起動します。

Deprecated:: 代わりにlaunchApplication:withLaunchOptions:を使用してください。

Parameters

applicationID	The application ID.
relaunchIfRunning	If `YES`, relaunches the application if it is already running instead of joining the running application.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) joinApplication: (NSString *__nullable) applicationID

アプリケーションに参加します。

Parameters

applicationID The application ID. If nil, attempts to join whichever application is currently running; otherwise, attempts to join the specified application.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) joinApplication:	(NSString *)	applicationID
sessionID:	(NSString *)	sessionID

特定のアプリケーションセッション ID でアプリケーションに結合します。

指定されたセッション ID がレシーバでアクティブでなくなった場合、リクエストは失敗します。

Parameters

applicationID	The application ID.
sessionID	The application session ID.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (BOOL) leaveApplication

現在のアプリから移動します。

戻り値: NO: メッセージを送信できなかった。

- (NSInteger) stopApplication

実行中のアプリケーションをすべて停止します。

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) stopApplicationWithSessionID: (NSString *__nullable) sessionID

指定されたアプリケーションセッション ID でアプリケーションを停止します。

指定されたセッション ID がレシーバでアクティブでなくなった場合、リクエストは失敗します。

Parameters

sessionID The application session ID, which may not be nil.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) setVolume: (float) volume

システムボリュームを設定します。

Parameters

volume The new volume, in the range [0.0, 1.0]. Out of range values will be silently clipped.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) setMuted: (BOOL) muted

ミュートのオンとオフを切り替えます。

Parameters

muted Whether audio should be muted or unmuted.

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

- (NSInteger) requestDeviceStatus

デバイスの現在のステータスをリクエストします。

これにより、更新されたステータス情報を受け取ると、デリゲートのステータス更新コールバックがすべて呼び出されます。

戻り値: リクエスト ID。リクエストを送信できなかった場合は kGCKInvalidRequestID。

プロパティの詳細

- (BOOL) ignoreAppStateNotifications

readnonatomicassign

このオブジェクトがアプリの状態通知をリッスンするかどうか。

このフラグはイニシャライザで指定できます。デフォルト値は NO です。

- (GCKConnectionState) connectionState

readnonatomicassign

デバイスマネージャーの現在の接続状態。

- (GCKConnectionState) applicationConnectionState

readnonatomicassign

デバイスマネージャーの現在のアプリの接続状態。

- (BOOL) isConnected

readnonatomicassign

デバイスマネージャーがデバイスへの接続を確立した場合は true。

Deprecated:: connectionState を使用します。

- (BOOL) isConnectedToApp

readnonatomicassign

デバイスマネージャーがデバイス上のアプリへの接続を確立した場合は true。

Deprecated:: applicationConnectionState を使用します。

- (BOOL) isReconnecting

readnonatomicassign

一時的なイベントが発生するとデバイスマネージャーが接続解除された場合（アプリがバックグラウンドで実行されている場合や、再接続することで解決できるネットワークエラーが発生した場合など）は true。

接続解除/接続コールバックは、一時的な可能性があるイベントの後にデバイスマネージャーが再接続を試行している間は呼び出されませんが、プロパティには常に実際の現在の状態が反映され、監視できます。

- (NSTimeInterval) reconnectTimeout

readwritenonatomicassign

一時的なエラーによってソケットが切断されると、この間再接続が再試行されます。

デフォルトのタイムアウトは 15 秒です。

- (GCKDevice*) device

readnonatomicassign

この GCKDeviceManager によって制御されているデバイス。

- (id<GCKDeviceManagerDelegate>) delegate

readwritenonatomicweak

GCKDeviceManager から通知を受け取るためのデリゲート。

- (float) deviceVolume

readnonatomicassign

既知のデバイスのボリューム（既知の場合は [0.0、1.0]、それ以外の場合は 0）

- (BOOL) deviceMuted

readnonatomicassign

デバイスの現在のミュート状態（既知の場合）。それ以外の場合は NO。

- (GCKActiveInputStatus) activeInputStatus

readnonatomicassign

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

- (GCKStandbyStatus) standbyStatus

readnonatomicassign

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

- (NSString*) applicationSessionID

readnonatomiccopy

現在接続されているレシーバアプリケーションのアプリケーションセッション ID（存在する場合）。それ以外の場合は nil。

新しい一意のセッション ID は、受信側アプリが起動されるたびに（同じアプリが再起動されたときも）生成され、受信側アプリが動作し続けている限り有効です。

- (GCKApplicationMetadata*) applicationMetadata

readnonatomiccopy

現在レシーバーで実行されているレシーバーアプリのメタデータ（存在する場合）。nil。

- (NSString*) applicationStatusText

readnonatomiccopy

現在実行中のレシーバーアプリからの最新のステータステキスト（存在する場合）。それ以外の場合は nil。

GCKDeviceManager クラス

概要

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

プロパティの概要

メソッドの詳細

プロパティの詳細

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