GCKMediaStatus Class
Stay organized with collections
Save and categorize content based on your preferences.
A class that holds status information about some media.
Inherits NSObject. Implements <NSCopying>.
Checks if the stream supports a given control command. More...
Returns the item at the specified index in the playback queue. More...
Returns the item with the given item ID in the playback queue. More...
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...
A flag (bitmask) indicating that a media item can be paused. More...
A flag (bitmask) indicating that a media item supports seeking. More...
A flag (bitmask) indicating that a media item's audio volume can be changed. More...
A flag (bitmask) indicating that a media item's audio can be muted. More...
A flag (bitmask) indicating that a media item supports skipping forward. More...
A flag (bitmask) indicating that a media item supports skipping backward. More...
A flag (bitmask) indicating that a media item supports moving to the next item in the queue. More...
A flag (bitmask) indicating that a media item supports moving to the previous item in the queue. More...
A flag (bitmask) indicating that a media item supports shuffling. More...
A flag (bitmask) indicating that a media item supports ad skipping. More...
A flag (bitmask) indicating that a media item's queue supports indefinite repetition. More...
A flag (bitmask) indicating that a media item supports indefinite repetition. More...
A flag (bitmask) indicating that a media item and its queue support indefinite repetition. More...
A flag (bitmask) indicating that a media item's tracks are editable. More...
A flag (bitmask) indicating that a media item's playback rate is configurable. More...
A flag (bitmask) indicating that a media item can be liked by a user. More...
A flag (bitmask) indicating that a media item can be disliked by a user. More...
A flag (bitmask) indicating that a media item's creator can be followed by a user. More...
A flag (bitmask) indicating that a media item's creator can be unfollowed by a user. More...
A flag (bitmask) indicating that a media item supports stream transfer. More...
The current media session ID, if any; otherwise 0. More...
Indicates whether the receiver is currently playing an ad. More...
Gets the current stream playback rate. More...
The current stream position, as an NSTimeInterval from the start of the stream. More...
The current queue repeat mode. More...
The ID of the current queue item, if any. More...
Whether there is a current item in the queue. More...
The current queue item, if any. More...
Checks if there is an item after the currently playing item in the queue. More...
The next queue item, if any. More...
Whether there is an item before the currently playing item in the queue. More...
Whether there is an item being preloaded in the queue. More...
The ID of the item that is currently preloaded, if any. More...
The ID of the item that is currently loading, if any. More...
The list of active track IDs. More...
The video information, if any. More...
Any custom data that is associated with the media status. More...
The current ad playback status. More...
The seekable range of a stream. More...
The media queue's metadata. More...
Returns the number of items in the playback queue. More...
| - (instancetype) initWithSessionID: |
|
(NSInteger) |
mediaSessionID
|
| mediaInformation: |
|
(nullable GCKMediaInformation
*) |
mediaInformation
|
|
|
|
|
Designated initializer.
- Parameters
-
| - (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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGCKMediaStatus\u003c/code\u003e class provides comprehensive information about the current playback status, including media details, playback state, and volume.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this class to manage the playback queue, access information about live streams and ad playback, and handle custom data.\u003c/p\u003e\n"],["\u003cp\u003eThe class offers methods for checking supported media commands and retrieving specific items within the queue.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGCKMediaStatus\u003c/code\u003e includes various properties that expose attributes like media session ID, player state, stream position, active track IDs, and more.\u003c/p\u003e\n"],["\u003cp\u003eThis class is crucial for building interactive Cast experiences within iOS applications, enabling developers to monitor and control media playback on receiver devices.\u003c/p\u003e\n"]]],["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"],null,[]]
