org.digitalmediaserver.cast

Class StandardRequest.Load

java.lang.Object

org.digitalmediaserver.cast.StandardMessage

org.digitalmediaserver.cast.StandardRequest

org.digitalmediaserver.cast.StandardRequest.Load

All Implemented Interfaces:

Message, Request

Enclosing class:

StandardRequest

public static class StandardRequest.Load
extends StandardRequest

A request to load media.

Nested Class Summary

Nested classes/interfaces inherited from class org.digitalmediaserver.cast.StandardRequest

StandardRequest.GetAppAvailability, StandardRequest.GetStatus, StandardRequest.Launch, StandardRequest.Load, StandardRequest.MediaRequest, StandardRequest.Pause, StandardRequest.Play, StandardRequest.ResumeState, StandardRequest.Seek, StandardRequest.SetVolume, StandardRequest.Stop, StandardRequest.StopMedia, StandardRequest.VolumeRequest

Nested classes/interfaces inherited from class org.digitalmediaserver.cast.StandardMessage

StandardMessage.CloseConnection, StandardMessage.Connect, StandardMessage.Origin, StandardMessage.Ping, StandardMessage.Pong

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Integer>	activeTrackIds The List of track IDs that are active.
protected Boolean	autoplay If the autoplay parameter is specified and true, the media player will begin playing the content when it is loaded.
protected String	credentials Optional user credentials
protected String	credentialsType Optional credentials type.
protected Double	currentTime Seconds since beginning of content.
protected Map<String,Object>	customData The custom application data to send to the remote application with the load command
protected LoadOptions	loadOptions Additional load options
protected Media	media The Media to load
protected Double	playbackRate The media playback rate
protected QueueData	queueData The queue to load

Fields inherited from class org.digitalmediaserver.cast.StandardRequest

requestId

Constructor Summary

Constructors

Constructor and Description
Load(List<Integer> activeTrackIds, Boolean autoplay, String credentials, String credentialsType, Double currentTime, Map<String,Object> customData, LoadOptions loadOptions, Media media, Double playbackRate, QueueData queueData) Creates a new request to load the specified Media.

Method Summary

Modifier and Type	Method and Description
List<Integer>	getActiveTrackIds()
Boolean	getAutoplay()
String	getCredentials()
String	getCredentialsType()
Double	getCurrentTime()
Map<String,Object>	getCustomData()
LoadOptions	getLoadOptions()
Media	getMedia()
Double	getPlaybackRate()
QueueData	getQueueData()

Methods inherited from class org.digitalmediaserver.cast.StandardRequest

getRequestId, setRequestId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

activeTrackIds

@Nullable
protected final List<Integer> activeTrackIds

The List of track IDs that are active. If the array is not provided, the default tracks will be active

autoplay

@Nullable
protected final Boolean autoplay

If the autoplay parameter is specified and true, the media player will begin playing the content when it is loaded. Even if autoplay is not specified, the media player implementation may choose to begin playback immediately

credentials

@Nullable
protected final String credentials

Optional user credentials

credentialsType

@Nullable
protected final String credentialsType

Optional credentials type. The type 'cloud' is a reserved type used by load requests that were originated by voice assistant commands.

currentTime

@Nullable
protected final Double currentTime

Seconds since beginning of content. If the content is live content, and currentTime is not specified, the stream will start at the live position.

customData

@Nullable
protected final Map<String,Object> customData

The custom application data to send to the remote application with the load command

loadOptions

@Nullable
protected final LoadOptions loadOptions

Additional load options

media

@Nullable
protected final Media media

The Media to load

playbackRate

@Nullable
protected final Double playbackRate

The media playback rate

queueData

@Nullable
protected final QueueData queueData

The queue to load

Constructor Detail

Load

public Load(@Nullable
            List<Integer> activeTrackIds,
            @Nullable
            Boolean autoplay,
            @Nullable
            String credentials,
            @Nullable
            String credentialsType,
            @Nullable
            Double currentTime,
            @Nullable
            Map<String,Object> customData,
            @Nullable
            LoadOptions loadOptions,
            @Nullable
            Media media,
            @Nullable
            Double playbackRate,
            @Nullable
            QueueData queueData)

Creates a new request to load the specified Media.

Parameters:

activeTrackIds - the List of track IDs that are active. If the list is not provided, the default tracks will be active.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading. If autoplay is not specified, the media player implementation may choose to begin playback immediately.

credentials - the user credentials, if any.

credentialsType - the credentials type, if any. The type 'cloud' is a reserved type used by load requests that were originated by voice assistant commands.

currentTime - the position in seconds from the start for where playback is to start in the loaded Media. If the content is live content, and currentTime is not specified, the stream will start at the live position.

customData - the custom application data to send to the remote application with the load command.

loadOptions - the additional load options, if any.

media - the Media to load.

playbackRate - the media playback rate.

queueData - the queue to load.

Throws:

IllegalArgumentException - If media is null.

Method Detail

getActiveTrackIds

@Nullable
public List<Integer> getActiveTrackIds()

Returns:

The List of track IDs that are active. If the list is not provided, the default tracks will be active.

getAutoplay

@Nullable
public Boolean getAutoplay()

Returns:

true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading. If autoplay is not specified, the media player implementation may choose to begin playback immediately.

getCredentials

@Nullable
public String getCredentials()

Returns:

The user credentials, if any.

getCredentialsType

@Nullable
public String getCredentialsType()

Returns:

The credentials type, if any. The type 'cloud' is a reserved type used by load requests that were originated by voice assistant commands.

getCurrentTime

@Nullable
public Double getCurrentTime()

Returns:

The position in seconds from the start for where playback is to start in the loaded Media. If the content is live content, and currentTime is not specified, the stream will start at the live position.

getCustomData

@Nullable
public Map<String,Object> getCustomData()

Returns:

The custom application data to send to the remote application with the load command.

getLoadOptions

@Nullable
public LoadOptions getLoadOptions()

Returns:

The additional load options, if any.

getMedia

@Nullable
public Media getMedia()

Returns:

The Media to load.

getPlaybackRate

@Nullable
public Double getPlaybackRate()

Returns:

The media playback rate.

getQueueData

@Nullable
public QueueData getQueueData()

Returns:

The queue to load.