GCKCastChannel 类

GCKCastChannel 类参考文档

概览

用于在 Cast 发送者和 Cast 接收方之间交换消息的虚拟通信信道。

每个频道都使用唯一的命名空间进行标记,因此一个频道可以在一个发送者和一名接收者之间通过复用进行多路复用。

渠道必须先向 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

指定的初始化程序。

使用指定命名空间构造新的 GCKCastChannel

Parameters
protocolNamespaceThe namespace.

GCKGenericChannel 中实现。

- (instancetype) init

默认初始化程序不可用。

GCKMediaControlChannelGCKGameManagerChannel 中实现。

- (void) didReceiveTextMessage: (NSString *)  message

在此频道上收到短信时调用。

默认实现是一个空操作。

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

在此频道上发送短信。

Parameters
messageThe message.
返回
成功时为 YES,或者如果无法发送消息(由于通道未连接,或者发送缓冲区目前已满)。
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;如果消息无法发送,则返回 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 类中注册,此 ID 将为 nil