# GCKMediaLoadRequestDataBuilder Class

[Instance Methods](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#pub-methods) \| [Properties](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#properties) GCKMediaLoadRequestDataBuilder Class Reference

## Overview

A builder object for constructing new or derived `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` instances.

The builder may be used to derive `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` from an existing one.

Since
:   4.4.1

Inherits NSObject.

|---|---|
| ## Instance Method Summary ||
| (instancetype) | - [init](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a20ae1848127dfefd3c7118cd51ef8595) |
|   | Initializes a `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` with default values for all properties. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a20ae1848127dfefd3c7118cd51ef8595) |
|   ||
| (instancetype) | - [initWithMediaLoadRequestData:](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a67cc991d9c79fece29a752a9b543359d) |
|   | Initializes a `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` with a given `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` object. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a67cc991d9c79fece29a752a9b543359d) |
|   ||
| ([GCKMediaLoadRequestData](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data) \*) | - [build](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#ad33ca1587e13b457db6f6ba6fb2a93e8) |
|   | Builds a `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` using the builder's current attributes. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#ad33ca1587e13b457db6f6ba6fb2a93e8) |
|   ||

|---|---|
| ## Property Summary ||
| [GCKMediaInformation](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_information) \* | [mediaInformation](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a71bfb3bde9e57a12e431b2dff33231e7) |
|   | The media item to load. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a71bfb3bde9e57a12e431b2dff33231e7) |
|   ||
| [GCKMediaQueueData](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_queue_data) \* | [queueData](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a8cacc8e4fdde4a747bec5bb55075a33b) |
|   | The metadata of media item or queue. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a8cacc8e4fdde4a747bec5bb55075a33b) |
|   ||
| NSNumber \* | [autoplay](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a46862f88c6b80ea68b69903fcd0f0b54) |
|   | The flag to indicate whether playback should start immediately. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a46862f88c6b80ea68b69903fcd0f0b54) |
|   ||
| NSTimeInterval | [startTime](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a9112ae10b56d4e8b6666ccc871be3ec1) |
|   | The initial position to start playback. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a9112ae10b56d4e8b6666ccc871be3ec1) |
|   ||
| float | [playbackRate](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#ae81b7a35687da3027ebb04888f72be81) |
|   | The playback rate. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#ae81b7a35687da3027ebb04888f72be81) |
|   ||
| NSArray\< NSNumber \* \> \* | [activeTrackIDs](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a63a62004151cf681c35f219e6dd67e4b) |
|   | An array of integers specifying the active tracks. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a63a62004151cf681c35f219e6dd67e4b) |
|   ||
| id | [customData](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a866b58c7032902a2d8d84a76d3e43050) |
|   | Custom application-specific data to pass along with the request. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a866b58c7032902a2d8d84a76d3e43050) |
|   ||
| NSString \* | [credentials](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a0d1ce637e5796ac3c4d6f840040a68cd) |
|   | The user credentials for the media item being loaded. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#a0d1ce637e5796ac3c4d6f840040a68cd) |
|   ||
| NSString \* | [credentialsType](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#afac21838cf8d55f3e3ff9bf33203c556) |
|   | The type of user credentials specified in [GCKMediaLoadRequestData::credentials](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data#acca62f6094168318baa42d594422520b "The user credentials for the media item being loaded. "). [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#afac21838cf8d55f3e3ff9bf33203c556) |
|   ||
| NSString \* | [atvCredentials](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#af4a34c7a99eb576e0f1f0b27b04068bf) |
|   | The alternate Android TV credentials for the media item being loaded. [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#af4a34c7a99eb576e0f1f0b27b04068bf) |
|   ||
| NSString \* | [atvCredentialsType](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#afe516696f23e39b686a699d582836b0f) |
|   | The type of Android TV credentials specified in [GCKMediaLoadRequestData::atvCredentials](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data#a9da55c876103275709991de3b72ab9f7 "The alternate Android TV credentials for the media item being loaded. "). [More...](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data_builder#afe516696f23e39b686a699d582836b0f) |
|   ||

## Method Detail

|---|---|---|---|
| - (instancetype) init |   |   |   |

Initializes a `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` with default values for all properties.

|---|---|---|---|---|
| - (instancetype) initWithMediaLoadRequestData: |   | ([GCKMediaLoadRequestData](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data) \*) | *requestData* |   |

Initializes a `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` with a given `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` object.

|---|---|---|---|
| - ([GCKMediaLoadRequestData](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data) \*) build |   |   |   |

Builds a `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` using the builder's current attributes.

Returns
:   The new `https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data` instance.

## Property Detail

|---|---|
| |---| | - ([GCKMediaInformation](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_information)\*) mediaInformation | | readwritenonatomiccopy |

The media item to load.

|---|---|
| |---| | - ([GCKMediaQueueData](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_queue_data)\*) queueData | | readwritenonatomiccopy |

The metadata of media item or queue.

|---|---|
| |---| | - (NSNumber\*) autoplay | | readwritenonatomiccopy |

The flag to indicate whether playback should start immediately.

The default value is `@(YES)`. If this is `nil`, the property of [GCKMediaQueueItem](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_queue_item) in `queueData` will take effect. If queueData is `nil` either, playback will not start immediately.

|---|---|
| |---| | - (NSTimeInterval) startTime | | readwritenonatomicassign |

The initial position to start playback.

The default value is [kGCKInvalidTimeInterval](https://developers.google.com/cast/docs/reference/ios/g_c_k_media_common_8h#abe8984fca7b61be2470630190b919c3b), which indicates a default playback position. If playing Video-On-Demand streams, it starts from 0; if playing live streams, it starts from live edge.

|---|---|
| |---| | - (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**](https://goo.gl/0vd4Q2), or `nil`.

|---|---|
| |---| | - (NSString\*) credentials | | readwritenonatomiccopy |

The user credentials for the media item being loaded.

|---|---|
| |---| | - (NSString\*) credentialsType | | readwritenonatomiccopy |

The type of user credentials specified in [GCKMediaLoadRequestData::credentials](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data#acca62f6094168318baa42d594422520b "The user credentials for the media item being loaded. ").

|---|---|
| |---| | - (NSString\*) atvCredentials | | readwritenonatomiccopy |

The alternate Android TV credentials for the media item being loaded.

If set, these credentials will override the value set in [GCKMediaLoadRequestData::credentials](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data#acca62f6094168318baa42d594422520b "The user credentials for the media item being loaded. ") if the receiver is an Android TV app. On the receiver side, these credentials can be accessed from [MediaLoadRequestData#getCredentials]().

Since
:   4.7.0

|---|---|
| |---| | - (NSString\*) atvCredentialsType | | readwritenonatomiccopy |

The type of Android TV credentials specified in [GCKMediaLoadRequestData::atvCredentials](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data#a9da55c876103275709991de3b72ab9f7 "The alternate Android TV credentials for the media item being loaded. ").

If set, this credentials type will override the value set in [GCKMediaLoadRequestData::credentialsType](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_load_request_data#a594ff18bac9c6228c488827235fdff39 "The type of user credentials specified in GCKMediaLoadRequestData::credentials. ") if the receiver is an Android TV app. On the receiver side, these credentials can be accessed from [MediaLoadRequestData#getCredentialsType]().

Since
:   4.7.0