GCKMediaStatus Class
Stay organized with collections
Save and categorize content based on your preferences.
outlined_flag
GCKMediaStatus is a class in the Google Cast SDK for iOS that provides status information about media being cast.
It includes instance methods for initializing the status, checking supported media commands, and accessing queue items.
The class has public attributes representing various media commands and properties for retrieving detailed status like player state, volume, and queue information.
Key properties include mediaSessionID, playerState, playbackRate, streamPosition, and information about the media queue and ad breaks.
It also supports custom data and provides access to video information and the seekable range of live streams.
A class that holds status information about some media.
Inherits NSObject. Implements <NSCopying>.
- (instancetype) initWithSessionID:
(NSInteger)
mediaSessionID
mediaInformation:
(nullable GCKMediaInformation *)
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.
Returns the item at the specified index in the playback queue.
Returns the item with the given item ID in the playback 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.
- (const NSInteger) kGCKMediaCommandPause
A flag (bitmask) indicating that a media item can be paused.
- (const NSInteger) kGCKMediaCommandSeek
A flag (bitmask) indicating that a media item supports seeking.
- (const NSInteger) kGCKMediaCommandSetVolume
A flag (bitmask) indicating that a media item's audio volume can be changed.
- (const NSInteger) kGCKMediaCommandToggleMute
A flag (bitmask) indicating that a media item's audio can be muted.
- (const NSInteger) kGCKMediaCommandSkipForward
A flag (bitmask) indicating that a media item supports skipping forward.
- (const NSInteger) kGCKMediaCommandSkipBackward
A flag (bitmask) indicating that a media item supports skipping backward.
- (const NSInteger) kGCKMediaCommandQueueNext
A flag (bitmask) indicating that a media item supports moving to the next item in the queue.
- (const NSInteger) kGCKMediaCommandQueuePrevious
A flag (bitmask) indicating that a media item supports moving to the previous item in the queue.
- (const NSInteger) kGCKMediaCommandQueueShuffle
A flag (bitmask) indicating that a media item supports shuffling.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandSkipAd
A flag (bitmask) indicating that a media item supports ad skipping.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandQueueRepeatAll
A flag (bitmask) indicating that a media item's queue supports indefinite repetition.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandQueueRepeatOne
A flag (bitmask) indicating that a media item supports indefinite repetition.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandQueueRepeat
A flag (bitmask) indicating that a media item and its queue support indefinite repetition.
queued items.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandEditTracks
A flag (bitmask) indicating that a media item's tracks are editable.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandSetPlaybackRate
A flag (bitmask) indicating that a media item's playback rate is configurable.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandLike
A flag (bitmask) indicating that a media item can be liked by a user.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandDislike
A flag (bitmask) indicating that a media item can be disliked by a user.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandFollow
A flag (bitmask) indicating that a media item's creator can be followed by a user.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandUnfollow
A flag (bitmask) indicating that a media item's creator can be unfollowed by a user.
Since 4.4.5
- (const NSInteger) kGCKMediaCommandStreamTransfer
A flag (bitmask) indicating that a media item supports stream transfer.
Since 4.4.5
- (NSInteger) mediaSessionID
read nonatomic assign
The current media session ID, if any; otherwise 0.
- (GCKMediaPlayerState) playerState
read nonatomic assign
The current player state.
The current idle reason.
This value is only meaningful if the player state is GCKMediaPlayerStateIdle.
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.
- (NSTimeInterval) streamPosition
read nonatomic assign
The current stream position, as an NSTimeInterval from the start of the stream.
The current queue repeat mode.
- (NSUInteger) currentItemID
read nonatomic assign
The ID of the current queue item, if any.
- (BOOL) queueHasCurrentItem
read nonatomic assign
Whether there is a current item in the queue.
The current queue item, if any.
- (BOOL) queueHasNextItem
read nonatomic assign
Checks if there is an item after the currently playing item in the queue.
The next queue item, if any.
- (BOOL) queueHasPreviousItem
read nonatomic assign
Whether there is an item before the currently playing item in the queue.
- (BOOL) queueHasLoadingItem
read nonatomic assign
Whether there is an item being preloaded in the queue.
- (NSUInteger) preloadedItemID
read nonatomic assign
The ID of the item that is currently preloaded, if any.
- (NSUInteger) loadingItemID
read nonatomic assign
The ID of the item that is currently loading, if any.
- (NSArray<NSNumber *>*) activeTrackIDs
read nonatomic strong
The list of active track IDs.
The video information, if any.
Since 3.3
Any custom data that is associated with the media status.
The current ad playback status.
Since 3.3
The seekable range of a stream.
Since 4.4.1
The media queue's metadata.
Since 4.4.1
- (NSUInteger) queueItemCount
read nonatomic assign
Returns the number of items in the playback queue.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[],["The `GCKMediaStatus` class manages media status, providing information like session ID, player state, playback rate, and volume. It supports media control commands (pause, seek, mute, skip, queue navigation, etc.). The class allows checking if specific commands are supported and retrieving queue items by index or ID. It also offers properties detailing current item, queue status, and ad playback status. Additionally, the class has the ability to obtain and manage data for queue and stream such as `queueData` and `liveSeekableRange`.\n"]]
