GCKMediaLoadOptions Class

  • GCKMediaLoadOptions is a class in the Google Cast SDK for iOS used to specify options when loading media with GCKRemoteMediaClient.

  • Key properties of GCKMediaLoadOptions include autoplay, playPosition, playbackRate, activeTrackIDs, customData, credentials, and credentialsType.

  • The init method is the designated initializer for creating a GCKMediaLoadOptions object with default values.

  • Properties like autoplay and playPosition determine how playback starts, while playbackRate controls the speed.

  • You can include custom data and user credentials with the media loading request using the customData, credentials, and credentialsType properties.
Instance Methods | Properties
GCKMediaLoadOptions Class Reference

Overview

Options for loading media with GCKRemoteMediaClient.

Since
4.0

Inherits NSObject, <NSCopying>, and <NSSecureCoding>.

Instance Method Summary

(instancetype) - init
 Designated initializer. More...
 

Property Summary

BOOL autoplay
 Whether playback should start immediately. More...
 
NSTimeInterval playPosition
 The initial playback position. More...
 
float playbackRate
 The playback rate. More...
 
NSArray< NSNumber * > * activeTrackIDs
 An array of integers specifying the active tracks. More...
 
id customData
 Custom application-specific data to pass along with the request. More...
 
NSString * credentials
 The user credentials for the media item being loaded. More...
 
NSString * credentialsType
 The type of user credentials specified in GCKMediaLoadOptions::credentials. More...
 

Method Detail

- (instancetype) init

Designated initializer.

Initializes a GCKMediaLoadOptions with default values for all properties.

Property Detail

- (BOOL) autoplay
readwritenonatomicassign

Whether playback should start immediately.

The default value is YES.

- (NSTimeInterval) playPosition
readwritenonatomicassign

The initial playback position.

The default value is kGCKInvalidTimeInterval, which indicates a default playback position.

- (float) playbackRate
readwritenonatomicassign

The playback rate.

The default value is 1.

- (NSArray<NSNumber *>*) activeTrackIDs
readwritenonatomicstrong

An array of integers specifying the active tracks.

The default value is nil.

- (id) customData
readwritenonatomicstrong

Custom application-specific data to pass along with the request.

Must either be an object that can be serialized to JSON using NSJSONSerialization, or nil.

- (NSString*) credentials
readwritenonatomiccopy

The user credentials for the media item being loaded.

Since
4.1.1
- (NSString*) credentialsType
readwritenonatomiccopy

The type of user credentials specified in GCKMediaLoadOptions::credentials.

Since
4.1.1