MediaLoadOptions

public class MediaLoadOptions extends Object

An object that holds options that affect how a receiver application should load a media item.

Nested Class Summary

class MediaLoadOptions.Builder Builder class for MediaLoadOptions

Constant Summary

double PLAYBACK_RATE_MAX The maximum value that can be used in MediaLoadOptions.Builder.setPlaybackRate(double).
double PLAYBACK_RATE_MIN The minimum value that can be used in MediaLoadOptions.Builder.setPlaybackRate(double).

Public Method Summary

long[]
getActiveTrackIds()
Returns the array of the active tracks.
boolean
getAutoplay()
Returns the value of whether playback should start immediately.
String
getCredentials()
Returns the credentials string, as passed in with MediaLoadOptions.Builder.setCredentials(String).
String
getCredentialsType()
Returns the credentials type string, as passed in with MediaLoadOptions.Builder.setCredentialsType(String).
JSONObject
getCustomData()
Returns the custom application-specific data to pass along with the load request.
long
getPlayPosition()
Returns the initial playback position, in milliseconds from the beginning of the stream.
double
getPlaybackRate()
Returns the playback rate, as the multiplier of the normal playback rate.

Inherited Method Summary

Constants

public static final double PLAYBACK_RATE_MAX

The maximum value that can be used in MediaLoadOptions.Builder.setPlaybackRate(double).

Constant Value: 2.0

public static final double PLAYBACK_RATE_MIN

The minimum value that can be used in MediaLoadOptions.Builder.setPlaybackRate(double).

Constant Value: 0.5

Public Methods

public long[] getActiveTrackIds ()

Returns the array of the active tracks. If the default value is null.

public boolean getAutoplay ()

Returns the value of whether playback should start immediately. The default value is true.

public String getCredentials ()

Returns the credentials string, as passed in with MediaLoadOptions.Builder.setCredentials(String).

public String getCredentialsType ()

Returns the credentials type string, as passed in with MediaLoadOptions.Builder.setCredentialsType(String).

public JSONObject getCustomData ()

Returns the custom application-specific data to pass along with the load request.

public long getPlayPosition ()

Returns the initial playback position, in milliseconds from the beginning of the stream. The default value is 0.

public double getPlaybackRate ()

Returns the playback rate, as the multiplier of the normal playback rate. The default value is 1.