GCKMediaStatus 类

实例方法 | 公共属性 | 属性
GCKMediaStatus 类参考

概览

用于存储某些媒体的状态信息的类。

继承 NSObject。实现 <NSCopy>。

实例方法摘要

(instancetype) - initWithSessionID:mediaInformation:
 指定的初始化程序。更多...
 
(BOOL) - isMediaCommandSupported:
 检查流是否支持给定的控制命令。更多...
 
(nullable GCKMediaQueueItem *) - queueItemAtIndex:
 返回播放队列中指定索引处的内容。更多...
 
(nullable GCKMediaQueueItem *) - queueItemWithItemID:
 返回播放队列中具有指定项 ID 的项。更多...
 
(NSInteger) - queueIndexForItemID:
 返回播放队列中具有指定项 ID 的项的索引，如果队列中没有此项，则返回 -1。更多...
 

公共属性

const NSInteger kGCKMediaCommandPause
 一个标记（位掩码），用于表明媒体项可以暂停。更多...
 
const NSInteger kGCKMediaCommandSeek
 指明媒体项支持跳转的标记（位掩码）。更多...
 
const NSInteger kGCKMediaCommandSetVolume
 一个标记（位掩码），用于表明媒体项的音频音量可以更改。更多...
 
const NSInteger kGCKMediaCommandToggleMute
 一个标记（位掩码），用于指示媒体项的音频可以静音。更多...
 
const NSInteger kGCKMediaCommandSkipForward
 表示媒体项支持快进的标记（位掩码）。更多...
 
const NSInteger kGCKMediaCommandSkipBackward
 表示媒体项支持向后跳转的标记（位掩码）。更多...
 
const NSInteger kGCKMediaCommandQueueNext
 一个标记（位掩码），用于表明媒体项支持移至队列中的下一项。更多...
 
const NSInteger kGCKMediaCommandQueuePrevious
 一个标记（位掩码），用于表明媒体项支持移至队列中的上一项。更多...
 
const NSInteger kGCKMediaCommandQueueShuffle
 一个标记（位掩码），表示媒体项支持随机播放。更多...
 
const NSInteger kGCKMediaCommandSkipAd
 表示媒体项支持跳过广告的标记（位掩码）。更多...
 
const NSInteger kGCKMediaCommandQueueRepeatAll
 一个标记（位掩码），用于表明媒体项的队列支持无限重复。更多...
 
const NSInteger kGCKMediaCommandQueueRepeatOne
 一个标记（位掩码），表示媒体项支持无限重复。更多...
 
const NSInteger kGCKMediaCommandQueueRepeat
 一个标记（位掩码），表示媒体项及其队列支持无限重复。更多...
 
const NSInteger kGCKMediaCommandEditTracks
 一个标记（位掩码），用于表明媒体项的轨道可修改。更多...
 
const NSInteger kGCKMediaCommandSetPlaybackRate
 一个标记（位掩码），用于表明媒体项的播放速率可配置。更多...
 
const NSInteger kGCKMediaCommandLike
 一个标记（位掩码），用于表明用户可顶某个媒体项。更多...
 
const NSInteger kGCKMediaCommandDislike
 一个标记（位掩码），用于表明某项媒体项可被用户踩。更多...
 
const NSInteger kGCKMediaCommandFollow
 一个标记（位掩码），用于表明用户可跟随媒体项的创建者。更多...
 
const NSInteger kGCKMediaCommandUnfollow
 一个标记（位掩码），用于表明用户可以取消关注媒体项的创建者。更多...
 
const NSInteger kGCKMediaCommandStreamTransfer
 表示媒体内容支持流传输的标记（位掩码）。更多...
 

属性摘要

NSInteger mediaSessionID
 当前媒体会话 ID（如果有）；否则为 0。更多...
 
GCKMediaPlayerState playerState
 当前的播放器状态。更多...
 
BOOL playingAd
 指示接收方当前是否正在播放广告。更多...
 
GCKMediaPlayerIdleReason idleReason
 当前空闲原因。更多...
 
float playbackRate
 获取当前的流播放速率。更多...
 
GCKMediaInformation * mediaInformation
 此项的 GCKMediaInformation。更多...
 
NSTimeInterval streamPosition
 当前流的位置，以流开始后的 NSTimeInterval 表示。更多...
 
float volume
 音频流的音量。更多...
 
BOOL isMuted
 流的静音状态。更多...
 
GCKMediaRepeatMode queueRepeatMode
 当前队列重复模式。更多...
 
NSUInteger currentItemID
 当前队列项的 ID（如果有）。更多...
 
BOOL queueHasCurrentItem
 队列中是否有当前项。更多...
 
GCKMediaQueueItem * currentQueueItem
 当前队列项（如果有）。更多...
 
BOOL queueHasNextItem
 检查队列中当前播放项后面是否有某个项。更多...
 
GCKMediaQueueItem * nextQueueItem
 下一个队列项（如果有）。更多...
 
BOOL queueHasPreviousItem
 队列中当前播放项之前是否有一个项。更多...
 
BOOL queueHasLoadingItem
 队列中是否有正在预加载的项。更多...
 
NSUInteger preloadedItemID
 当前预加载的项的 ID（如果有）。更多...
 
NSUInteger loadingItemID
 当前正在加载的项的 ID（如果有）。更多...
 
NSArray< NSNumber * > * activeTrackIDs
 有效轨道 ID 的列表。更多...
 
GCKVideoInfo * videoInfo
 视频信息（如果有）。更多...
 
id customData
 与媒体状态相关联的任何自定义数据。更多...
 
GCKAdBreakStatus * adBreakStatus
 当前的广告播放状态。更多...
 
GCKMediaLiveSeekableRange * liveSeekableRange
 流的可搜索范围。更多...
 
GCKMediaQueueData * queueData
 媒体队列的元数据。更多...
 
NSUInteger queueItemCount
 返回播放队列中的项数。更多...
 

方法详细信息

- (instancetype) initWithSessionID: (NSInteger)  mediaSessionID
mediaInformation: (nullable GCKMediaInformation *)  mediaInformation 

指定的初始化程序。

Parameters
mediaSessionIDThe media session ID.
mediaInformationThe media information.
- (BOOL) isMediaCommandSupported: (NSInteger)  command

检查流是否支持给定的控制命令。

- (nullable GCKMediaQueueItem *) queueItemAtIndex: (NSUInteger)  index

返回播放队列中指定索引处的内容。

- (nullable GCKMediaQueueItem *) queueItemWithItemID: (NSUInteger)  itemID

返回播放队列中具有指定项 ID 的项。

- (NSInteger) queueIndexForItemID: (NSUInteger)  itemID

返回播放队列中具有指定项 ID 的项的索引，如果队列中没有此项，则返回 -1。

成员数据文档

- (const NSInteger) kGCKMediaCommandPause

一个标记（位掩码），用于表明媒体项可以暂停。

- (const NSInteger) kGCKMediaCommandSeek

指明媒体项支持跳转的标记（位掩码）。

- (const NSInteger) kGCKMediaCommandSetVolume

一个标记（位掩码），用于表明媒体项的音频音量可以更改。

- (const NSInteger) kGCKMediaCommandToggleMute

一个标记（位掩码），用于指示媒体项的音频可以静音。

- (const NSInteger) kGCKMediaCommandSkipForward

表示媒体项支持快进的标记（位掩码）。

- (const NSInteger) kGCKMediaCommandSkipBackward

表示媒体项支持向后跳转的标记（位掩码）。

- (const NSInteger) kGCKMediaCommandQueueNext

一个标记（位掩码），用于表明媒体项支持移至队列中的下一项。

- (const NSInteger) kGCKMediaCommandQueuePrevious

一个标记（位掩码），用于表明媒体项支持移至队列中的上一项。

- (const NSInteger) kGCKMediaCommandQueueShuffle

一个标记（位掩码），表示媒体项支持随机播放。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandSkipAd

表示媒体项支持跳过广告的标记（位掩码）。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandQueueRepeatAll

一个标记（位掩码），用于表明媒体项的队列支持无限重复。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandQueueRepeatOne

一个标记（位掩码），表示媒体项支持无限重复。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandQueueRepeat

一个标记（位掩码），表示媒体项及其队列支持无限重复。

项队列中的项。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandEditTracks

一个标记（位掩码），用于表明媒体项的轨道可修改。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandSetPlaybackRate

一个标记（位掩码），用于表明媒体项的播放速率可配置。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandLike

一个标记（位掩码），用于表明用户可顶某个媒体项。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandDislike

一个标记（位掩码），用于表明某项媒体项可被用户踩。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandFollow

一个标记（位掩码），用于表明用户可跟随媒体项的创建者。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandUnfollow

一个标记（位掩码），用于表明用户可以取消关注媒体项的创建者。

开始时间
4.4.5
- (const NSInteger) kGCKMediaCommandStreamTransfer

表示媒体内容支持流传输的标记（位掩码）。

开始时间
4.4.5

房源详情

- (NSInteger) mediaSessionID
readnonatomicassign

当前媒体会话 ID（如果有）；否则为 0。

- (GCKMediaPlayerState) playerState
readnonatomicassign

当前的播放器状态。

- (BOOL) playingAd
readnonatomicassign

指示接收方当前是否正在播放广告。

Deprecated:
改用 adBreakStatus。
- (GCKMediaPlayerIdleReason) idleReason
readnonatomicassign

当前空闲原因。

仅当播放器状态为 GCKMediaPlayerStateIdle 时，此值才有意义。

- (float) playbackRate
readnonatomicassign

获取当前的流播放速率。

如果视频流正在快退，此值将为 0；如果视频流已暂停，此值为 0；当视频流正常播放时，此值为 1；当视频流向前快进时，此值为 1。

- (GCKMediaInformation*) mediaInformation
readnonatomicstrong

此项的 GCKMediaInformation。

- (NSTimeInterval) streamPosition
readnonatomicassign

当前流的位置，以流开始后的 NSTimeInterval 表示。

- (float) volume
readnonatomicassign

音频流的音量。

- (BOOL) isMuted
readnonatomicassign

流的静音状态。

- (GCKMediaRepeatMode) queueRepeatMode
readnonatomicassign

当前队列重复模式。

- (NSUInteger) currentItemID
readnonatomicassign

当前队列项的 ID（如果有）。

- (BOOL) queueHasCurrentItem
readnonatomicassign

队列中是否有当前项。

- (GCKMediaQueueItem*) currentQueueItem
readnonatomicweak

当前队列项（如果有）。

- (BOOL) queueHasNextItem
readnonatomicassign

检查队列中当前播放项后面是否有某个项。

- (GCKMediaQueueItem*) nextQueueItem
readnonatomicweak

下一个队列项（如果有）。

- (BOOL) queueHasPreviousItem
readnonatomicassign

队列中当前播放项之前是否有一个项。

- (BOOL) queueHasLoadingItem
readnonatomicassign

队列中是否有正在预加载的项。

- (NSUInteger) preloadedItemID
readnonatomicassign

当前预加载的项的 ID（如果有）。

- (NSUInteger) loadingItemID
readnonatomicassign

当前正在加载的项的 ID（如果有）。

- (NSArray<NSNumber *>*) activeTrackIDs
readnonatomicstrong

有效轨道 ID 的列表。

- (GCKVideoInfo*) videoInfo
readnonatomicstrong

视频信息（如果有）。

开始时间
3.3
- (id) customData
readnonatomicstrong

与媒体状态相关联的任何自定义数据。

- (GCKAdBreakStatus*) adBreakStatus
readnonatomicstrong

当前的广告播放状态。

开始时间
3.3
- (GCKMediaLiveSeekableRange*) liveSeekableRange
readnonatomicassign

流的可搜索范围。

开始时间
4.4.1
- (GCKMediaQueueData*) queueData
readnonatomicassign

媒体队列的元数据。

开始时间
4.4.1
- (NSUInteger) queueItemCount
readnonatomicassign

返回播放队列中的项数。