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 there is an item after the currently playing item in the queue. More...
Checks if the stream supports a given control command. More...
Returns the number of items in the playback queue. 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...
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...
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...
| - (BOOL) queueHasNextItem |
|
|
|
Checks if there is an item after the currently playing item in the queue.
| - (instancetype) initWithSessionID: |
|
(NSInteger) |
mediaSessionID
|
| mediaInformation: |
|
( GCKMediaInformation
*__nullable) |
mediaInformation
|
|
|
|
|
Designated initializer.
- Parameters
-
| - (BOOL) isMediaCommandSupported: |
|
(NSInteger) |
command
|
|
Checks if the stream supports a given control command.
| - (NSUInteger) queueItemCount |
|
|
|
Returns the number of items in the playback queue.
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.
- Deprecated:
- This flag is currently not implemented.
- (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.
- (NSInteger) mediaSessionID
read
nonatomic
assign
The current media session ID, if any; otherwise 0.
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 postive 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.
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
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 status information about media playback on a Cast receiver, including details like playback state, position, volume, and queue status.\u003c/p\u003e\n"],["\u003cp\u003eIt offers methods to check queue status, supported media commands, and retrieve specific queue items by index or ID.\u003c/p\u003e\n"],["\u003cp\u003eIt exposes numerous properties to access media information, session details, playback rate, volume, mute state, repeat mode, active track IDs, video information, custom data, and ad playback status.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eNSObject\u003c/code\u003e and conforms to the \u003ccode\u003eNSCopying\u003c/code\u003e protocol.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this class to monitor and control the playback of media content on Cast receivers.\u003c/p\u003e\n"]]],["The `GCKMediaStatus` class provides information about media playback. It manages media queues, including checking for next or previous items, retrieving items by index or ID, and counting the items. It supports media control commands such as pause, seek, volume adjustment, mute, skip forward/backward, and queue navigation. Key properties include session ID, player state, playback rate, stream position, volume, and mute status. It also provides properties for current, next, preloaded and loading queue items, active track IDs and ad playback status.\n"],null,[]]
