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 #setMediaItem(MediaItem) setMediaItem()}. 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 setMediaItem.
*
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 media item 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
* media item 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 #setMediaItem(MediaItem)} 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 |
|---|---|
| setMediaItem | {Prepared, Paused, Playing} |
| prepare | {Prepared, Paused, Playing} |
| play | {Idle} |
| pause | {Idle} |
| seekTo | {Idle} |
| getCurrentPosition | {Idle} |
| getDuration | {Idle} |
| getBufferedPosition | {Idle} |
| getTracks | {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.
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.
*/ /* package */ abstract class MediaPlayer2 { /** * Create a MediaPlayer2 object. * * @param context The context the player is running in * @return A MediaPlayer2 object created */ @NonNull public static MediaPlayer2 create(@NonNull Context context) { return new ExoPlayerMediaPlayer2Impl(context); } protected MediaPlayer2() { } /** * Cancels the asynchronous call previously submitted. * * @param token the token which is returned from the asynchronous call. * @return {@code false} if the task could not be cancelled; {@code true} otherwise. */ public abstract boolean cancel(Object token); /** * 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. * * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public abstract Object play(); /** * Prepares the player for playback, asynchronously. * * After setting the datasource and the display surface, you need to * call prepare(). * * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public abstract Object prepare(); /** * Pauses playback. Call play() to resume. * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public abstract Object pause(); /** * Tries to play next media item if applicable. * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public abstract Object 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 * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public Object seekTo(long msec) { return 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 * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public abstract Object 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 media item as described by a MediaItem. ** When the media item is a {@link FileMediaItem}, the {@link ParcelFileDescriptor} * in the {@link FileMediaItem} will be closed by the player. * * @param item the descriptor of media item you want to play * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public abstract Object setMediaItem(@NonNull MediaItem item); /** * Sets a single media item as described by a MediaItem which will be played * after current media item is finished. *
* When the media item is a {@link FileMediaItem}, the {@link ParcelFileDescriptor} * in the {@link FileMediaItem} will be closed by the player. * * @param item the descriptor of media item you want to play after current one * @return a token which can be used to cancel the operation later with {@link #cancel}. */ // This is an asynchronous call. public abstract Object setNextMediaItem(@NonNull MediaItem item); /** * Sets a list of media items to be played sequentially after current media item is done. *
* If a media item in the list is a {@link FileMediaItem}, the {@link ParcelFileDescriptor}
* in the {@link FileMediaItem} will be closed by the player.
*
* @param items the list of media items you want to play after current one
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object setNextMediaItems(@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 media item
* 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.
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object seekTo(long msec, @SeekMode int mode);
/**
* Gets current playback position as a {@link MediaTimestamp}.
*
* The MediaTimestamp 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 MediaTimestamp#getAnchorMediaTimeUs} can be used as current playback position.
*
* @return a MediaTimestamp 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 MediaTimestamp
*/
@Nullable
public abstract MediaTimestamp getTimestamp();
/**
* Resets the MediaPlayer2 to its uninitialized state. After calling
* this method, you will have to initialize it again by setting the
* media item 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 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 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
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object setAuxEffectSendLevel(float level);
/**
* Returns a List of track information.
*
* @return List of track info. The total number of tracks is the array length.
*/
@NonNull
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, Subtitle), 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 subtitle track will be selected until
* this function is called.
*
* Currently, only subtitle tracks or audio tracks can be selected via this method.
*
* Currently, the track must be a subtitle track and no audio or video tracks can be
* deselected. If the subtitle 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 TimedMetaData}.
*
* @see MediaPlayer2#selectTrack(int)
* @see TimedMetaData
*
* @param mp the MediaPlayer2 associated with this callback
* @param item the MediaItem of this media item
* @param data the timed metadata sample associated with this event
*/
public void onTimedMetaDataAvailable(
MediaPlayer2 mp, MediaItem item, TimedMetaData data) { }
/**
* Called to indicate an error.
*
* @param mp the MediaPlayer2 the error pertains to
* @param item the MediaItem of this media item
* @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, MediaItem item, @MediaError int what, int extra) { }
/**
* Called to indicate an info or a warning.
*
* @param mp the MediaPlayer2 the info pertains to.
* @param item the MediaItem of this media item
* @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, MediaItem item, @MediaInfo int what, int extra) { }
/**
* Called to acknowledge an API call.
*
* @param mp the MediaPlayer2 the call was made on.
* @param item the MediaItem of this media item
* @param what the enum for the API call.
* @param status the returned status code for the call.
*/
public void onCallCompleted(
MediaPlayer2 mp, MediaItem item, @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).
* When it's called, the previous tracks may be invalidated so it's recommended to use the
* most recent tracks to call {@link #selectTrack} or {@link #deselectTrack}.
*
* @param mp the player associated with this callback
* @param tracks the list of tracks. It can be empty.
*/
public void onTracksChanged(@NonNull MediaPlayer2 mp,
@NonNull List
*
* 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 */
@RestrictTo(LIBRARY)
@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)
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}.
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object 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 media item for each supported DRM scheme.
*/
public abstract Map
* A value of 0.0f indicates muting, a value of 1.0f is the nominal unattenuated and unamplified
* gain. See {@link #getMaxPlayerVolume()} for the volume range supported by this player.
* @param volume a value between 0.0f and {@link #getMaxPlayerVolume()}.
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object setPlayerVolume(float volume);
/**
* Returns the current volume of this player to this player.
* Note that it does not take into account the associated stream volume.
* @return the player volume.
*/
public abstract float getPlayerVolume();
/**
* @return the maximum volume that can be used in {@link #setPlayerVolume(float)}.
*/
public float getMaxPlayerVolume() {
return 1.0f;
}
/**
* Insert a task in the command queue to help the client to identify whether a batch
* of commands has been finished. When this command is processed, a notification
* {@link EventCallback#onCommandLabelReached} will be fired with the
* given {@code label}.
*
* @see EventCallback#onCommandLabelReached
*
* @param label An application specific Object used to help to identify the completeness
* of a batch of commands.
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object notifyWhenCommandLabelReached(@NonNull Object label);
/**
* Sets the {@link Surface} to be used as the sink for the video portion of
* the media. Setting a
* Surface will un-set any Surface or SurfaceHolder that was previously set.
* A null surface will result in only the audio track being played.
*
* If the Surface sends frames to a {@link SurfaceTexture}, the timestamps
* returned from {@link SurfaceTexture#getTimestamp()} will have an
* unspecified zero point. These timestamps cannot be directly compared
* between different media sources, different instances of the same media
* source, or multiple runs of the same program. The timestamp is normally
* monotonically increasing and is unaffected by time-of-day adjustments,
* but it is reset when the position is set.
*
* @param surface The {@link Surface} to be used for the video portion of
* the media.
* @throws IllegalStateException if the internal player engine has not been
* initialized or has been released.
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object setSurface(@Nullable Surface surface);
/* Do not change these video scaling mode values below without updating
* their counterparts in system/window.h! Please do not forget to update
* {@link #isVideoScalingModeSupported} when new video scaling modes
* are added.
*/
/**
* Specifies a video scaling mode. The content is stretched to the
* surface rendering area. When the surface has the same aspect ratio
* as the content, the aspect ratio of the content is maintained;
* otherwise, the aspect ratio of the content is not maintained when video
* is being rendered.
* There is no content cropping with this video scaling mode.
*/
public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT = 1;
/**
* Discards all pending commands.
*/
// This is a synchronous call.
public abstract void clearPendingCommands();
/**
* Returns the width of the video.
*
* @return the width of the video, or 0 if there is no video or the width has not been
* determined yet. The {@link EventCallback} can be registered via
* {@link #setEventCallback(Executor, EventCallback)} to provide a
* notification {@link EventCallback#onVideoSizeChanged} when the width
* is available.
*/
public abstract int getVideoWidth();
/**
* Returns the height of the video.
*
* @return the height of the video, or 0 if there is no video or the height has not been
* determined yet. The {@link EventCallback} can be registered via
* {@link #setEventCallback(Executor, EventCallback)} to provide a
* notification {@link EventCallback#onVideoSizeChanged} when the height is
* available.
*/
public abstract int getVideoHeight();
/**
* Return Metrics data about the current player.
*
* @return a {@link PersistableBundle} containing the set of attributes and values
* available for the media being handled by this instance of MediaPlayer2
* The attributes are descibed in {@link MetricsConstants}.
*
* Additional vendor-specific fields may also be present in
* the return value.
*/
@RequiresApi(21)
public abstract PersistableBundle getMetrics();
/**
* Sets playback rate using {@link PlaybackParams}. The player sets its internal
* PlaybackParams to the given input. This does not change the player state. For example,
* if this is called with the speed of 2.0f in {@link #PLAYER_STATE_PAUSED}, the player will
* just update internal property and stay paused. Once the client calls {@link #play()}
* afterwards, the player will start playback with the given speed. Calling this with zero
* speed is not allowed.
*
* @param params the playback params.
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object setPlaybackParams(@NonNull PlaybackParams params);
/**
* Gets the playback params, containing the current playback rate.
*
* @return the playback params.
*/
@NonNull
public abstract PlaybackParams getPlaybackParams();
/**
* Seek modes used in method seekTo(long, int) to move media position
* to a specified location.
*
* Do not change these mode values without updating their counterparts
* in include/media/IMediaSource.h!
*/
/**
* This mode is used with {@link #seekTo(long, int)} to move media position to
* a sync (or key) frame associated with a media item that is located
* right before or at the given time.
*
* @see #seekTo(long, int)
*/
public static final int SEEK_PREVIOUS_SYNC = 0x00;
/**
* This mode is used with {@link #seekTo(long, int)} to move media position to
* a sync (or key) frame associated with a media item that is located
* right after or at the given time.
*
* @see #seekTo(long, int)
*/
public static final int SEEK_NEXT_SYNC = 0x01;
/**
* This mode is used with {@link #seekTo(long, int)} to move media position to
* a sync (or key) frame associated with a media item that is located
* closest to (in time) or at the given time.
*
* @see #seekTo(long, int)
*/
public static final int SEEK_CLOSEST_SYNC = 0x02;
/**
* This mode is used with {@link #seekTo(long, int)} to move media position to
* a frame (not necessarily a key frame) associated with a media item that
* is located closest to or at the given time.
*
* @see #seekTo(long, int)
*/
public static final int SEEK_CLOSEST = 0x03;
/** @hide */
@RestrictTo(LIBRARY)
@IntDef(flag = false, /*prefix = "SEEK",*/ value = {
SEEK_PREVIOUS_SYNC,
SEEK_NEXT_SYNC,
SEEK_CLOSEST_SYNC,
SEEK_CLOSEST,
})
@Retention(RetentionPolicy.SOURCE)
public @interface SeekMode {}
/**
* Moves the media to specified time position by considering the given mode.
* setMediaItem methods.
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object 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 occurred when the MediaPlayer2 was
* constructed.
*/
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)}.
* setMediaItem
* methods.
* @param effectId system wide unique id of the effect to attach
* @return a token which can be used to cancel the operation later with {@link #cancel}.
*/
// This is an asynchronous call.
public abstract Object 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.
*
* Discontinuities are encountered in the following cases:
*
*
*
* @param mp the MediaPlayer2 the media time pertains to.
* @param item the MediaItem of this media item
* @param timestamp the timestamp that correlates media time, system time and clock rate,
* or {@link MediaTimestamp#TIMESTAMP_UNKNOWN} in an error case.
*/
public void onMediaTimeDiscontinuity(
MediaPlayer2 mp, MediaItem item, MediaTimestamp 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 item the MediaItem of this media item
* @param track the track that has the subtitle data
* @param data the subtitle data
*/
public void onSubtitleData(@NonNull MediaPlayer2 mp, @NonNull MediaItem item,
@NonNull TrackInfo track, @NonNull SubtitleData data) { }
/**
* Called when the tracks of the current media item is changed such as
* 1) when tracks of a media item become available, or
* 2) when new tracks are found during playback.
*