java.lang.Object | |
↳ | com.google.android.gms.cast.MediaStatus |
A class that holds status information about some media or media queue. The current
MediaStatus
can be obtained from the RemoteMediaPlayer
.
Each media session is associated with a media queue on the receiver application. The list of
media items in the current queue can be obtained from getQueueItems()
. Media items are
assigned a unique item ID. Accessors for individual item and values of properties of the queue
are also provided here.
getCurrentItemId()
, getLoadingItemId()
and getPreloadedItemId()
tells
which item is playing, which item is loading and which item has been preloaded on the receiver.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
long | COMMAND_PAUSE | A flag (bitmask) indicating that a media item can be paused. | |||||||||
long | COMMAND_SEEK | A flag (bitmask) indicating that a media item supports seeking. | |||||||||
long | COMMAND_SET_VOLUME | A flag (bitmask) indicating that a media item's audio volume can be changed. | |||||||||
long | COMMAND_SKIP_BACKWARD | A flag (bitmask) indicating that a media item supports skipping backward. | |||||||||
long | COMMAND_SKIP_FORWARD | A flag (bitmask) indicating that a media item supports skipping forward. | |||||||||
long | COMMAND_TOGGLE_MUTE | A flag (bitmask) indicating that a media item's audio can be muted. | |||||||||
int | IDLE_REASON_CANCELED | Constant indicating that the player is idle because playback has been canceled in response to a STOP command. | |||||||||
int | IDLE_REASON_ERROR | Constant indicating that the player is idle because a playback error has occurred. | |||||||||
int | IDLE_REASON_FINISHED | Constant indicating that the player is idle because playback has finished. | |||||||||
int | IDLE_REASON_INTERRUPTED | Constant indicating that the player is idle because playback has been interrupted by a LOAD command. | |||||||||
int | IDLE_REASON_NONE | Constant indicating that the player currently has no idle reason. | |||||||||
int | PLAYER_STATE_BUFFERING | Constant indicating that the media player is buffering. | |||||||||
int | PLAYER_STATE_IDLE | Constant indicating that the media player is idle. | |||||||||
int | PLAYER_STATE_PAUSED | Constant indicating that the media player is paused. | |||||||||
int | PLAYER_STATE_PLAYING | Constant indicating that the media player is playing. | |||||||||
int | PLAYER_STATE_UNKNOWN | Constant indicating unknown player state. | |||||||||
int | REPEAT_MODE_REPEAT_ALL | Constant indicating that the items in the queue will be played indefinitely. | |||||||||
int | REPEAT_MODE_REPEAT_ALL_AND_SHUFFLE | Constant indicating that the items in the queue will be played indefinitely, and the order of the items will be randomly shuffled once the last item in the queue finishes. | |||||||||
int | REPEAT_MODE_REPEAT_OFF | Constant indicating that when the queue is completed the media session is terminated. | |||||||||
int | REPEAT_MODE_REPEAT_SINGLE | Constant indicating that the current item will be repeated indefinitely. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the list of active track IDs set by the cast receiver, if any, otherwise
null . | |||||||||||
Returns the received
AdBreakStatus . | |||||||||||
Returns the
AdBreakInfo of the currently playing ad break on the cast receiver. | |||||||||||
Returns the
AdBreakClipInfo of the currently playing ad break clip on the cast
receiver. | |||||||||||
Returns the item ID of the item that that was active in the queue (it may not be playing) at
the time the media status change happened.
| |||||||||||
Returns any custom data that is associated with the media item.
| |||||||||||
Gets the player state idle reason.
| |||||||||||
Returns the index of the
MediaQueueItem with the given itemId in the playback
queue, or null if there is no such item in the queue. | |||||||||||
Returns the
MediaQueueItem of the give item ID. | |||||||||||
Returns the
MediaQueueItem at index, or null if index is out of bounds. | |||||||||||
Returns the item ID of the item that is currently loading (but isn't active in the queue) on
the receiver.
| |||||||||||
Returns the
MediaInfo for this item. | |||||||||||
Gets the current stream playback rate.
| |||||||||||
Gets the current media player state.
| |||||||||||
If the next item has been preloaded this returns the preloaded item ID.
| |||||||||||
Returns the
MediaQueueItem at index, or null if index out of bounds. | |||||||||||
Returns the
MediaQueueItem of the give item ID. | |||||||||||
Returns the number of items in the media queue.
| |||||||||||
Returns the list of
MediaQueueItem as an unmodifiable list. | |||||||||||
Returns the repeat mode of the media queue.
| |||||||||||
Returns the current stream position, in milliseconds.
| |||||||||||
Returns the stream's volume.
| |||||||||||
Returns the last received
VideoInfo . | |||||||||||
Tests if the stream supports a given control command.
| |||||||||||
Returns the stream's mute state.
| |||||||||||
Returns
true is the receiver is playing an ad. | |||||||||||
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
A flag (bitmask) indicating that a media item can be paused.
A flag (bitmask) indicating that a media item supports seeking.
A flag (bitmask) indicating that a media item's audio volume can be changed.
A flag (bitmask) indicating that a media item supports skipping backward.
A flag (bitmask) indicating that a media item supports skipping forward.
A flag (bitmask) indicating that a media item's audio can be muted.
Constant indicating that the player is idle because playback has been canceled in response to a STOP command.
Constant indicating that the player is idle because a playback error has occurred.
Constant indicating that the player is idle because playback has finished.
Constant indicating that the player is idle because playback has been interrupted by a LOAD command.
Constant indicating that the player currently has no idle reason.
Constant indicating that the media player is buffering.
Constant indicating that the media player is idle.
Constant indicating that the media player is paused.
Constant indicating that the media player is playing.
Constant indicating unknown player state.
Constant indicating that the items in the queue will be played indefinitely.
Constant indicating that the items in the queue will be played indefinitely, and the order of the items will be randomly shuffled once the last item in the queue finishes. The queue will continue to play starting from the first item of the shuffled items.
Constant indicating that when the queue is completed the media session is terminated.
Constant indicating that the current item will be repeated indefinitely.
Parameters | |
---|---|
other |
Object
|
Returns | |
---|---|
boolean |
Returns the list of active track IDs set by the cast receiver, if any, otherwise
null
.
Returns | |
---|---|
long[] |
Returns the AdBreakInfo
of the currently playing ad break on the cast receiver. If
the cast receiver is not playing an ad break, null
will be returned.
Returns | |
---|---|
AdBreakInfo |
Returns the AdBreakClipInfo
of the currently playing ad break clip on the cast
receiver. If the cast receiver is not playing an ad break clip, null
will be
returned.
Returns | |
---|---|
AdBreakClipInfo |
Returns the item ID of the item that that was active in the queue (it may not be playing) at the time the media status change happened.
Returns | |
---|---|
int |
Returns any custom data that is associated with the media item.
Returns | |
---|---|
JSONObject |
Gets the player state idle reason. This value is only meaningful if the player state is
in fact PLAYER_STATE_IDLE
.
Returns | |
---|---|
int |
Returns the index of the MediaQueueItem
with the given itemId
in the playback
queue, or null
if there is no such item in the queue.
Parameters | |
---|---|
itemId |
int
|
Returns | |
---|---|
Integer |
Returns the MediaQueueItem
of the give item ID. Returns null
if not found.
Parameters | |
---|---|
itemId |
int
|
Returns | |
---|---|
MediaQueueItem |
Returns the MediaQueueItem
at index, or null
if index is out of bounds.
Parameters | |
---|---|
index |
int
|
Returns | |
---|---|
MediaQueueItem |
Returns the item ID of the item that is currently loading (but isn't active in the queue) on
the receiver. Returns INVALID_ITEM_ID
if no item is currently loading.
Returns | |
---|---|
int |
Gets the current stream playback rate. This will be negative if the stream is seeking backwards, 0 if the stream is paused, 1 if the stream is playing normally, and some other postive value if the stream is seeking forwards.
Returns | |
---|---|
double |
Gets the current media player state.
Returns | |
---|---|
int |
If the next item has been preloaded this returns the preloaded item ID. Otherwise returns
INVALID_ITEM_ID
.
Returns | |
---|---|
int |
Returns the MediaQueueItem
at index, or null
if index out of bounds.
Parameters | |
---|---|
index |
int
|
Returns | |
---|---|
MediaQueueItem |
Returns the MediaQueueItem
of the give item ID. Returns null
if not found.
Parameters | |
---|---|
itemId |
int
|
Returns | |
---|---|
MediaQueueItem |
Returns the number of items in the media queue.
Returns | |
---|---|
int |
Returns the list of MediaQueueItem
as an unmodifiable list.
Returns | |
---|---|
List<MediaQueueItem> |
Returns the repeat mode of the media queue.
Returns | |
---|---|
int |
Returns the current stream position, in milliseconds.
Returns | |
---|---|
long |
Returns the stream's volume.
Returns | |
---|---|
double |
Returns | |
---|---|
int |
Tests if the stream supports a given control command.
Parameters | |
---|---|
mediaCommand |
long :
The media command. |
Returns | |
---|---|
boolean |
true if the command is supported, false otherwise.
|
Returns the stream's mute state.
Returns | |
---|---|
boolean |
Returns true
is the receiver is playing an ad.
Returns | |
---|---|
boolean |
Parameters | |
---|---|
out |
Parcel
|
flags |
int
|