GCKCastChannel クラス

GCKCastChannel クラス リファレンス

概要

キャスト センダーとキャスト レシーバー間でメッセージを交換するための仮想通信チャネル。

各チャネルには固有の名前空間がタグ付けされるため、センダーとレシーバー間の単一のネットワーク接続を介して複数のチャネルが多重化される場合があります。

チャンネルを使用するには、GCKCastSession で登録する必要があります。関連付けられたセッションが確立されると、チャンネルが自動的に接続され、メッセージを送受信できるようになります。

サブクラスでは、受信メッセージを処理するために didReceiveTextMessage: (GCKCastChannel) メソッドを実装する必要があります。通常は、特定の名前空間に固有のメッセージを送信するための追加のメソッドを提供します。

NSObject を継承します。

GCKGameManagerChannelGCKGenericChannelGCKMediaControlChannel によって継承されます。

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

(instancetype) - initWithNamespace:
 指定のイニシャライザ。その他...
 
(instancetype) - init
 デフォルトのイニシャライザは使用できません。その他...
 
(void) - didReceiveTextMessage:
 このチャンネルでテキスト メッセージを受信したときに呼び出されます。その他...
 
(BOOL) - sendTextMessage:
 このチャンネルでテキスト メッセージを送信します。その他...
 
(BOOL) - sendTextMessage:error:
 このチャンネルでテキスト メッセージを送信します。その他...
 
(NSInteger) - generateRequestID
 新しいメッセージのリクエスト ID を生成します。その他...
 
(NSNumber *__nullable) - generateRequestNumber
 generateRequestID の結果を NSNumber でラップする便利なメソッド。その他...
 
(void) - didConnect
 このチャンネルが接続されたときに呼び出され、このチャンネル経由でキャスト デバイスとメッセージを交換できるようになったことを示します。その他...
 
(void) - didDisconnect
 このチャンネルの接続が解除されたときに呼び出されます。これは、このチャンネル経由でキャスト デバイスとメッセージを交換できないことを表します。その他...
 

プロパティの概要

NSString * protocolNamespace
 チャンネルの名前空間。その他...
 
BOOL isConnected
 このチャンネルが現在接続されているかどうかを示すフラグ。その他...
 
GCKDeviceManagerdeviceManager
 このチャンネルが登録されているデバイス マネージャー(存在する場合)。その他...
 

メソッドの詳細

- (instancetype) initWithNamespace: (NSString *)  protocolNamespace

指定のイニシャライザ。

指定された Namespace で新しい GCKCastChannel を作成します。

Parameters
protocolNamespaceThe namespace.

GCKGenericChannel に実装されました。

- (instancetype) init

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

GCKMediaControlChannelGCKGameManagerChannel に実装されました。

- (void) didReceiveTextMessage: (NSString *)  message

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

デフォルトの実装では何も起こりません。

Parameters
messageThe message.
- (BOOL) sendTextMessage: (NSString *)  message

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

Parameters
messageThe message.
戻り値
成功の場合は YES、メッセージを送信できなかった場合(チャネルが接続されていないか、送信バッファが現時点でいっぱいになっているため)は NO
Deprecated:
sendTextMessage:error: を使用して、詳細なエラー情報を提供します。
- (BOOL) sendTextMessage: (NSString *)  message
error: (GCKError *__nullable *__nullable)  error 

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

Parameters
messageThe message.
errorA pointer at which to store the error result. May be nil.
戻り値
YES(成功した場合は YES、メッセージを送信できなかった場合は NO)。
- (NSInteger) generateRequestID

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

戻り値
生成された ID、またはチャンネルが現在接続されていない場合は kGCKInvalidRequestID
- (NSNumber * __nullable) generateRequestNumber

generateRequestID の結果を NSNumber でラップする便利なメソッド。

戻り値
生成された ID、またはチャンネルが現在接続されていない場合は nil
- (void) didConnect

このチャンネルが接続されたときに呼び出され、このチャンネル経由でキャスト デバイスとメッセージを交換できるようになったことを示します。

デフォルトの実装では何も起こりません。

- (void) didDisconnect

このチャンネルの接続が解除されたときに呼び出されます。これは、このチャンネル経由でキャスト デバイスとメッセージを交換できないことを表します。

デフォルトの実装では何も起こりません。

物件の詳細

- (NSString*) protocolNamespace
readnonatomiccopy

チャンネルの名前空間。

- (BOOL) isConnected
readnonatomicassign

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

- (GCKDeviceManager*) deviceManager
readnonatomicweak

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

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