GCKMediaControlChannel 类

GCKMediaControlChannel 类参考

概览

用于媒体控制操作的 GCKCastChannel 子类。

任何适用于当前活跃流(播放、暂停、跳转、停止等)的操作都需要有效的(即非 nil)媒体状态,否则它们将返回 kGCKInvalidRequestID 且不会发送请求。在通道连接后,系统会自动请求媒体状态,在成功完成加载后会包含媒体状态,并且可以随时更新。媒体状态也可随时变为 nil;例如,如果频道暂时断开连接,就会出现这种情况。使用此通道时,应通过 mediaControlChannelDidUpdateStatus: (GCKMediaControlChannelDelegate-p) 回调监控媒体状态变化,只有在媒体状态为 nil 时,才能调用对流执行操作的方法。

如果请求成功启动,相应的方法会返回分配给该请求的请求 ID。如果请求失败,该方法会返回 kGCKInvalidRequestID,并设置 lastError 属性以指明失败的原因。如果请求成功启动但最终失败,系统会调用 mediaControlChannel:requestDidFailWithID:error: (GCKMediaControlChannelDelegate-p) 回调来指示失败。

如需了解委托协议,请参阅 GCKMediaControlChannelDelegate

Deprecated:
使用 GCKCastSessionGCKRemoteMediaClient 属性来控制媒体播放。

继承 GCKCastChannel

实例方法摘要

(instancetype) - init
 指定的初始化程序。更多...
 
(NSInteger) - loadMedia:
 加载并开始播放新媒体项。更多...
 
(NSInteger) - loadMedia:autoplay:
 加载新的媒体项并选择播放。更多...
 
(NSInteger) - loadMedia:autoplay:playPosition:
 加载新的媒体项并选择播放。更多...
 
(NSInteger) - loadMedia:autoplay:playPosition:customData:
 加载新的媒体项并选择播放。更多...
 
(NSInteger) - loadMedia:autoplay:playPosition:activeTrackIDs:
 加载新的媒体项并选择播放。更多...
 
(NSInteger) - loadMedia:autoplay:playPosition:activeTrackIDs:customData:
 加载新的媒体项并选择播放。更多...
 
(NSInteger) - setActiveTrackIDs:
 设置有效曲目。更多...
 
(NSInteger) - setTextTrackStyle:
 设置文本轨道样式。更多...
 
(NSInteger) - pause
 暂停播放当前媒体项。更多...
 
(NSInteger) - pauseWithCustomData:
 暂停播放当前媒体项。更多...
 
(NSInteger) - stop
 停止播放当前媒体项。更多...
 
(NSInteger) - stopWithCustomData:
 停止播放当前媒体项。更多...
 
(NSInteger) - play
 开始(或继续)播放当前媒体项。更多...
 
(NSInteger) - playWithCustomData:
 开始(或继续)播放当前媒体项。更多...
 
(NSInteger) - seekToTimeInterval:
 跳转到当前媒体项内的新位置。更多...
 
(NSInteger) - seekToTimeInterval:resumeState:
 跳转到当前媒体项内的新位置。更多...
 
(NSInteger) - seekToTimeInterval:resumeState:customData:
 跳转到当前媒体项内的新位置。更多...
 
(NSInteger) - queueLoadItems:startIndex:repeatMode:
 加载新的媒体项队列,并可根据需要开始播放。更多...
 
(NSInteger) - queueLoadItems:startIndex:repeatMode:customData:
 加载新的媒体项队列,并可根据需要开始播放。更多...
 
(NSInteger) - queueLoadItems:startIndex:playPosition:repeatMode:customData:
 加载新的媒体项队列,并可根据需要开始播放。更多...
 
(NSInteger) - queueInsertItems:beforeItemWithID:
 用于将新媒体项列表插入队列。更多...
 
(NSInteger) - queueInsertItems:beforeItemWithID:customData:
 用于将新媒体项列表插入队列。更多...
 
(NSInteger) - queueInsertItem:beforeItemWithID:
 一种将单个项插入队列的便捷方法。更多...
 
(NSInteger) - queueInsertAndPlayItem:beforeItemWithID:
 一种将单个项插入队列并使其成为当前项的便捷方法。更多...
 
(NSInteger) - queueInsertAndPlayItem:beforeItemWithID:playPosition:customData:
 一种将单个项插入队列并使其成为当前项的便捷方法。更多...
 
(NSInteger) - queueUpdateItems:
 更新队列。更多...
 
(NSInteger) - queueUpdateItems:customData:
 更新队列。更多...
 
(NSInteger) - queueRemoveItemsWithIDs:
 从队列中移除媒体项列表。更多...
 
(NSInteger) - queueRemoveItemsWithIDs:customData:
 从队列中移除媒体项列表。更多...
 
(NSInteger) - queueRemoveItemWithID:
 一种从队列中删除单项内容的便捷方法。更多...
 
(NSInteger) - queueReorderItemsWithIDs:insertBeforeItemWithID:
 对队列中的媒体项列表进行重新排序。更多...
 
(NSInteger) - queueReorderItemsWithIDs:insertBeforeItemWithID:customData:
 对队列中的媒体项列表进行重新排序。更多...
 
(NSInteger) - queueMoveItemWithID:beforeItemWithID:
 一种用于移动队列中单项内容的便捷方法。更多...
 
(NSInteger) - queueJumpToItemWithID:
 跳至队列中具有指定 ID 的内容。更多...
 
(NSInteger) - queueJumpToItemWithID:customData:
 跳至队列中具有指定 ID 的内容。更多...
 
(NSInteger) - queueJumpToItemWithID:playPosition:customData:
 跳至队列中具有指定 ID 的内容。更多...
 
(NSInteger) - queueNextItem
 移至队列中的下一项。更多...
 
(NSInteger) - queuePreviousItem
 移至队列中的上一项。更多...
 
(NSInteger) - queueSetRepeatMode:
 设置队列重复模式。更多...
 
(NSInteger) - setStreamVolume:
 设置流音量。更多...
 
(NSInteger) - setStreamVolume:customData:
 设置流音量。更多...
 
(NSInteger) - setStreamMuted:
 设置流是否静音。更多...
 
(NSInteger) - setStreamMuted:customData:
 设置流是否静音。更多...
 
(NSInteger) - requestStatus
 从接收器请求更新后的媒体状态信息。更多...
 
(NSTimeInterval) - approximateStreamPosition
 返回上次更新的信息流位置,根据上次接收的信息流信息和自更新以来所用时间。更多...
 
(BOOL) - cancelRequestWithID:
 取消正在处理的请求。更多...
 
(instancetype) - initWithNamespace:
 指定的初始化程序。更多...
 
(void) - didReceiveTextMessage:
 在此频道上收到短信时调用。更多...
 
(BOOL) - sendTextMessage:
 在此频道上发送短信。更多...
 
(BOOL) - sendTextMessage:error:
 在此频道上发送短信。更多...
 
(NSInteger) - generateRequestID
 为新消息生成请求 ID。更多...
 
(NSNumber *__nullable) - generateRequestNumber
 一种将 generateRequestID 结果封装在 NSNumber 中的便捷方法。更多...
 
(void) - didConnect
 在连接此通道时调用,表示现在可以通过此通道与投放设备交换消息。更多...
 
(void) - didDisconnect
 当此通道断开连接时调用,这表示无法再通过此通道与投放设备交换消息。更多...
 

属性摘要

GCKMediaStatusmediaStatus
 当前加载的媒体的媒体状态(如有);否则为 nil更多...
 
NSTimeInterval timeSinceLastMediaStatusUpdate
 自上次收到媒体状态更新以来经过的时间。更多...
 
GCKErrorlastError
 上一个请求的错误详情(如果有),如果最后一个请求成功,则返回 nil更多...
 
id< GCKMediaControlChannelDelegatedelegate
 用于接收与渠道状态变化有关的通知的代理。更多...
 
NSString * protocolNamespace
 频道的命名空间。更多...
 
BOOL isConnected
 一个标记,指示此频道目前是否已连接。更多...
 
GCKDeviceManagerdeviceManager
 已注册此渠道的设备管理器(如果有)。更多...
 

方法详细信息

- (instancetype) init

指定的初始化程序。

实现了 GCKCastChannel

- (NSInteger) loadMedia: (GCKMediaInformation *)  mediaInfo

加载并开始播放新媒体项。

Parameters
mediaInfoAn object describing the media item to load.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) loadMedia: (GCKMediaInformation *)  mediaInfo
autoplay: (BOOL)  autoplay 

加载新的媒体项并选择播放。

Parameters
mediaInfoAn object describing the media item to load.
autoplayWhether playback should start immediately.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) loadMedia: (GCKMediaInformation *)  mediaInfo
autoplay: (BOOL)  autoplay
playPosition: (NSTimeInterval)  playPosition 

加载新的媒体项并选择播放。

Parameters
mediaInfoAn object describing the media item to load.
autoplayWhether playback should start immediately.
playPositionThe initial playback position.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) loadMedia: (GCKMediaInformation *)  mediaInfo
autoplay: (BOOL)  autoplay
playPosition: (NSTimeInterval)  playPosition
customData: (id __nullable)  customData 

加载新的媒体项并选择播放。

Parameters
mediaInfoAn object describing the media item to load.
autoplayWhether playback should start immediately.
playPositionThe initial playback position.
customDataCustom 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) loadMedia: (GCKMediaInformation *)  mediaInfo
autoplay: (BOOL)  autoplay
playPosition: (NSTimeInterval)  playPosition
activeTrackIDs: (NSArray< NSNumber * > *__nullable)  activeTrackIDs 

加载新的媒体项并选择播放。

Parameters
mediaInfoAn object describing the media item to load.
autoplayWhether playback should start immediately.
playPositionThe initial playback position.
activeTrackIDsAn array of integers specifying the active tracks. May be nil.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) loadMedia: (GCKMediaInformation *)  mediaInfo
autoplay: (BOOL)  autoplay
playPosition: (NSTimeInterval)  playPosition
activeTrackIDs: (NSArray< NSNumber * > *__nullable)  activeTrackIDs
customData: (id __nullable)  customData 

加载新的媒体项并选择播放。

Parameters
mediaInfoAn object describing the media item to load.
autoplayWhether playback should start immediately.
playPositionThe initial playback position.
activeTrackIDsAn array of integers specifying the active tracks. May be nil.
customDataCustom 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) setActiveTrackIDs: (NSArray< NSNumber * > *__nullable)  activeTrackIDs

设置有效曲目。

如果没有当前媒体状态,则请求将失败。

Parameters
activeTrackIDsAn array of integers specifying the active tracks.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID。可以是 nil 或空数组,用于将有效曲目设置为空列表。
- (NSInteger) setTextTrackStyle: (GCKMediaTextTrackStyle *__nullable)  textTrackStyle

设置文本轨道样式。

如果没有当前媒体状态,则请求将失败。

Parameters
textTrackStyleThe text track style. The style will not be changed if this is nil.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) pause

暂停播放当前媒体项。

如果没有当前媒体状态,则请求将失败。

返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) pauseWithCustomData: (id __nullable)  customData

暂停播放当前媒体项。

如果没有当前媒体状态,则请求将失败。

Parameters
customDataCustom 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) stop

停止播放当前媒体项。

如果没有当前媒体状态,则请求将失败。如果当前已加载队列,则会将其移除。

返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) stopWithCustomData: (id __nullable)  customData

停止播放当前媒体项。

如果没有当前媒体状态,则请求将失败。如果当前已加载队列,则会将其移除。

Parameters
customDataCustom 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) play

开始(或继续)播放当前媒体项。

播放始终从数据流的开头开始。如果没有当前媒体状态,则请求将失败。

返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) playWithCustomData: (id __nullable)  customData

开始(或继续)播放当前媒体项。

播放始终从数据流的开头开始。如果没有当前媒体状态,则请求将失败。

Parameters
customDataCustom 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) seekToTimeInterval: (NSTimeInterval)  position

跳转到当前媒体项内的新位置。

如果没有当前媒体状态,则请求将失败。

Parameters
positionThe new position from the beginning of the stream.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) seekToTimeInterval: (NSTimeInterval)  position
resumeState: (GCKMediaControlChannelResumeState resumeState 

跳转到当前媒体项内的新位置。

如果没有当前媒体状态,则请求将失败。

Parameters
positionThe new position interval from the beginning of the stream.
resumeStateThe action to take after the seek operation has finished.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) seekToTimeInterval: (NSTimeInterval)  position
resumeState: (GCKMediaControlChannelResumeState resumeState
customData: (id __nullable)  customData 

跳转到当前媒体项内的新位置。

如果没有当前媒体状态,则请求将失败。

Parameters
positionThe new position from the beginning of the stream.
resumeStateThe action to take after the seek operation has finished.
customDataCustom 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) queueLoadItems: (NSArray< GCKMediaQueueItem * > *)  queueItems
startIndex: (NSUInteger)  startIndex
repeatMode: (GCKMediaRepeatMode repeatMode 

加载新的媒体项队列,并可根据需要开始播放。

Parameters
queueItemsAn array of GCKMediaQueueItem instances to load. Must not be nil or empty.
startIndexThe index of the item in the items array that should be played first.
repeatModeThe repeat mode for playing the queue.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueLoadItems: (NSArray< GCKMediaQueueItem * > *)  queueItems
startIndex: (NSUInteger)  startIndex
repeatMode: (GCKMediaRepeatMode repeatMode
customData: (id __nullable)  customData 

加载新的媒体项队列,并可根据需要开始播放。

Parameters
queueItemsAn array of GCKMediaQueueItem instances to load. Must not be nil or empty.
startIndexThe index of the item in the items array that should be played first.
repeatModeThe repeat mode for playing the queue.
customDataCustom 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) queueLoadItems: (NSArray< GCKMediaQueueItem * > *)  queueItems
startIndex: (NSUInteger)  startIndex
playPosition: (NSTimeInterval)  playPosition
repeatMode: (GCKMediaRepeatMode repeatMode
customData: (id __nullable)  customData 

加载新的媒体项队列,并可根据需要开始播放。

Parameters
queueItemsAn array of GCKMediaQueueItem instances to load. Must not be nil or empty.
startIndexThe index of the item in the items array that should be played first.
playPositionThe initial playback position for the item when it is first played, relative to the beginning of the stream. This value is ignored when the same item is played again, for example when the queue repeats, or the item is later jumped to. In those cases the item's startTime is used.
repeatModeThe repeat mode for playing the queue.
customDataCustom 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) queueInsertItems: (NSArray< GCKMediaQueueItem * > *)  queueItems
beforeItemWithID: (NSUInteger)  beforeItemID 

用于将新媒体项列表插入队列。

Parameters
queueItemsAn array of GCKMediaQueueItem instances to insert. Must not be nil or empty.
beforeItemIDThe ID of the item that will be located immediately after the inserted list. If the value is kGCKMediaQueueInvalidItemID, the inserted list will be appended to the end of the queue.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueInsertItems: (NSArray< GCKMediaQueueItem * > *)  queueItems
beforeItemWithID: (NSUInteger)  beforeItemID
customData: (id __nullable)  customData 

用于将新媒体项列表插入队列。

Parameters
queueItemsAn array of GCKMediaQueueItem instances to insert. Must not be nil or empty.
beforeItemIDID of the item that will be located immediately after the inserted list. If the value is kGCKMediaQueueInvalidItemID, the inserted list will be appended to the end of the queue.
customDataCustom 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) queueInsertItem: (GCKMediaQueueItem *)  item
beforeItemWithID: (NSUInteger)  beforeItemID 

一种将单个项插入队列的便捷方法。

Parameters
itemThe item to insert.
beforeItemIDThe ID of the item that will be located immediately after the inserted item. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the inserted item will be appended to the end of the queue.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueInsertAndPlayItem: (GCKMediaQueueItem *)  item
beforeItemWithID: (NSUInteger)  beforeItemID 

一种将单个项插入队列并使其成为当前项的便捷方法。

Parameters
itemThe item to insert.
beforeItemIDThe ID of the item that will be located immediately after the inserted item. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the inserted item will be appended to the end of the queue.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueInsertAndPlayItem: (GCKMediaQueueItem *)  item
beforeItemWithID: (NSUInteger)  beforeItemID
playPosition: (NSTimeInterval)  playPosition
customData: (id __nullable)  customData 

一种将单个项插入队列并使其成为当前项的便捷方法。

Parameters
itemThe item to insert.
beforeItemIDThe ID of the item that will be located immediately after the inserted item. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the inserted item will be appended to the end of the queue.
playPositionThe initial playback position for the item when it is first played, relative to the beginning of the stream. This value is ignored when the same item is played again, for example when the queue repeats, or the item is later jumped to. In those cases the item's startTime is used.
customDataCustom 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) queueUpdateItems: (NSArray< GCKMediaQueueItem * > *)  queueItems

更新队列。

Parameters
queueItemsThe list of updated items.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueUpdateItems: (NSArray< GCKMediaQueueItem * > *)  queueItems
customData: (id __nullable)  customData 

更新队列。

Parameters
queueItemsThe list of updated items.
customDataCustom 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) queueRemoveItemsWithIDs: (NSArray< NSNumber * > *)  itemIDs

从队列中移除媒体项列表。

如果队列因此而清空,则当前的媒体会话将被终止。

Parameters
itemIDsAn array of media item IDs identifying the items to remove. Must not be nil or empty.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueRemoveItemsWithIDs: (NSArray< NSNumber * > *)  itemIDs
customData: (id __nullable)  customData 

从队列中移除媒体项列表。

如果队列因此而清空,则当前的媒体会话将被终止。

Parameters
itemIDsAn array of media item IDs identifying the items to remove. Must not be nil or empty.
customDataCustom 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) queueRemoveItemWithID: (NSUInteger)  itemID

一种从队列中删除单项内容的便捷方法。

Parameters
itemIDThe ID of the item to remove.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueReorderItemsWithIDs: (NSArray< NSNumber * > *)  queueItemIDs
insertBeforeItemWithID: (NSUInteger)  beforeItemID 

对队列中的媒体项列表进行重新排序。

Parameters
queueItemIDsAn array of media item IDs identifying the items to reorder. Must not be nil or empty.
beforeItemIDID of the item that will be located immediately after the reordered list. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the reordered list will be appended at the end of the queue.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueReorderItemsWithIDs: (NSArray< NSNumber * > *)  queueItemIDs
insertBeforeItemWithID: (NSUInteger)  beforeItemID
customData: (id __nullable)  customData 

对队列中的媒体项列表进行重新排序。

Parameters
queueItemIDsAn array of media item IDs identifying the items to reorder. Must not be nil or empty.
beforeItemIDThe ID of the item that will be located immediately after the reordered list. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the reordered list will be moved to the end of the queue.
customDataCustom 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) queueMoveItemWithID: (NSUInteger)  itemID
beforeItemWithID: (NSUInteger)  beforeItemID 

一种用于移动队列中单项内容的便捷方法。

Parameters
itemIDThe ID of the item to move.
beforeItemIDThe ID of the item that will be located immediately after the reordered list. If the value is kGCKMediaQueueInvalidItemID, or does not refer to any item currently in the queue, the item will be moved to the end of the queue.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) queueJumpToItemWithID: (NSUInteger)  itemID

跳至队列中具有指定 ID 的内容。

Parameters
itemIDThe ID of the item to jump to.
返回
此请求的请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) queueJumpToItemWithID: (NSUInteger)  itemID
customData: (id __nullable)  customData 

跳至队列中具有指定 ID 的内容。

Parameters
itemIDThe ID of the item to jump to.
customDataCustom 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) queueJumpToItemWithID: (NSUInteger)  itemID
playPosition: (NSTimeInterval)  playPosition
customData: (id __nullable)  customData 

跳至队列中具有指定 ID 的内容。

Parameters
itemIDThe ID of the item to jump to.
playPositionThe initial playback position for the item when it is first played, relative to the beginning of the stream. This value is ignored when the same item is played again, for example when the queue repeats, or the item is later jumped to. In those cases the item's startTime is used.
customDataCustom 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) queueNextItem

移至队列中的下一项。

返回
此请求的请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) queuePreviousItem

移至队列中的上一项。

返回
此请求的请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) queueSetRepeatMode: (GCKMediaRepeatMode repeatMode

设置队列重复模式。

Parameters
repeatModeThe new repeat mode.
返回
此请求的请求 ID,如果消息无法发送或任何参数无效,则为 kGCKInvalidRequestID
- (NSInteger) setStreamVolume: (float)  volume

设置流音量。

如果没有当前媒体会话,请求将失败。

Parameters
volumeThe new volume, in the range [0.0 - 1.0].
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) setStreamVolume: (float)  volume
customData: (id __nullable)  customData 

设置流音量。

如果没有当前媒体会话,请求将失败。

Parameters
volumeThe new volume, in the range [0.0 - 1.0].
customDataCustom 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) setStreamMuted: (BOOL)  muted

设置流是否静音。

如果没有当前媒体会话,请求将失败。

Parameters
mutedWhether the stream should be muted or unmuted.
返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSInteger) setStreamMuted: (BOOL)  muted
customData: (id __nullable)  customData 

设置流是否静音。

如果没有当前媒体会话,请求将失败。

Parameters
mutedWhether the stream should be muted or unmuted.
customDataCustom 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) requestStatus

从接收器请求更新后的媒体状态信息。

返回
请求 ID,如果消息无法发送,则为 kGCKInvalidRequestID
- (NSTimeInterval) approximateStreamPosition

返回上次更新的信息流位置,根据上次接收的信息流信息和自更新以来所用时间。

如果频道未连接或当前未加载任何媒体,则返回 0。

- (BOOL) cancelRequestWithID: (NSInteger)  requestID

取消正在处理的请求。

取消请求并不会阻止其执行;它只是表明发出调用的应用不再对请求的结果感兴趣,因此系统将清除与请求跟踪相关的所有状态。

Parameters
requestIDThe ID of the request to cancel.
返回
如果请求被取消,则返回 YES;如果未使用指定 ID 跟踪请求,则返回 NO
- (instancetype) initWithNamespace: (NSString *)  protocolNamespace

指定的初始化程序。

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

Parameters
protocolNamespaceThe namespace.

GCKGenericChannel 中实现。

- (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

当此通道断开连接时调用,这表示无法再通过此通道与投放设备交换消息。

默认实现是一个空操作。

属性详情

- (GCKMediaStatus*) mediaStatus
readnonatomicstrong

当前加载的媒体的媒体状态(如有);否则为 nil

- (NSTimeInterval) timeSinceLastMediaStatusUpdate
readnonatomicassign

自上次收到媒体状态更新以来经过的时间。

如果状态请求当前正在执行,此值将为 0。

- (GCKError*) lastError
readnonatomiccopy

上一个请求的错误详情(如果有),如果最后一个请求成功,则返回 nil

- (id<GCKMediaControlChannelDelegate>) delegate
readwritenonatomicweak

用于接收与渠道状态变化有关的通知的代理。

- (NSString*) protocolNamespace
readnonatomiccopyinherited

频道的命名空间。

- (BOOL) isConnected
readnonatomicassigninherited

一个标记,指示此频道目前是否已连接。

- (GCKDeviceManager*) deviceManager
readnonatomicweakinherited

已注册此渠道的设备管理器(如果有)。

Deprecated:
如果此频道未在已弃用的 GCKDeviceManager 类中注册,此 ID 将为 nil