A class that holds status information about some media. More...

#import <GCKMediaStatus.h>

Inheritance diagram for GCKMediaStatus:

Instance Methods
(BOOL)	- queueHasNextItem
	Checks if there is an item after the currently playing item in the queue. More...

(instancetype)	- initWithSessionID:mediaInformation:
	Designated initializer. More...

(BOOL)	- isMediaCommandSupported:
	Checks if the stream supports a given control command. More...

(NSUInteger)	- queueItemCount
	Returns the number of items in the playback queue. More...

(GCKMediaQueueItem *GCK_NULLABLE_TYPE)	- queueItemAtIndex:
	Returns the item at the specified index in the playback queue. More...

(GCKMediaQueueItem *GCK_NULLABLE_TYPE)	- queueItemWithItemID:
	Returns the item with the given item ID in the playback queue. More...

(NSInteger)	- queueIndexForItemID:
	Returns the index of the item with the given item ID in the playback queue, or -1 if there is no such item in the queue. More...

Public Attributes
GCK_ASSUME_NONNULL_BEGIN GCK_EXTERN const NSInteger	kGCKMediaCommandPause
	A flag (bitmask) indicating that a media item can be paused. More...

GCK_EXTERN const NSInteger	kGCKMediaCommandSeek
	A flag (bitmask) indicating that a media item supports seeking. More...

GCK_EXTERN const NSInteger	kGCKMediaCommandSetVolume
	A flag (bitmask) indicating that a media item's audio volume can be changed. More...

GCK_EXTERN const NSInteger	kGCKMediaCommandToggleMute
	A flag (bitmask) indicating that a media item's audio can be muted. More...

GCK_EXTERN const NSInteger	kGCKMediaCommandSkipForward
	A flag (bitmask) indicating that a media item supports skipping forward. More...

GCK_EXTERN const NSInteger	kGCKMediaCommandSkipBackward
	A flag (bitmask) indicating that a media item supports skipping backward. More...

GCK_EXTERN const NSInteger	kGCKMediaCommandQueueNext
	A flag (bitmask) indicating that a media item supports moving to the next item in the queue. More...

GCK_EXTERN const NSInteger	kGCKMediaCommandQueuePrevious
	A flag (bitmask) indicating that a media item supports moving to the previous item in the queue. More...

Properties
NSInteger	mediaSessionID
	The current media session ID, if any; otherwise 0. More...

GCKMediaPlayerState	playerState
	The current player state. More...

BOOL	playingAd
	Indicates whether the receiver is currently playing an ad. More...

GCKMediaPlayerIdleReason	idleReason
	The current idle reason. More...

float	playbackRate
	Gets the current stream playback rate. More...

GCKMediaInformation *	mediaInformation
	The GCKMediaInformation for this item. More...

NSTimeInterval	streamPosition
	The current stream position, as an NSTimeInterval from the start of the stream. More...

float	volume
	The stream's volume. More...

BOOL	isMuted
	The stream's mute state. More...

GCKMediaRepeatMode	queueRepeatMode
	The current queue repeat mode. More...

NSUInteger	currentItemID
	The ID of the current queue item, if any. More...

BOOL	queueHasCurrentItem
	Whether there is a current item in the queue. More...

GCKMediaQueueItem *	currentQueueItem
	The current queue item, if any. More...

GCKMediaQueueItem *	nextQueueItem
	The next queue item, if any. More...

BOOL	queueHasPreviousItem
	Whether there is an item before the currently playing item in the queue. More...

BOOL	queueHasLoadingItem
	Whether there is an item being preloaded in the queue. More...

NSUInteger	preloadedItemID
	The ID of the item that is currently preloaded, if any. More...

NSUInteger	loadingItemID
	The ID of the item that is currently loading, if any. More...

NSArray< NSNumber * > *	activeTrackIDs
	The list of active track IDs. More...

GCKVideoInfo *	videoInfo
	The video information, if any. More...

id	customData
	Any custom data that is associated with the media status. More...

GCKAdBreakStatus *	adBreakStatus
	The current ad playback status. More...

Detailed Description

A class that holds status information about some media.

Method Documentation

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

Designated initializer.

Parameters

mediaSessionID	The media session ID.
mediaInformation	The media information.

- (BOOL) isMediaCommandSupported: (NSInteger) command

Checks if the stream supports a given control command.

- (BOOL) queueHasNextItem

Checks if there is an item after the currently playing item in the queue.

- (NSInteger) queueIndexForItemID: (NSUInteger) itemID

Returns the index of the item with the given item ID in the playback queue, or -1 if there is no such item in the queue.

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

Returns the item at the specified index in the playback queue.

- (NSUInteger) queueItemCount

Returns the number of items in the playback queue.

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

Returns the item with the given item ID in the playback queue.

Member Data Documentation

- (GCK_ASSUME_NONNULL_BEGIN GCK_EXTERN const NSInteger) kGCKMediaCommandPause

A flag (bitmask) indicating that a media item can be paused.

- (GCK_EXTERN const NSInteger) kGCKMediaCommandQueueNext

A flag (bitmask) indicating that a media item supports moving to the next item in the queue.

Deprecated:: This flag is currently not implemented.

- (GCK_EXTERN const NSInteger) kGCKMediaCommandQueuePrevious

A flag (bitmask) indicating that a media item supports moving to the previous item in the queue.

Deprecated:: This flag is currently not implemented.

- (GCK_EXTERN const NSInteger) kGCKMediaCommandSeek

A flag (bitmask) indicating that a media item supports seeking.

- (GCK_EXTERN const NSInteger) kGCKMediaCommandSetVolume

A flag (bitmask) indicating that a media item's audio volume can be changed.

- (GCK_EXTERN const NSInteger) kGCKMediaCommandSkipBackward

A flag (bitmask) indicating that a media item supports skipping backward.

- (GCK_EXTERN const NSInteger) kGCKMediaCommandSkipForward

A flag (bitmask) indicating that a media item supports skipping forward.

- (GCK_EXTERN const NSInteger) kGCKMediaCommandToggleMute

A flag (bitmask) indicating that a media item's audio can be muted.

Property Documentation

- (NSArray<NSNumber *>*) activeTrackIDs

readnonatomicstrong

The list of active track IDs.

- (GCKAdBreakStatus*) adBreakStatus

readnonatomicstrong

The current ad playback status.

Since: 3.3

- (NSUInteger) currentItemID

readnonatomicassign

The ID of the current queue item, if any.

- (GCKMediaQueueItem*) currentQueueItem

readnonatomicassign

The current queue item, if any.

- (id) customData

readnonatomicstrong

Any custom data that is associated with the media status.

- (GCKMediaPlayerIdleReason) idleReason

readnonatomicassign

The current idle reason.

This value is only meaningful if the player state is GCKMediaPlayerStateIdle.

- (BOOL) isMuted

readnonatomicassign

The stream's mute state.

- (NSUInteger) loadingItemID

readnonatomicassign

The ID of the item that is currently loading, if any.

- (GCKMediaInformation*) mediaInformation

readnonatomicstrong

The GCKMediaInformation for this item.

- (NSInteger) mediaSessionID

readnonatomicassign

The current media session ID, if any; otherwise 0.

- (GCKMediaQueueItem*) nextQueueItem

readnonatomicassign

The next queue item, if any.

- (float) playbackRate

readnonatomicassign

Gets the current stream playback rate.

This will be negative if the stream is seeking backwards, 0 if the stream is paused, 1 if the stream is playing normally, and some other positive value if the stream is seeking forwards.

- (GCKMediaPlayerState) playerState

readnonatomicassign

The current player state.

- (BOOL) playingAd

readnonatomicassign

Indicates whether the receiver is currently playing an ad.

Deprecated:: Use adBreakStatus instead.

- (NSUInteger) preloadedItemID

readnonatomicassign

The ID of the item that is currently preloaded, if any.

- (BOOL) queueHasCurrentItem

readnonatomicassign

Whether there is a current item in the queue.

- (BOOL) queueHasLoadingItem

readnonatomicassign

Whether there is an item being preloaded in the queue.

- (BOOL) queueHasPreviousItem

readnonatomicassign

Whether there is an item before the currently playing item in the queue.

- (GCKMediaRepeatMode) queueRepeatMode

readnonatomicassign

The current queue repeat mode.

- (NSTimeInterval) streamPosition

readnonatomicassign

The current stream position, as an NSTimeInterval from the start of the stream.

- (GCKVideoInfo*) videoInfo

readnonatomicstrong

The video information, if any.

Since: 3.3

- (float) volume

readnonatomicassign

The stream's volume.

The documentation for this class was generated from the following file:

GCKMediaStatus.h

Instance Methods

Public Attributes

Properties

Detailed Description

Method Documentation

Member Data Documentation

Property Documentation