Topics covered here are: *
* * *The playback control of audio/video files is managed as a state machine.
*
The MediaPlayer2 object has five states:
*{@link #PLAYER_STATE_IDLE}: MediaPlayer2 is in the Idle * state after you create it using * {@link #create(Context)}, or after calling {@link #reset()}.
* *While in this state, you should call
* {@link #setDataSource(DataSourceDesc2) setDataSource()}. It is a good
* programming practice to register an {@link EventCallback#onCallCompleted onCallCompleted}
* callback and watch for {@link #CALL_STATUS_BAD_VALUE} and
* {@link #CALL_STATUS_ERROR_IO}, which might be caused by setDataSource.
*
Calling {@link #prepare()} transfers a MediaPlayer2 object to * the Prepared state. Note * that {@link #prepare()} is asynchronous. When the preparation completes, * If you register a {@link EventCallback#onInfo} callback * the player executes the callback * with {@link #MEDIA_INFO_PREPARED} before transitioning to the * Prepared state.
*The player plays the data source while in this state. * If you register an {@link EventCallback#onInfo} callback * the player regularly executes the callback with * {@link #MEDIA_INFO_BUFFERING_UPDATE}. * This allows applications to keep track of the buffering status * while streaming audio/video.
* *When the playback reaches the end of stream, the behavior depends on whether or * not you've enabled looping by calling {@link #loopCurrent(boolean)}:
*false the player will transfer
* to the Paused state. If you registered an {@link EventCallback#onInfo}
* callback
* the player calls the callback with {@link #MEDIA_INFO_DATA_SOURCE_END} before entering
* the Paused state.
* true,
* the MediaPlayer2 object remains in the Playing state and replays its
* data source from the beginning.In general, playback might fail due to various * reasons such as unsupported audio/video format, poorly interleaved * audio/video, resolution too high, streaming timeout, and others. * In addition, due to programming errors, a playback * control operation might be performed from an invalid state. * In these cases the player transitions to the Error state.
* *If you register an {@link EventCallback#onError}} callback * the callback will be performed when entering the state. When programming errors happen, * such as calling {@link #prepare()} and {@link #setDataSource(DataSourceDesc2)} methods * from an invalid state, The callback is called with * {@link #CALL_STATUS_INVALID_OPERATION} . The MediaPlayer2 object enters the * Error whether or not a callback exists.
* *To recover from an error and reuse a MediaPlayer2 object that is in the * Error state, * call {@link #reset()}. The object will return to the Idle * state and all state information will be lost.
*You should follow these best practices when coding an app that uses MediaPlayer2:
* *The only methods you safely call from the Error state are {@link #close()}, * {@link #reset()}, {@link #notifyWhenCommandLabelReached}, {@link #clearPendingCommands()}, * {@link #setEventCallback}, {@link #clearEventCallback()} and {@link #getState()}. * Any other methods might throw an exception, return meaningless data, or invoke a * {@link EventCallback#onCallCompleted} with an error code.
* *Most methods can be called from any non-Error state. They will either perform their work or * silently have no effect. The following table lists the methods that will invoke a * {@link EventCallback#onCallCompleted} with an error code or throw an exception when they are * called from the associated invalid states.
* *| Method Name | *Invalid States |
|---|---|
| setDataSource | {Prepared, Paused, Playing} |
| prepare | {Prepared, Paused, Playing} |
| play | {Idle} |
| pause | {Idle} |
| seekTo | {Idle} |
| getCurrentPosition | {Idle} |
| getDuration | {Idle} |
| getBufferedPosition | {Idle} |
| getTrackInfo | {Idle} |
| getSelectedTrack | {Idle} |
| selectTrack | {Idle} |
| deselectTrack | {Idle} |
This class requires the {@link android.Manifest.permission#INTERNET} permission * when used with network-based content. * *
Many errors do not result in a transition to the Error state. * It is good programming practice to register callback listeners using * {@link #setEventCallback(Executor, EventCallback)} and * {@link #setDrmEventCallback(Executor, DrmEventCallback)}). * You can receive a callback at any time and from any state.
* *If it's important for your app to respond to state changes (for instance, to update the
* controls on a transport UI), you should register an {@link EventCallback#onCallCompleted} and
* detect state change commands by testing the what parameter for a callback from one
* of the state transition methods: {@link #CALL_COMPLETED_PREPARE}, {@link #CALL_COMPLETED_PLAY},
* and {@link #CALL_COMPLETED_PAUSE}.
* Then check the status parameter. The value {@link #CALL_STATUS_NO_ERROR} indicates a
* successful transition. Any other value will be an error. Call {@link #getState()} to
* determine the current state.
* (You can also register a {@link MediaPlayerConnector.PlayerEventCallback#onPlayerStateChanged}
* callback but this method does not distinguish between the Idle and
* Prepared states.)
You can also register a {@link MediaPlayerConnector.PlayerEventCallback#onPlayerStateChanged} * callback. Call {@link #getState()} from your code to determine the state.
* *In order for callbacks to work, your app must create * MediaPlayer2 objects on a thread that has its own running Looper. This can be done on the main UI * thread, which has a Looper.
*/ @TargetApi(Build.VERSION_CODES.P) public abstract class MediaPlayer2 { /** * Create a MediaPlayer2 object. * * @param context The context the player is running in * @return A MediaPlayer2 object created */ public static final MediaPlayer2 create(@NonNull Context context) { return new MediaPlayer2Impl(); } /** * @hide */ @RestrictTo(LIBRARY_GROUP) public MediaPlayer2() { } /** * Returns a {@link MediaPlayerConnector} implementation which runs based on * this MediaPlayer2 instance. */ public abstract MediaPlayerConnector getMediaPlayerConnector(); /** * Releases the resources held by this {@code MediaPlayer2} object. * * It is considered good practice to call this method when you're * done using the MediaPlayer2. In particular, whenever an Activity * of an application is paused (its onPause() method is called), * or stopped (its onStop() method is called), this method should be * invoked to release the MediaPlayer2 object, unless the application * has a special need to keep the object around. In addition to * unnecessary resources (such as memory and instances of codecs) * being held, failure to call this method immediately if a * MediaPlayer2 object is no longer needed may also lead to * continuous battery consumption for mobile devices, and playback * failure for other applications if no multiple instances of the * same codec are supported on a device. Even if multiple instances * of the same codec are supported, some performance degradation * may be expected when unnecessary multiple instances are used * at the same time. */ // This is a synchronous call. public abstract void close(); /** * Starts or resumes playback. If playback had previously been paused, * playback will continue from where it was paused. If playback had * reached end of stream and been paused, or never started before, * playback will start at the beginning. If the source had not been * prepared, the player will prepare the source and play. * */ // This is an asynchronous call. public abstract void play(); /** * Prepares the player for playback, asynchronously. * * After setting the datasource and the display surface, you need to * call prepare(). * */ // This is an asynchronous call. public abstract void prepare(); /** * Pauses playback. Call play() to resume. */ // This is an asynchronous call. public abstract void pause(); /** * Tries to play next data source if applicable. */ // This is an asynchronous call. public abstract void skipToNext(); /** * Moves the media to specified time position. * Same as {@link #seekTo(long, int)} with {@code mode = SEEK_PREVIOUS_SYNC}. * * @param msec the offset in milliseconds from the start to seek to */ // This is an asynchronous call. public void seekTo(long msec) { seekTo(msec, SEEK_PREVIOUS_SYNC /* mode */); } /** * Gets the current playback position. * * @return the current position in milliseconds */ public abstract long getCurrentPosition(); /** * Gets the duration of the file. * * @return the duration in milliseconds, if no duration is available * (for example, if streaming live content), -1 is returned. */ public abstract long getDuration(); /** * Gets the current buffered media source position received through progressive downloading. * The received buffering percentage indicates how much of the content has been buffered * or played. For example a buffering update of 80 percent when half the content * has already been played indicates that the next 30 percent of the * content to play has been buffered. * * @return the current buffered media source position in milliseconds */ public abstract long getBufferedPosition(); /** * Gets the current MediaPlayer2 state. * * @return the current MediaPlayer2 state. */ public abstract @MediaPlayer2State int getState(); /** * Sets the audio attributes for this MediaPlayer2. * See {@link AudioAttributesCompat} for how to build and configure an instance of this class. * You must call this method before {@link #prepare()} in order * for the audio attributes to become effective thereafter. * @param attributes a non-null set of audio attributes */ // This is an asynchronous call. public abstract void setAudioAttributes(@NonNull AudioAttributesCompat attributes); /** * Gets the audio attributes for this MediaPlayer2. * @return attributes a set of audio attributes */ public abstract @Nullable AudioAttributesCompat getAudioAttributes(); /** * Sets the data source as described by a DataSourceDesc2. * * @param dsd the descriptor of data source you want to play */ // This is an asynchronous call. public abstract void setDataSource(@NonNull DataSourceDesc2 dsd); /** * Sets a single data source as described by a DataSourceDesc2 which will be played * after current data source is finished. * * @param dsd the descriptor of data source you want to play after current one */ // This is an asynchronous call. public abstract void setNextDataSource(@NonNull DataSourceDesc2 dsd); /** * Sets a list of data sources to be played sequentially after current data source is done. * * @param dsds the list of data sources you want to play after current one */ // This is an asynchronous call. public abstract void setNextDataSources(@NonNull List* When seekTo is finished, the user will be notified via * {@link EventCallback#onInfo} with {@link #CALL_COMPLETED_SEEK_TO}. * There is at most one active seekTo processed at any time. If there is a to-be-completed * seekTo, new seekTo requests will be queued in such a way that only the last request * is kept. When current seekTo is completed, the queued request will be processed if * that request is different from just-finished seekTo operation, i.e., the requested * position or mode is different. * * @param msec the offset in milliseconds from the start to seek to. * When seeking to the given time position, there is no guarantee that the data source * has a frame located at the position. When this happens, a frame nearby will be rendered. * If msec is negative, time position zero will be used. * If msec is larger than duration, duration will be used. * @param mode the mode indicating where exactly to seek to. */ // This is an asynchronous call. public abstract void seekTo(long msec, @SeekMode int mode); /** * Gets current playback position as a {@link MediaTimestamp2}. *
* The MediaTimestamp2 represents how the media time correlates to the system time in * a linear fashion using an anchor and a clock rate. During regular playback, the media * time moves fairly constantly (though the anchor frame may be rebased to a current * system time, the linear correlation stays steady). Therefore, this method does not * need to be called often. *
* To help users get current playback position, this method always anchors the timestamp
* to the current {@link System#nanoTime system time}, so
* {@link MediaTimestamp2#getAnchorMediaTimeUs} can be used as current playback position.
*
* @return a MediaTimestamp2 object if a timestamp is available, or {@code null} if no timestamp
* is available, e.g. because the media player has not been initialized.
*
* @see MediaTimestamp2
*/
@Nullable
public abstract MediaTimestamp2 getTimestamp();
/**
* Resets the MediaPlayer2 to its uninitialized state. After calling
* this method, you will have to initialize it again by setting the
* data source and calling prepare().
*/
// This is a synchronous call.
public abstract void reset();
/**
* Sets the audio session ID.
*
* @param sessionId the audio session ID.
* The audio session ID is a system wide unique identifier for the audio stream played by
* this MediaPlayer2 instance.
* The primary use of the audio session ID is to associate audio effects to a particular
* instance of MediaPlayer2: if an audio session ID is provided when creating an audio effect,
* this effect will be applied only to the audio content of media players within the same
* audio session and not to the output mix.
* When created, a MediaPlayer2 instance automatically generates its own audio session ID.
* However, it is possible to force this player to be part of an already existing audio session
* by calling this method.
* This method must be called before one of the overloaded setDataSource methods.
*/
// This is an asynchronous call.
public abstract void setAudioSessionId(int sessionId);
/**
* Returns the audio session ID.
*
* @return the audio session ID. {@see #setAudioSessionId(int)}
* Note that the audio session ID is 0 only if a problem occured when the MediaPlayer2 was
* contructed.
*/
public abstract int getAudioSessionId();
/**
* Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation
* effect which can be applied on any sound source that directs a certain amount of its
* energy to this effect. This amount is defined by setAuxEffectSendLevel().
* See {@link #setAuxEffectSendLevel(float)}.
*
After creating an auxiliary effect (e.g. * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method * to attach the player to the effect. *
To detach the effect from the player, call this method with a null effect id. *
This method must be called after one of the overloaded setDataSource
* methods.
* @param effectId system wide unique id of the effect to attach
*/
// This is an asynchronous call.
public abstract void attachAuxEffect(int effectId);
/**
* Sets the send level of the player to the attached auxiliary effect.
* See {@link #attachAuxEffect(int)}. The level value range is 0 to 1.0.
*
By default the send level is 0, so even if an effect is attached to the player * this method must be called for the effect to be applied. *
Note that the passed level value is a raw scalar. UI controls should be scaled
* logarithmically: the gain applied by audio framework ranges from -72dB to 0dB,
* so an appropriate conversion from linear UI input x to level is:
* x == 0 -> level = 0
* 0 < x <= R -> level = 10^(72*(x-R)/20/R)
* @param level send level scalar
*/
// This is an asynchronous call.
public abstract void setAuxEffectSendLevel(float level);
/**
* Class for MediaPlayer2 to return each audio/video/subtitle track's metadata.
*
* @see MediaPlayer2#getTrackInfo
*/
public abstract static class TrackInfo {
/**
* Gets the track type.
* @return TrackType which indicates if the track is video, audio, timed text.
*/
public abstract int getTrackType();
/**
* Gets the language code of the track.
* @return a language code in either way of ISO-639-1 or ISO-639-2.
* When the language is unknown or could not be determined,
* ISO-639-2 language code, "und", is returned.
*/
public abstract String getLanguage();
/**
* Gets the {@link MediaFormat} of the track. If the format is
* unknown or could not be determined, null is returned.
*/
public abstract MediaFormat getFormat();
public static final int MEDIA_TRACK_TYPE_UNKNOWN = 0;
public static final int MEDIA_TRACK_TYPE_VIDEO = 1;
public static final int MEDIA_TRACK_TYPE_AUDIO = 2;
/** @hide */
@RestrictTo(LIBRARY_GROUP)
public static final int MEDIA_TRACK_TYPE_TIMEDTEXT = 3;
public static final int MEDIA_TRACK_TYPE_SUBTITLE = 4;
public static final int MEDIA_TRACK_TYPE_METADATA = 5;
@Override
public abstract String toString();
};
/**
* Returns a List of track information.
*
* @return List of track info. The total number of tracks is the array length.
* Must be called again if an external timed text source has been added after
* addTimedTextSource method is called.
*/
public abstract List
* If a MediaPlayer2 is in invalid state, {@link #CALL_STATUS_INVALID_OPERATION} will be
* reported with {@link EventCallback#onCallCompleted}.
* If a MediaPlayer2 is in Playing state, the selected track is presented immediately.
* If a MediaPlayer2 is not in Started state, it just marks the track to be played.
*
* In any valid state, if it is called multiple times on the same type of track (ie. Video,
* Audio, Timed Text), the most recent one will be chosen.
*
* The first audio and video tracks are selected by default if available, even though
* this method is not called. However, no timed text track will be selected until
* this function is called.
*
* Currently, only timed text tracks or audio tracks can be selected via this method.
*
* Currently, the track must be a timed text track and no audio or video tracks can be
* deselected. If the timed text track identified by index has not been
* selected before, it throws an exception.
*
* This method will be called as timed metadata is extracted from the media,
* in the same order as it occurs in the media. The timing of this event is
* not controlled by the associated timestamp.
*
* Currently only HTTP live streaming data URI's embedded with timed ID3 tags generates
* {@link TimedMetaData2}.
*
* @see MediaPlayer2#selectTrack(int)
* @see TimedMetaData2
*
* @param mp the MediaPlayer2 associated with this callback
* @param dsd the DataSourceDesc2 of this data source
* @param data the timed metadata sample associated with this event
*/
public void onTimedMetaDataAvailable(
MediaPlayer2 mp, DataSourceDesc2 dsd, TimedMetaData2 data) { }
/**
* Called to indicate an error.
*
* @param mp the MediaPlayer2 the error pertains to
* @param dsd the DataSourceDesc2 of this data source
* @param what the type of error that has occurred.
* @param extra an extra code, specific to the error. Typically
* implementation dependent.
*/
public void onError(
MediaPlayer2 mp, DataSourceDesc2 dsd, @MediaError int what, int extra) { }
/**
* Called to indicate an info or a warning.
*
* @param mp the MediaPlayer2 the info pertains to.
* @param dsd the DataSourceDesc2 of this data source
* @param what the type of info or warning.
* @param extra an extra code, specific to the info. Typically
* implementation dependent.
*/
public void onInfo(MediaPlayer2 mp, DataSourceDesc2 dsd, @MediaInfo int what, int extra) { }
/**
* Called to acknowledge an API call.
*
* @param mp the MediaPlayer2 the call was made on.
* @param dsd the DataSourceDesc2 of this data source
* @param what the enum for the API call.
* @param status the returned status code for the call.
*/
public void onCallCompleted(
MediaPlayer2 mp, DataSourceDesc2 dsd, @CallCompleted int what,
@CallStatus int status) { }
/**
* Called when a discontinuity in the normal progression of the media time is detected.
* The "normal progression" of media time is defined as the expected increase of the
* playback position when playing media, relative to the playback speed (for instance every
* second, media time increases by two seconds when playing at 2x).
*
* DRM preparation has succeeded.
*/
public static final int PREPARE_DRM_STATUS_SUCCESS = 0;
/**
* The device required DRM provisioning but couldn't reach the provisioning server.
*/
public static final int PREPARE_DRM_STATUS_PROVISIONING_NETWORK_ERROR = 1;
/**
* The device required DRM provisioning but the provisioning server denied the request.
*/
public static final int PREPARE_DRM_STATUS_PROVISIONING_SERVER_ERROR = 2;
/**
* The DRM preparation has failed.
*/
public static final int PREPARE_DRM_STATUS_PREPARATION_ERROR = 3;
/**
* The crypto scheme UUID that is not supported by the device.
*/
public static final int PREPARE_DRM_STATUS_UNSUPPORTED_SCHEME = 4;
/**
* The hardware resources are not available, due to being in use.
*/
public static final int PREPARE_DRM_STATUS_RESOURCE_BUSY = 5;
/** @hide */
@IntDef(flag = false, /*prefix = "PREPARE_DRM_STATUS",*/ value = {
PREPARE_DRM_STATUS_SUCCESS,
PREPARE_DRM_STATUS_PROVISIONING_NETWORK_ERROR,
PREPARE_DRM_STATUS_PROVISIONING_SERVER_ERROR,
PREPARE_DRM_STATUS_PREPARATION_ERROR,
PREPARE_DRM_STATUS_UNSUPPORTED_SCHEME,
PREPARE_DRM_STATUS_RESOURCE_BUSY,
})
@Retention(RetentionPolicy.SOURCE)
@RestrictTo(LIBRARY_GROUP)
public @interface PrepareDrmStatusCode {}
/**
* Retrieves the DRM Info associated with the current source
*
* @throws IllegalStateException if called before being prepared
*/
public abstract DrmInfo getDrmInfo();
/**
* Prepares the DRM for the current source
*
* If {@link OnDrmConfigHelper} is registered, it will be called during
* preparation to allow configuration of the DRM properties before opening the
* DRM session. Note that the callback is called synchronously in the thread that called
* {@link #prepareDrm}. It should be used only for a series of {@code getDrmPropertyString}
* and {@code setDrmPropertyString} calls and refrain from any lengthy operation.
*
* If the device has not been provisioned before, this call also provisions the device
* which involves accessing the provisioning server and can take a variable time to
* complete depending on the network connectivity.
* prepareDrm() runs in non-blocking mode by launching the provisioning in the background and
* returning. {@link DrmEventCallback#onDrmPrepared} will be called when provisioning and
* preparation has finished. The application should check the status code returned with
* {@link DrmEventCallback#onDrmPrepared} to proceed.
*
*
* @param uuid The UUID of the crypto scheme. If not known beforehand, it can be retrieved
* from the source through {#link getDrmInfo} or registering
* {@link DrmEventCallback#onDrmInfo}.
*/
// This is an asynchronous call.
public abstract void prepareDrm(@NonNull UUID uuid);
/**
* Releases the DRM session
*
* The player has to have an active DRM session and be in stopped, or prepared
* state before this call is made.
* A {@code reset()} call will release the DRM session implicitly.
*
* @throws NoDrmSchemeException if there is no active DRM session to release
*/
// This is an asynchronous call.
public abstract void releaseDrm() throws NoDrmSchemeException;
/**
* A key request/response exchange occurs between the app and a license server
* to obtain or release keys used to decrypt encrypted content.
*
* getDrmKeyRequest() is used to obtain an opaque key request byte array that is
* delivered to the license server. The opaque key request byte array is returned
* in KeyRequest.data. The recommended URL to deliver the key request to is
* returned in KeyRequest.defaultUrl.
*
* After the app has received the key request response from the server,
* it should deliver to the response to the DRM engine plugin using the method
* {@link #provideDrmKeyResponse}.
*
* @param keySetId is the key-set identifier of the offline keys being released when keyType is
* {@link MediaDrm#KEY_TYPE_RELEASE}. It should be set to null for other key requests, when
* keyType is {@link MediaDrm#KEY_TYPE_STREAMING} or {@link MediaDrm#KEY_TYPE_OFFLINE}.
*
* @param initData is the container-specific initialization data when the keyType is
* {@link MediaDrm#KEY_TYPE_STREAMING} or {@link MediaDrm#KEY_TYPE_OFFLINE}. Its meaning is
* interpreted based on the mime type provided in the mimeType parameter. It could
* contain, for example, the content ID, key ID or other data obtained from the content
* metadata that is required in generating the key request.
* When the keyType is {@link MediaDrm#KEY_TYPE_RELEASE}, it should be set to null.
*
* @param mimeType identifies the mime type of the content
*
* @param keyType specifies the type of the request. The request may be to acquire
* keys for streaming, {@link MediaDrm#KEY_TYPE_STREAMING}, or for offline content
* {@link MediaDrm#KEY_TYPE_OFFLINE}, or to release previously acquired
* keys ({@link MediaDrm#KEY_TYPE_RELEASE}), which are identified by a keySetId.
*
* @param optionalParameters are included in the key request message to
* allow a client application to provide additional message parameters to the server.
* This may be {@code null} if no additional parameters are to be sent.
*
* @throws NoDrmSchemeException if there is no active DRM session
*/
@NonNull
public abstract MediaDrm.KeyRequest getDrmKeyRequest(
@Nullable byte[] keySetId, @Nullable byte[] initData,
@Nullable String mimeType, int keyType,
@Nullable Map
* @param propertyName the property name
*
* Standard fields names are:
* {@link MediaDrm#PROPERTY_VENDOR}, {@link MediaDrm#PROPERTY_VERSION},
* {@link MediaDrm#PROPERTY_DESCRIPTION}, {@link MediaDrm#PROPERTY_ALGORITHMS}
*/
@NonNull
public abstract String getDrmPropertyString(
@NonNull String propertyName)
throws NoDrmSchemeException;
/**
* Set a DRM engine plugin String property value.
*
* @param propertyName the property name
* @param value the property value
*
* Standard fields names are:
* {@link MediaDrm#PROPERTY_VENDOR}, {@link MediaDrm#PROPERTY_VERSION},
* {@link MediaDrm#PROPERTY_DESCRIPTION}, {@link MediaDrm#PROPERTY_ALGORITHMS}
*/
// This is a synchronous call.
public abstract void setDrmPropertyString(
@NonNull String propertyName, @NonNull String value)
throws NoDrmSchemeException;
/**
* Encapsulates the DRM properties of the source.
*/
public abstract static class DrmInfo {
/**
* Returns the PSSH info of the data source for each supported DRM scheme.
*/
public abstract Map
* Discontinuities are encountered in the following cases:
*
*
*
* @param mp the MediaPlayer2 the media time pertains to.
* @param dsd the DataSourceDesc2 of this data source
* @param timestamp the timestamp that correlates media time, system time and clock rate,
* or {@link MediaTimestamp2#TIMESTAMP_UNKNOWN} in an error case.
*/
public void onMediaTimeDiscontinuity(
MediaPlayer2 mp, DataSourceDesc2 dsd, MediaTimestamp2 timestamp) { }
/**
* Called to indicate {@link #notifyWhenCommandLabelReached(Object)} has been processed.
*
* @param mp the MediaPlayer2 {@link #notifyWhenCommandLabelReached(Object)} was called on.
* @param label the application specific Object given by
* {@link #notifyWhenCommandLabelReached(Object)}.
*/
public void onCommandLabelReached(MediaPlayer2 mp, @NonNull Object label) { }
/**
* Called when when a player subtitle track has new subtitle data available.
* @param mp the player that reports the new subtitle data
* @param dsd the DataSourceDesc2 of this data source
* @param data the subtitle data
*/
public void onSubtitleData(
MediaPlayer2 mp, DataSourceDesc2 dsd, @NonNull SubtitleData2 data) { }
}
/**
* Sets the callback to be invoked when the media source is ready for playback.
*
* @param eventCallback the callback that will be run
* @param executor the executor through which the callback should be invoked
*/
// This is a synchronous call.
public abstract void setEventCallback(
@NonNull Executor executor, @NonNull EventCallback eventCallback);
/**
* Clears the {@link EventCallback}.
*/
// This is a synchronous call.
public abstract void clearEventCallback();
/**
* MediaPlayer2 has not been prepared or just has been reset.
* In this state, MediaPlayer2 doesn't fetch data.
*/
public static final int PLAYER_STATE_IDLE = 1001;
/**
* MediaPlayer2 has been just prepared.
* In this state, MediaPlayer2 just fetches data from media source,
* but doesn't actively render data.
*/
public static final int PLAYER_STATE_PREPARED = 1002;
/**
* MediaPlayer2 is paused.
* In this state, MediaPlayer2 doesn't actively render data.
*/
public static final int PLAYER_STATE_PAUSED = 1003;
/**
* MediaPlayer2 is actively playing back data.
*/
public static final int PLAYER_STATE_PLAYING = 1004;
/**
* MediaPlayer2 has hit some fatal error and cannot continue playback.
*/
public static final int PLAYER_STATE_ERROR = 1005;
/** @hide */
@IntDef(flag = false, value = {
PLAYER_STATE_IDLE,
PLAYER_STATE_PREPARED,
PLAYER_STATE_PAUSED,
PLAYER_STATE_PLAYING,
PLAYER_STATE_ERROR})
@Retention(RetentionPolicy.SOURCE)
@RestrictTo(LIBRARY_GROUP)
public @interface MediaPlayer2State {}
/* Do not change these values without updating their counterparts
* in include/media/mediaplayer2.h!
*/
/** Unspecified media player error.
* @see EventCallback#onError
*/
public static final int MEDIA_ERROR_UNKNOWN = 1;
/** The video is streamed and its container is not valid for progressive
* playback i.e the video's index (e.g moov atom) is not at the start of the
* file.
* @see EventCallback#onError
*/
public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200;
/** File or network related operation errors. */
public static final int MEDIA_ERROR_IO = -1004;
/** Bitstream is not conforming to the related coding standard or file spec. */
public static final int MEDIA_ERROR_MALFORMED = -1007;
/** Bitstream is conforming to the related coding standard or file spec, but
* the media framework does not support the feature. */
public static final int MEDIA_ERROR_UNSUPPORTED = -1010;
/** Some operation takes too long to complete, usually more than 3-5 seconds. */
public static final int MEDIA_ERROR_TIMED_OUT = -110;
/** Unspecified low-level system error. This value originated from UNKNOWN_ERROR in
* system/core/include/utils/Errors.h
* @see EventCallback#onError
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
public static final int MEDIA_ERROR_SYSTEM = -2147483648;
/**
* @hide
*/
@IntDef(flag = false, /*prefix = "MEDIA_ERROR",*/ value = {
MEDIA_ERROR_UNKNOWN,
MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK,
MEDIA_ERROR_IO,
MEDIA_ERROR_MALFORMED,
MEDIA_ERROR_UNSUPPORTED,
MEDIA_ERROR_TIMED_OUT,
MEDIA_ERROR_SYSTEM
})
@Retention(RetentionPolicy.SOURCE)
@RestrictTo(LIBRARY_GROUP)
public @interface MediaError {}
/** Unspecified media player info.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_UNKNOWN = 1;
/** The player just started the playback of this data source.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_DATA_SOURCE_START = 2;
/** The player just pushed the very first video frame for rendering.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_VIDEO_RENDERING_START = 3;
/** The player just rendered the very first audio sample.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_AUDIO_RENDERING_START = 4;
/** The player just completed the playback of this data source.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_DATA_SOURCE_END = 5;
/** The player just completed the playback of all the data sources set by {@link #setDataSource}
* , {@link #setNextDataSource} and {@link #setNextDataSources}.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_DATA_SOURCE_LIST_END = 6;
/** The player just completed an iteration of playback loop. This event is sent only when
* looping is enabled by {@link #loopCurrent}.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_DATA_SOURCE_REPEAT = 7;
/** The player just prepared a data source.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_PREPARED = 100;
/** The video is too complex for the decoder: it can't decode frames fast
* enough. Possibly only the audio plays fine at this stage.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700;
/** MediaPlayer2 is temporarily pausing playback internally in order to
* buffer more data.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_BUFFERING_START = 701;
/** MediaPlayer2 is resuming playback after filling buffers.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_BUFFERING_END = 702;
/** Estimated network bandwidth information (kbps) is available; currently this event fires
* simultaneously as {@link #MEDIA_INFO_BUFFERING_START} and {@link #MEDIA_INFO_BUFFERING_END}
* when playing network files.
* @see EventCallback#onInfo
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
public static final int MEDIA_INFO_NETWORK_BANDWIDTH = 703;
/**
* Update status in buffering a media source received through progressive downloading.
* The received buffering percentage indicates how much of the content has been buffered
* or played. For example a buffering update of 80 percent when half the content
* has already been played indicates that the next 30 percent of the
* content to play has been buffered.
*
* The {@code extra} parameter in {@link EventCallback#onInfo} is the
* percentage (0-100) of the content that has been buffered or played thus far.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_BUFFERING_UPDATE = 704;
/** Bad interleaving means that a media has been improperly interleaved or
* not interleaved at all, e.g has all the video samples first then all the
* audio ones. Video is playing but a lot of disk seeks may be happening.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_BAD_INTERLEAVING = 800;
/** The media cannot be seeked (e.g live stream)
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_NOT_SEEKABLE = 801;
/** A new set of metadata is available.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_METADATA_UPDATE = 802;
/** A new set of external-only metadata is available. Used by
* JAVA framework to avoid triggering track scanning.
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
public static final int MEDIA_INFO_EXTERNAL_METADATA_UPDATE = 803;
/** Informs that audio is not playing. Note that playback of the video
* is not interrupted.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_AUDIO_NOT_PLAYING = 804;
/** Informs that video is not playing. Note that playback of the audio
* is not interrupted.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_VIDEO_NOT_PLAYING = 805;
/** Failed to handle timed text track properly.
* @see EventCallback#onInfo
* {@hide}
*/
@RestrictTo(LIBRARY_GROUP)
public static final int MEDIA_INFO_TIMED_TEXT_ERROR = 900;
/** Subtitle track was not supported by the media framework.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_UNSUPPORTED_SUBTITLE = 901;
/** Reading the subtitle track takes too long.
* @see EventCallback#onInfo
*/
public static final int MEDIA_INFO_SUBTITLE_TIMED_OUT = 902;
/**
* @hide
*/
@IntDef(flag = false, /*prefix = "MEDIA_INFO",*/ value = {
MEDIA_INFO_UNKNOWN,
MEDIA_INFO_DATA_SOURCE_START,
MEDIA_INFO_VIDEO_RENDERING_START,
MEDIA_INFO_AUDIO_RENDERING_START,
MEDIA_INFO_DATA_SOURCE_END,
MEDIA_INFO_DATA_SOURCE_LIST_END,
MEDIA_INFO_DATA_SOURCE_REPEAT,
MEDIA_INFO_PREPARED,
MEDIA_INFO_VIDEO_TRACK_LAGGING,
MEDIA_INFO_BUFFERING_START,
MEDIA_INFO_BUFFERING_END,
MEDIA_INFO_NETWORK_BANDWIDTH,
MEDIA_INFO_BUFFERING_UPDATE,
MEDIA_INFO_BAD_INTERLEAVING,
MEDIA_INFO_NOT_SEEKABLE,
MEDIA_INFO_METADATA_UPDATE,
MEDIA_INFO_EXTERNAL_METADATA_UPDATE,
MEDIA_INFO_AUDIO_NOT_PLAYING,
MEDIA_INFO_VIDEO_NOT_PLAYING,
MEDIA_INFO_TIMED_TEXT_ERROR,
MEDIA_INFO_UNSUPPORTED_SUBTITLE,
MEDIA_INFO_SUBTITLE_TIMED_OUT
})
@Retention(RetentionPolicy.SOURCE)
@RestrictTo(LIBRARY_GROUP)
public @interface MediaInfo {}
//--------------------------------------------------------------------------
/** The player just completed a call {@link #attachAuxEffect}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_ATTACH_AUX_EFFECT = 1;
/** The player just completed a call {@link #deselectTrack}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_DESELECT_TRACK = 2;
/** The player just completed a call {@link #loopCurrent}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_LOOP_CURRENT = 3;
/** The player just completed a call {@link #pause}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_PAUSE = 4;
/** The player just completed a call {@link #play}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_PLAY = 5;
/** The player just completed a call {@link #prepare}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_PREPARE = 6;
/** The player just completed a call {@link #seekTo}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SEEK_TO = 14;
/** The player just completed a call {@link #selectTrack}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SELECT_TRACK = 15;
/** The player just completed a call {@link #setAudioAttributes}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_AUDIO_ATTRIBUTES = 16;
/** The player just completed a call {@link #setAudioSessionId}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_AUDIO_SESSION_ID = 17;
/** The player just completed a call {@link #setAuxEffectSendLevel}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_AUX_EFFECT_SEND_LEVEL = 18;
/** The player just completed a call {@link #setDataSource}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_DATA_SOURCE = 19;
/** The player just completed a call {@link #setNextDataSource}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_NEXT_DATA_SOURCE = 22;
/** The player just completed a call {@link #setNextDataSources}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_NEXT_DATA_SOURCES = 23;
/** The player just completed a call {@link #setPlaybackParams}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_PLAYBACK_PARAMS = 24;
/** The player just completed a call {@link #setPlayerVolume}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_PLAYER_VOLUME = 26;
/** The player just completed a call {@link #setSurface}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SET_SURFACE = 27;
/** The player just completed a call {@link #skipToNext}.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_COMPLETED_SKIP_TO_NEXT = 29;
/**
* The start of the methods which have separate call complete callback.
*/
static final int SEPARATE_CALL_COMPLETE_CALLBACK_START = 1000;
/** The player just completed a call {@code notifyWhenCommandLabelReached}.
* @see EventCallback#onCommandLabelReached
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
public static final int CALL_COMPLETED_NOTIFY_WHEN_COMMAND_LABEL_REACHED =
SEPARATE_CALL_COMPLETE_CALLBACK_START;
/** The player just completed a call {@link #prepareDrm}.
* @see EventCallback#onCommandLabelReached
* @hide
*/
@RestrictTo(LIBRARY_GROUP)
public static final int CALL_COMPLETED_PREPARE_DRM =
SEPARATE_CALL_COMPLETE_CALLBACK_START + 1;
/**
* @hide
*/
@IntDef(flag = false, /*prefix = "CALL_COMPLETED",*/ value = {
CALL_COMPLETED_ATTACH_AUX_EFFECT,
CALL_COMPLETED_DESELECT_TRACK,
CALL_COMPLETED_LOOP_CURRENT,
CALL_COMPLETED_PAUSE,
CALL_COMPLETED_PLAY,
CALL_COMPLETED_PREPARE,
CALL_COMPLETED_SEEK_TO,
CALL_COMPLETED_SELECT_TRACK,
CALL_COMPLETED_SET_AUDIO_ATTRIBUTES,
CALL_COMPLETED_SET_AUDIO_SESSION_ID,
CALL_COMPLETED_SET_AUX_EFFECT_SEND_LEVEL,
CALL_COMPLETED_SET_DATA_SOURCE,
CALL_COMPLETED_SET_NEXT_DATA_SOURCE,
CALL_COMPLETED_SET_NEXT_DATA_SOURCES,
CALL_COMPLETED_SET_PLAYBACK_PARAMS,
CALL_COMPLETED_SET_PLAYER_VOLUME,
CALL_COMPLETED_SET_SURFACE,
CALL_COMPLETED_SKIP_TO_NEXT,
CALL_COMPLETED_NOTIFY_WHEN_COMMAND_LABEL_REACHED,
CALL_COMPLETED_PREPARE_DRM,
})
@Retention(RetentionPolicy.SOURCE)
@RestrictTo(LIBRARY_GROUP)
public @interface CallCompleted {}
/** Status code represents that call is completed without an error.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_STATUS_NO_ERROR = 0;
/** Status code represents that call is ended with an unknown error.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_STATUS_ERROR_UNKNOWN = Integer.MIN_VALUE;
/** Status code represents that the player is not in valid state for the operation.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_STATUS_INVALID_OPERATION = 1;
/** Status code represents that the argument is illegal.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_STATUS_BAD_VALUE = 2;
/** Status code represents that the operation is not allowed.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_STATUS_PERMISSION_DENIED = 3;
/** Status code represents a file or network related operation error.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_STATUS_ERROR_IO = 4;
/** Status code represents that the player skipped the call. For example, a {@link #seekTo}
* request may be skipped if it is followed by another {@link #seekTo} request.
* @see EventCallback#onCallCompleted
*/
public static final int CALL_STATUS_SKIPPED = 5;
/**
* @hide
*/
@IntDef(flag = false, /*prefix = "CALL_STATUS",*/ value = {
CALL_STATUS_NO_ERROR,
CALL_STATUS_ERROR_UNKNOWN,
CALL_STATUS_INVALID_OPERATION,
CALL_STATUS_BAD_VALUE,
CALL_STATUS_PERMISSION_DENIED,
CALL_STATUS_ERROR_IO,
CALL_STATUS_SKIPPED})
@Retention(RetentionPolicy.SOURCE)
@RestrictTo(LIBRARY_GROUP)
public @interface CallStatus {}
// Modular DRM begin
/**
* Interface definition of a callback to be invoked when the app
* can do DRM configuration (get/set properties) before the session
* is opened. This facilitates configuration of the properties, like
* 'securityLevel', which has to be set after DRM scheme creation but
* before the DRM session is opened.
*
* The only allowed DRM calls in this listener are {@link #getDrmPropertyString}
* and {@link #setDrmPropertyString}.
*/
public interface OnDrmConfigHelper {
/**
* Called to give the app the opportunity to configure DRM before the session is created
*
* @param mp the {@code MediaPlayer2} associated with this callback
* @param dsd the DataSourceDesc2 of this data source
*/
void onDrmConfig(MediaPlayer2 mp, DataSourceDesc2 dsd);
}
/**
* Register a callback to be invoked for configuration of the DRM object before
* the session is created.
* The callback will be invoked synchronously during the execution
* of {@link #prepareDrm(UUID uuid)}.
*
* @param listener the callback that will be run
*/
// This is a synchronous call.
public abstract void setOnDrmConfigHelper(OnDrmConfigHelper listener);
/**
* Interface definition for callbacks to be invoked when the player has the corresponding
* DRM events.
*/
public abstract static class DrmEventCallback {
/**
* Called to indicate DRM info is available
*
* @param mp the {@code MediaPlayer2} associated with this callback
* @param dsd the DataSourceDesc2 of this data source
* @param drmInfo DRM info of the source including PSSH, and subset
* of crypto schemes supported by this device
*/
public void onDrmInfo(MediaPlayer2 mp, DataSourceDesc2 dsd, DrmInfo drmInfo) { }
/**
* Called to notify the client that {@link #prepareDrm} is finished and ready for
* key request/response.
*
* @param mp the {@code MediaPlayer2} associated with this callback
* @param dsd the DataSourceDesc2 of this data source
* @param status the result of DRM preparation.
*/
public void onDrmPrepared(
MediaPlayer2 mp, DataSourceDesc2 dsd, @PrepareDrmStatusCode int status) { }
}
/**
* Sets the callback to be invoked when the media source is ready for playback.
*
* @param eventCallback the callback that will be run
* @param executor the executor through which the callback should be invoked
*/
// This is a synchronous call.
public abstract void setDrmEventCallback(@NonNull Executor executor,
@NonNull DrmEventCallback eventCallback);
/**
* Clears the {@link DrmEventCallback}.
*/
// This is a synchronous call.
public abstract void clearDrmEventCallback();
/**
* The status codes for {@link DrmEventCallback#onDrmPrepared} listener.
*