org.digitalmediaserver.cast

Class MediaStatus

java.lang.Object

org.digitalmediaserver.cast.MediaStatus

@Immutable
public class MediaStatus
extends Object

Current media player status - which media is played, volume, time position, etc.

See Also:

https://developers.google.com/cast/docs/reference/receiver/cast.receiver.media.MediaStatus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaStatus.IdleReason The reason for the player to be in MediaStatus.PlayerState.IDLE state.
static class	MediaStatus.PlayerState Represents the player state.
static class	MediaStatus.RepeatMode The behavior of the queue when all items have been played.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Integer>	activeTrackIds The List of IDs corresponding to the active tracks
protected Integer	currentItemId The ID of the media item that originated the status change
protected double	currentTime The current playback position
protected Map<String,Object>	customData Application-specific media status data
protected ExtendedMediaStatus	extendedStatus Extended media status information
protected MediaStatus.IdleReason	idleReason If the state is MediaStatus.PlayerState.IDLE, the reason the player went to IDLE state.
protected List<QueueItem>	items The List of media queue items
protected LiveSeekableRange	liveSeekableRange The seekable range of a live or event stream.
protected Integer	loadingItemId The ID of the media Item currently loading.
protected Media	media The media information
protected int	mediaSessionId Unique id for the session
protected float	playbackRate The playback rate
protected MediaStatus.PlayerState	playerState The playback state
protected Integer	preloadedItemId ID of the next Item, only available if it has been preloaded.
protected QueueData	queueData The queue data
protected MediaStatus.RepeatMode	repeatMode The behavior of the queue when all items have been played
protected int	supportedMediaCommands The commands supported by this player
protected VideoInformation	videoInfo The video information
protected MediaVolume	volume The current stream volume

Constructor Summary

Constructors

Constructor and Description

MediaStatus(List<Integer> activeTrackIds, Integer currentItemId, double currentTime, Map<String,Object> customData, ExtendedMediaStatus extendedStatus, MediaStatus.IdleReason idleReason, List<QueueItem> items, LiveSeekableRange liveSeekableRange, Integer loadingItemId, Media media, int mediaSessionId, float playbackRate, MediaStatus.PlayerState playerState, Integer preloadedItemId, QueueData queueData, MediaStatus.RepeatMode repeatMode, int supportedMediaCommands, VideoInformation videoInfo, MediaVolume volume) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<Integer>	getActiveTrackIds()
Integer	getCurrentItemId()
double	getCurrentTime()
Map<String,Object>	getCustomData()
ExtendedMediaStatus	getExtendedStatus()
MediaStatus.IdleReason	getIdleReason()
List<QueueItem>	getItems()
LiveSeekableRange	getLiveSeekableRange()
Integer	getLoadingItemId()
Media	getMedia()
int	getMediaSessionId()
float	getPlaybackRate()
MediaStatus.PlayerState	getPlayerState()
Integer	getPreloadedItemId()
QueueData	getQueueData()
MediaStatus.RepeatMode	getRepeatMode()
int	getSupportedMediaCommands()
VideoInformation	getVideoInfo()
MediaVolume	getVolume()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

activeTrackIds

@Nonnull
protected final List<Integer> activeTrackIds

The List of IDs corresponding to the active tracks

currentItemId

@Nullable
protected final Integer currentItemId

The ID of the media item that originated the status change

currentTime

protected final double currentTime

The current playback position

customData

@Nonnull
protected final Map<String,Object> customData

Application-specific media status data

extendedStatus

@Nullable
protected final ExtendedMediaStatus extendedStatus

Extended media status information

idleReason

@Nullable
protected final MediaStatus.IdleReason idleReason

If the state is MediaStatus.PlayerState.IDLE, the reason the player went to IDLE state.

items

@Nonnull
protected final List<QueueItem> items

The List of media queue items

liveSeekableRange

@Nullable
protected final LiveSeekableRange liveSeekableRange

The seekable range of a live or event stream. It uses relative media time in seconds. It will be undefined for VOD streams.

loadingItemId

@Nullable
protected final Integer loadingItemId

The ID of the media Item currently loading. If there is no item being loaded, it will be null.

media

@Nullable
protected final Media media

The media information

mediaSessionId

protected final int mediaSessionId

Unique id for the session

playbackRate

protected final float playbackRate

The playback rate

playerState

@Nonnull
protected final MediaStatus.PlayerState playerState

The playback state

preloadedItemId

@Nullable
protected final Integer preloadedItemId

ID of the next Item, only available if it has been preloaded. Media items can be preloaded and cached temporarily in memory, so when they are loaded later on, the process is faster (as the media does not have to be fetched from the network).

queueData

@Nullable
protected final QueueData queueData

The queue data

repeatMode

@Nullable
protected final MediaStatus.RepeatMode repeatMode

The behavior of the queue when all items have been played

supportedMediaCommands

protected final int supportedMediaCommands

The commands supported by this player

videoInfo

@Nullable
protected final VideoInformation videoInfo

The video information

volume

@Nonnull
protected final MediaVolume volume

The current stream volume

Constructor Detail

MediaStatus

public MediaStatus(@Nullable
                   List<Integer> activeTrackIds,
                   @Nullable
                   Integer currentItemId,
                   double currentTime,
                   @Nullable
                   Map<String,Object> customData,
                   @Nullable
                   ExtendedMediaStatus extendedStatus,
                   @Nullable
                   MediaStatus.IdleReason idleReason,
                   @Nullable
                   List<QueueItem> items,
                   @Nullable
                   LiveSeekableRange liveSeekableRange,
                   @Nullable
                   Integer loadingItemId,
                   @Nullable
                   Media media,
                   int mediaSessionId,
                   float playbackRate,
                   @Nonnull
                   MediaStatus.PlayerState playerState,
                   @Nullable
                   Integer preloadedItemId,
                   @Nullable
                   QueueData queueData,
                   @Nullable
                   MediaStatus.RepeatMode repeatMode,
                   int supportedMediaCommands,
                   @Nullable
                   VideoInformation videoInfo,
                   @Nonnull
                   MediaVolume volume)

Creates a new instance using the specified parameters.

Parameters:

activeTrackIds - the List of IDs corresponding to the active tracks.

currentItemId - the ID of the media item that originated the status change.

currentTime - the current playback position.

customData - the application-specific media status data.

extendedStatus - the extended media status information.

idleReason - the reason the player went to MediaStatus.PlayerState.IDLE if the current state is MediaStatus.PlayerState.IDLE, otherwise null.

items - the List of media QueueItems.

liveSeekableRange - the seekable range of a live or event stream. It uses relative media time in seconds. It will be undefined for VOD streams.

loadingItemId - the ID of the media item currently loading. If there is no item being loaded, it will be null.

media - the media information.

mediaSessionId - the unique id for the session.

playbackRate - the playback rate.

playerState - the playback state.

preloadedItemId - the ID of the next Item, only available if it has been preloaded. Media items can be preloaded and cached temporarily in memory, so when they are loaded later on, the process is faster (as the media does not have to be fetched from the network).

queueData - the queue data.

repeatMode - the behavior of the queue when all items have been played.

supportedMediaCommands - the commands supported by this player.

videoInfo - the video information.

volume - the current stream volume.

Throws:

IllegalArgumentException - If playerState or volume is null.

Method Detail

getActiveTrackIds

@Nonnull
public List<Integer> getActiveTrackIds()

Returns:

The List of IDs corresponding to the active tracks.

getCurrentItemId

@Nullable
public Integer getCurrentItemId()

Returns:

The ID of the media item that originated the status change.

getCurrentTime

public double getCurrentTime()

Returns:

The current playback position.

getCustomData

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

Returns:

The application-specific media status data.

getExtendedStatus

@Nullable
public ExtendedMediaStatus getExtendedStatus()

Returns:

The extended media status information.

getIdleReason

@Nullable
public MediaStatus.IdleReason getIdleReason()

Returns:

The reason the player went to MediaStatus.PlayerState.IDLE if the current state is MediaStatus.PlayerState.IDLE, otherwise null.

getItems

@Nonnull
public List<QueueItem> getItems()

Returns:

The List of media QueueItems.

getLiveSeekableRange

@Nullable
public LiveSeekableRange getLiveSeekableRange()

Returns:

The seekable range of a live or event stream. It uses relative media time in seconds. It will be undefined for VOD streams.

getLoadingItemId

@Nullable
public Integer getLoadingItemId()

Returns:

The ID of the media item currently loading. If there is no item being loaded, it will be null.

getMedia

@Nullable
public Media getMedia()

Returns:

The media information.

getMediaSessionId

public int getMediaSessionId()

Returns:

The unique id for the session.

getPlaybackRate

public float getPlaybackRate()

Returns:

The playback rate.

getPlayerState

@Nonnull
public MediaStatus.PlayerState getPlayerState()

Returns:

The playback state.

getPreloadedItemId

@Nullable
public Integer getPreloadedItemId()

Returns:

The ID of the next Item, only available if it has been preloaded. Media items can be preloaded and cached temporarily in memory, so when they are loaded later on, the process is faster (as the media does not have to be fetched from the network).

getQueueData

@Nullable
public QueueData getQueueData()

Returns:

The queue data.

getRepeatMode

@Nullable
public MediaStatus.RepeatMode getRepeatMode()

Returns:

The behavior of the queue when all items have been played.

getSupportedMediaCommands

public int getSupportedMediaCommands()

Returns:

The commands supported by this player.

getVideoInfo

@Nullable
public VideoInformation getVideoInfo()

Returns:

The video information.

getVolume

@Nonnull
public MediaVolume getVolume()

Returns:

The current stream volume.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object