MediaLoadRequest
Options for loading media with RemoteMediaClient.loadMedia.
When creating the request, you need to provide either mediaInfo if loading a single item, or queueData if loading a queue of items.
Hierarchy
- MediaLoadRequest
Index
Properties
Properties
Optional autoplay
• autoplay? : boolean | null
Whether playback should start immediately. Defaults to true.
When set to null while loading a queue, the first queue item's autoplay property will be used to determine whether to play automatically.
Optional credentials
• credentials? : undefined | string
The user credentials to pass along with the load request to the receiver. The credentials are completely application-specific and can be any arbitrary string.
Optional credentialsType
• credentialsType? : undefined | string
The user credentials type to pass along with the load request to the receiver. The credentials type is completely application-specific and can be any arbitrary string.
Optional customData
• customData? : undefined | object
The custom application-specific data to pass along with the load request.
Optional mediaInfo
• mediaInfo? : MediaInfo
The media item to load. Either this or queueData is required.
Optional playbackRate
• playbackRate? : undefined | number
The playback rate, as the multiplier of the normal playback rate. The accepted value is between 0.5 and 2.0. The normal playback rate is 1.0.
Optional queueData
• queueData? : MediaQueueData
The metadata of media item or queue to load. Either this or mediaInfo is required.
Optional startTime
• startTime? : undefined | number
The initial playback position, in seconds from the beginning of the media.