GCKMediaStatus Class

GCKMediaStatus Class Reference

Overview

A class that holds status information about some media.

Inherits NSObject. Implements <NSCopying>.

Instance Method Summary

(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 *) - queueItemAtIndex:
 Returns the item at the specified index in the playback queue. More...
 
(GCKMediaQueueItem *) - 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...
 

Properties

NSInteger mediaSessionID
 The media session ID for this item. More...
 
GCKMediaPlayerState playerState
 The current player state. More...
 
GCKMediaPlayerIdleReason idleReason
 The current idle reason. More...
 
float playbackRate
 Gets the current stream playback rate. More...
 
GCKMediaInformationmediaInformation
 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...
 
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 * activeTrackIDs
 The list of active track IDs. More...
 
id customData
 Any custom data that is associated with the media item. More...
 

Method Detail

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

Designated initializer.

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

Checks if the stream supports a given control command.

- (NSUInteger) queueItemCount

Returns the number of items in the playback queue.

- (GCKMediaQueueItem *) queueItemAtIndex: (NSUInteger)  index

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

- (GCKMediaQueueItem *) queueItemWithItemID: (NSUInteger)  itemID

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.

Property Documentation

- (NSInteger) mediaSessionID
readnonatomicassign

The media session ID for this item.

- (GCKMediaPlayerState) playerState
readnonatomicassign

The current player state.

- (GCKMediaPlayerIdleReason) idleReason
readnonatomicassign

The current idle reason.

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

- (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 postive value if the stream is seeking forwards.

- (GCKMediaInformation*) mediaInformation
readnonatomicstrong

The GCKMediaInformation for this item.

- (NSTimeInterval) streamPosition
readnonatomicassign

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

- (float) volume
readnonatomicassign

The stream's volume.

- (BOOL) isMuted
readnonatomicassign

The stream's mute state.

- (GCKMediaRepeatMode) queueRepeatMode
readnonatomicassign

The current queue repeat mode.

- (NSUInteger) currentItemID
readnonatomicassign

The ID of the current queue item, if any.

- (NSUInteger) preloadedItemID
readnonatomicassign

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

- (NSUInteger) loadingItemID
readnonatomicassign

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

- (NSArray*) activeTrackIDs
readnonatomicassign

The list of active track IDs.

Each element of the array is an NSNumber containing an integer track ID.

- (id) customData
readnonatomicstrong

Any custom data that is associated with the media item.

Google Cast iOS Sender API Reference v 2.10.1 4691