GCKGameManagerChannel クラス

インスタンス メソッド | プロパティ

GCKGameManagerChannel クラス リファレンス

概要

ゲーム コントロール オペレーション用の GCKCastChannel サブクラス。

デリゲート プロトコルについては、GCKGameManagerChannelDelegate をご覧ください。

Deprecated:

Game Manager API はサポートされなくなり、今後のリリースで削除されます。

GCKCastChannel を継承します。

インスタンス メソッドの概要
(instancetype)	- initWithSessionID:
	指定イニシャライザ。詳細...
(instancetype)	- init
	デフォルトのイニシャライザは使用できません。詳細...
(NSInteger)	- sendPlayerAvailableRequest:
	受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateAvailable 状態にします。詳細...
(NSInteger)	- sendPlayerAvailableRequest:playerID:
	プレーヤーを GCKPlayerStateAvailable 状態にするようレシーバーにリクエストを送信します。詳細...
(NSInteger)	- sendPlayerReadyRequest:
	受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateReady 状態にします。詳細...
(NSInteger)	- sendPlayerReadyRequest:playerID:
	プレーヤーを GCKPlayerStateReady 状態にするようレシーバーにリクエストを送信します。詳細...
(NSInteger)	- sendPlayerPlayingRequest:
	受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStatePlaying 状態にします。詳細...
(NSInteger)	- sendPlayerPlayingRequest:playerID:
	プレーヤーを GCKPlayerStatePlaying 状態にするようレシーバーにリクエストを送信します。詳細...
(NSInteger)	- sendPlayerIdleRequest:
	受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateIdle 状態にします。詳細...
(NSInteger)	- sendPlayerIdleRequest:playerID:
	プレーヤーを GCKPlayerStateIdle 状態にするようレシーバーにリクエストを送信します。詳細...
(NSInteger)	- sendPlayerQuitRequest:
	受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateQuit 状態にします。詳細...
(NSInteger)	- sendPlayerQuitRequest:playerID:
	プレーヤーを GCKPlayerStateQuit 状態にするようレシーバーにリクエストを送信します。詳細...
(NSInteger)	- sendGameRequest:
	ゲーム固有のメッセージを受信者に送信します。詳細...
(NSInteger)	- sendGameRequest:playerID:
	ゲーム固有のメッセージを受信者に送信します。詳細...
(void)	- sendGameMessage:
	ゲーム固有のメッセージを受信者に送信します。詳細...
(void)	- sendGameMessage:playerID:
	ゲーム固有のメッセージを受信者に送信します。詳細...
(instancetype)	- initWithNamespace:
	指定イニシャライザ。詳細...
(void)	- didReceiveTextMessage:
	このチャンネルでテキスト メッセージを受信したときに呼び出されます。詳細...
(BOOL)	- sendTextMessage:
	このチャンネルでテキスト メッセージを送信します。詳細...
(BOOL)	- sendTextMessage:error:
	このチャンネルでテキスト メッセージを送信します。詳細...
(NSInteger)	- generateRequestID
	新しいメッセージのリクエスト ID を生成します。詳細...
(NSNumber *__nullable)	- generateRequestNumber
	generateRequestID の結果を NSNumber でラップするコンビニエンス メソッド。詳細...
(void)	- didConnect
	このチャンネルが接続されたときに呼び出されます。このチャンネルを介して Cast デバイスとメッセージを交換できることを示します。詳細...
(void)	- didDisconnect
	このチャンネルが切断されたときに呼び出されます。このチャンネルを介して Cast デバイスとメッセージを交換できなくなったことを示します。詳細...

プロパティの概要
id< GCKGameManagerChannelDelegate >	delegate
	GCKGameManagerChannel から通知を受け取るためのデリゲート。詳細...
GCKGameManagerState *	currentState
	ゲーム マネージャーの現在の状態。詳細...
NSString *	lastUsedPlayerID
	このセッションで使用された最後の操作可能なプレーヤー ID。詳細...
BOOL	isInitialConnectionEstablished
	このチャンネルがレシーバーのゲーム マネージャーに接続され、操作できる状態かどうか。詳細...
NSString *	protocolNamespace
	チャンネルの Namespace。詳細...
BOOL	isConnected
	このチャンネルが現在接続されているかどうかを示すフラグ。詳細...
GCKDeviceManager *	deviceManager
	このチャンネルが登録されているデバイス マネージャー（存在する場合）。詳細...

メソッドの詳細

- (instancetype) initWithSessionID:

(NSString *)

castSessionID

指定イニシャライザ。

受信者のゲーム マネージャーに自動的に接続します。

Parameters

castSessionID

The Session ID corresponding to the currently connected Game Manager.

- (instancetype) init

デフォルトのイニシャライザは使用できません。

GCKCastChannel を実装します。

- (NSInteger) sendPlayerAvailableRequest:

(id __nullable)

extraData

受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateAvailable 状態にします。

そのプレーヤーに対して有効なトランジションでない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。最後に使用されたプレーヤーがない場合、このリクエストに対するレスポンスがレシーバーから返されるときに、新しいプレーヤーが登録され、そのプレーヤー ID が最後に使用されたプレーヤー ID として設定されます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連情報

lastUsedPlayerID

Parameters

extraData

Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

戻り値

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

- (NSInteger) sendPlayerAvailableRequest:		(id __nullable)	extraData
playerID:		(NSString *)	playerID

プレーヤーを GCKPlayerStateAvailable 状態にするようレシーバーにリクエストを送信します。

そのプレーヤーに対して有効なトランジションでない場合、GCKGameManagerChannelDelegate でエラーがトリガーされます。プレーヤー ID が nil の場合、新しいプレーヤーが登録され、受信側がこのリクエストに応答するときに、そのプレーヤー ID が最後に使用されたプレーヤー ID として設定されます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData	Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerID	The player ID of the player whose state is to be changed.

戻り値

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

- (NSInteger) sendPlayerReadyRequest:

(id __nullable)

extraData

受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateReady 状態にします。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連情報

lastUsedPlayerID

Parameters

extraData

Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

戻り値

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

- (NSInteger) sendPlayerReadyRequest:		(id __nullable)	extraData
playerID:		(NSString *)	playerID

プレーヤーを GCKPlayerStateReady 状態にするようレシーバーにリクエストを送信します。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData	Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerID	The player ID of the player to change the state.

戻り値

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

- (NSInteger) sendPlayerPlayingRequest:

(id __nullable)

extraData

受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStatePlaying 状態にします。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連情報

lastUsedPlayerID

Parameters

extraData

Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

戻り値

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

- (NSInteger) sendPlayerPlayingRequest:		(id __nullable)	extraData
playerID:		(NSString *)	playerID

プレーヤーを GCKPlayerStatePlaying 状態にするようレシーバーにリクエストを送信します。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData	Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerID	The player ID of the player to change the state.

戻り値

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

- (NSInteger) sendPlayerIdleRequest:

(id __nullable)

extraData

受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateIdle 状態にします。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信側のゲーム マネージャーにまだ接続されていない場合に、GCKGameManagerChannel::gameManagerChannel:requestDidFailWithID:error: デリゲート コールバックにメッセージを送信します。

関連情報

lastUsedPlayerID

Parameters

extraData

Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

戻り値

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

- (NSInteger) sendPlayerIdleRequest:		(id __nullable)	extraData
playerID:		(NSString *)	playerID

プレーヤーを GCKPlayerStateIdle 状態にするようレシーバーにリクエストを送信します。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData	Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerID	The player ID of the player to change the state.

戻り値

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

- (NSInteger) sendPlayerQuitRequest:

(id __nullable)

extraData

受信側にリクエストを送信して、この送信側で最後に使用されたプレーヤーを GCKPlayerStateQuit 状態にします。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

関連情報

lastUsedPlayerID

Parameters

extraData

Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

戻り値

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

- (NSInteger) sendPlayerQuitRequest:		(id __nullable)	extraData
playerID:		(NSString *)	playerID

プレーヤーを GCKPlayerStateQuit 状態にするようレシーバーにリクエストを送信します。

そのプレーヤーに対して有効な遷移でない場合や、最後に使用されたプレーヤー ID がない場合は、GCKGameManagerChannelDelegate でエラーがトリガーされます。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) はデリゲート コールバックをメッセージします。

Parameters

extraData	Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerID	The player ID of the player to change the state.

戻り値

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

- (NSInteger) sendGameRequest:

(id __nullable)

extraData

ゲーム固有のメッセージを受信者に送信します。

メッセージの内容は完全にアプリケーション次第です。メッセージは lastUsedPlayerID から送信されます。受信者は GCKGameManagerChannelDelegate を介してこの送信者にレスポンスを返送します。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信側の GameManager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData

Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

戻り値

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

- (NSInteger) sendGameRequest:		(id __nullable)	extraData
playerID:		(NSString *)	playerID

ゲーム固有のメッセージを受信者に送信します。

メッセージの内容は完全にアプリケーション次第です。メッセージは playerID から送信されます。playerID が nil の場合、lastUsedPlayerID が使用されます。受信者は GCKGameManagerChannelDelegate を介してこの送信者にレスポンスを返送します。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData	Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerID	The id of the controllable player sending this message.

戻り値

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

- (void) sendGameMessage:

(id __nullable)

extraData

ゲーム固有のメッセージを受信者に送信します。

メッセージの内容は完全にアプリケーション次第です。メッセージは lastUsedPlayerID から送信されます。これは、メッセージが送信されたことを保証するものではなく、受信者がこの送信者にレスポンスを返さない fire-and-forget メソッドです。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData

Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

- (void) sendGameMessage:		(id __nullable)	extraData
playerID:		(NSString *)	playerID

ゲーム固有のメッセージを受信者に送信します。

メッセージの内容は完全にアプリケーション次第です。メッセージは、指定されたローカル プレーヤー ID から送信されます。これは、メッセージが送信される保証がなく、受信者がこの送信者にレスポンスを返さない fire and forget メソッドです。このメソッドは、gameManagerChannelDidConnect: (GCKGameManagerChannelDelegate-p) デリゲート コールバックがメッセージされた後にのみ呼び出す必要があります。GCKGameManagerChannel が受信者の Game Manager にまだ接続されていない場合、gameManagerChannel:requestDidFailWithID:error: (GCKGameManagerChannelDelegate-p) デリゲート コールバックにメッセージを送信します。

Parameters

extraData	Custom application-specific data to pass along with the request. Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.
playerID	The ID of the controllable player sending this message.

- (instancetype) initWithNamespace:

(NSString *)

protocolNamespace

指定イニシャライザ。

指定された名前空間を使用して新しい GCKCastChannel を構築します。

Parameters

protocolNamespace

The namespace.

GCKGenericChannel で実装されています。

- (void) didReceiveTextMessage:

(NSString *)

message

このチャンネルでテキスト メッセージを受信したときに呼び出されます。

デフォルトの実装は no-op です。

Parameters

message

The message.

- (BOOL) sendTextMessage:

(NSString *)

message

このチャンネルでテキスト メッセージを送信します。

Parameters

message

The message.

戻り値

成功した場合は

YES、メッセージを送信できなかった場合は NO（チャンネルが接続されていない、または送信バッファが現在いっぱいであるため）。

Deprecated:

詳細なエラー情報を提供する sendTextMessage:error: を使用します。

- (BOOL) sendTextMessage:		(NSString *)	message
error:		(GCKError *__nullable *__nullable)	error

このチャンネルでテキスト メッセージを送信します。

Parameters

message	The message.
error	A pointer at which to store the error result. May be nil.

戻り値

成功した場合は

YES、メッセージを送信できなかった場合は NO。

- (NSInteger) generateRequestID

新しいメッセージのリクエスト ID を生成します。

戻り値

生成された ID。チャンネルが現在接続されていない場合は kGCKInvalidRequestID。

- (NSNumber * __nullable) generateRequestNumber

generateRequestID の結果を NSNumber でラップするコンビニエンス メソッド。

戻り値

生成された ID。チャンネルが現在接続されていない場合は nil。

- (void) didConnect

このチャンネルが接続されたときに呼び出されます。このチャンネルを介して Cast デバイスとメッセージを交換できることを示します。

デフォルトの実装は no-op です。

- (void) didDisconnect

このチャンネルが切断されたときに呼び出されます。このチャンネルを介して Cast デバイスとメッセージを交換できなくなったことを示します。

デフォルトの実装は no-op です。

プロパティの詳細

- (id<GCKGameManagerChannelDelegate>) delegate

readwritenonatomicweak

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

- (GCKGameManagerState*) currentState

readnonatomicstrong

ゲーム マネージャーの現在の状態。

- (NSString*) lastUsedPlayerID

readnonatomiccopy

このセッションで使用された最後の操作可能なプレーヤー ID。

レシーバに制御可能なプレーヤーが設定されていない場合は、nil になります。

関連情報

- sendPlayerAvailableRequest:

- (BOOL) isInitialConnectionEstablished

readnonatomicassign

このチャンネルがレシーバーのゲーム マネージャーに接続され、操作できる状態かどうか。

このメソッドは、このチャンネルの作成時点から NO を返します。

戻り値

このチャンネルがレシーバーのゲーム マネージャーに接続され、操作の準備ができている場合は

YES、それ以外の場合は NO。

- (NSString*) protocolNamespace

readnonatomiccopyinherited

チャンネルの Namespace。

- (BOOL) isConnected

readnonatomicassigninherited

このチャンネルが現在接続されているかどうかを示すフラグ。

- (GCKDeviceManager*) deviceManager

readnonatomicweakinherited

このチャンネルが登録されているデバイス マネージャー（存在する場合）。

Deprecated:

このチャンネルが非推奨の GCKDeviceManager クラスに登録されていない場合、これは nil になります。