Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public final class

MediaItemStatus

extends Object
java.lang.Object
   ↳ android.support.v7.media.MediaItemStatus

Class Overview

Describes the playback status of a media item.

This class is part of the remote playback protocol described by the MediaControlIntent class.

As a media item is played, it transitions through a sequence of states including: pending , buffering , playing , paused , finished , canceled , invalidated , and error . Refer to the documentation of each state for an explanation of its meaning.

While the item is playing, the playback status may also include progress information about the content position and content duration although not all route destinations will report it.

To monitor playback status, the application should supply a PendingIntent to use as the item status update receiver for a given playback request . Note that the status update receiver will only be invoked for major status changes such as a transition from playing to finished.

The status update receiver will not be invoked for minor progress updates such as changes to playback position or duration. If the application wants to monitor playback progress, then it must use the get status request to poll for changes periodically and estimate the playback position while playing. Note that there may be a significant power impact to polling so the application is advised only to poll when the screen is on and never more than about once every 5 seconds or so.

This object is immutable once created using a MediaItemStatus.Builder instance.

Summary

Nested Classes
class MediaItemStatus.Builder Builder for media item status objects . 
Constants
String EXTRA_HTTP_RESPONSE_HEADERS Bundle extra: HTTP response headers.
String EXTRA_HTTP_STATUS_CODE Integer extra: HTTP status code.
int PLAYBACK_STATE_BUFFERING Playback state: Buffering or seeking to a new position.
int PLAYBACK_STATE_CANCELED Playback state: Canceled.
int PLAYBACK_STATE_ERROR Playback state: Playback halted or aborted due to an error.
int PLAYBACK_STATE_FINISHED Playback state: Finished.
int PLAYBACK_STATE_INVALIDATED Playback state: Invalidated.
int PLAYBACK_STATE_PAUSED Playback state: Paused.
int PLAYBACK_STATE_PENDING Playback state: Pending.
int PLAYBACK_STATE_PLAYING Playback state: Playing.
Public Methods
Bundle asBundle ()
Converts this object to a bundle for serialization.
static MediaItemStatus fromBundle ( Bundle bundle)
Creates an instance from a bundle.
long getContentDuration ()
Gets the total duration of the content to be played as a long integer number of milliseconds.
long getContentPosition ()
Gets the content playback position as a long integer number of milliseconds from the beginning of the content.
Bundle getExtras ()
Gets a bundle of extras for this status object.
int getPlaybackState ()
Gets the playback state of the media item.
long getTimestamp ()
Gets the timestamp associated with the status information in milliseconds since boot in the elapsedRealtime() time base.
String toString ()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String EXTRA_HTTP_RESPONSE_HEADERS

Bundle extra: HTTP response headers.

Specifies the HTTP response headers that were returned when the content was requested from the network. The headers may include additional information about the content or any errors conditions that were encountered while trying to fetch the content.

The value is a Bundle of string based key-value pairs that describe the HTTP response headers.

Constant Value: "android.media.status.extra.HTTP_RESPONSE_HEADERS"

public static final String EXTRA_HTTP_STATUS_CODE

Integer extra: HTTP status code.

Specifies the HTTP status code that was encountered when the content was requested after all redirects were followed. This key only needs to specified when the content uri uses the HTTP or HTTPS scheme and an error occurred. This key may be omitted if the content was able to be played successfully; there is no need to report a 200 (OK) status code.

The value is an integer HTTP status code, such as 401 (Unauthorized), 404 (Not Found), or 500 (Server Error), or 0 if none.

Constant Value: "android.media.status.extra.HTTP_STATUS_CODE"

public static final int PLAYBACK_STATE_BUFFERING

Playback state: Buffering or seeking to a new position.

Indicates that the media item has been temporarily interrupted to fetch more content. Playback will continue automatically when enough content has been buffered.

Constant Value: 3 (0x00000003)

public static final int PLAYBACK_STATE_CANCELED

Playback state: Canceled.

Indicates that the media item was explicitly removed from the queue by the application. Items may be canceled and removed from the queue using the remove or stop action or by issuing another play action that has the side-effect of clearing the queue.

A canceled media item cannot be resumed. To play the content again, the application must send a new play or enqueue action.

Constant Value: 5 (0x00000005)

public static final int PLAYBACK_STATE_ERROR

Playback state: Playback halted or aborted due to an error.

Examples of errors are no network connectivity when attempting to retrieve content from a server, or expired user credentials when trying to play subscription-based content.

A media item in the error state cannot be resumed. To play the content again, the application must send a new play or enqueue action.

Constant Value: 7 (0x00000007)

public static final int PLAYBACK_STATE_FINISHED

Playback state: Finished.

Indicates that the media item played to the end of the content and finished normally.

A finished media item cannot be resumed. To play the content again, the application must send a new play or enqueue action.

Constant Value: 4 (0x00000004)

public static final int PLAYBACK_STATE_INVALIDATED

Playback state: Invalidated.

Indicates that the media item was invalidated permanently and involuntarily. This state is used to indicate that the media item was invalidated and removed from the queue because the session to which it belongs was invalidated (typically by another application taking control of the route).

When invalidation occurs, the application should generally wait for the user to perform an explicit action, such as clicking on a play button in the UI, before creating a new media session to avoid unnecessarily interrupting another application that may have just started using the route.

An invalidated media item cannot be resumed. To play the content again, the application must send a new play or enqueue action.

Constant Value: 6 (0x00000006)

public static final int PLAYBACK_STATE_PAUSED

Playback state: Paused.

Indicates that playback of the media item has been paused. Playback can be resumed using the resume action.

Constant Value: 2 (0x00000002)

public static final int PLAYBACK_STATE_PENDING

Playback state: Pending.

Indicates that the media item has not yet started playback but will be played eventually.

Constant Value: 0 (0x00000000)

public static final int PLAYBACK_STATE_PLAYING

Playback state: Playing.

Indicates that the media item is currently playing.

Constant Value: 1 (0x00000001)

Public Methods

public Bundle asBundle ()

Converts this object to a bundle for serialization.

Returns
  • The contents of the object represented as a bundle.

public static MediaItemStatus fromBundle ( Bundle bundle)

Creates an instance from a bundle.

Parameters
bundle The bundle, or null if none.
Returns
  • The new instance, or null if the bundle was null.

public long getContentDuration ()

Gets the total duration of the content to be played as a long integer number of milliseconds.

Returns
  • The content duration in milliseconds, or -1 if unknown.

public long getContentPosition ()

Gets the content playback position as a long integer number of milliseconds from the beginning of the content.

Returns
  • The content playback position in milliseconds, or -1 if unknown.

public Bundle getExtras ()

Gets a bundle of extras for this status object. The extras will be ignored by the media router but they may be used by applications.

public int getPlaybackState ()

Gets the playback state of the media item.

Returns

public long getTimestamp ()

Gets the timestamp associated with the status information in milliseconds since boot in the elapsedRealtime() time base.

Returns

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

          getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.