ExoPlaybackException

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

public final class ExoPlaybackException extends PlaybackException

java.lang.Object
↳	kotlin.Throwable
	↳	java.lang.Exception
		↳	androidx.media3.common.PlaybackException
			↳	androidx.media3.exoplayer.ExoPlaybackException

Thrown when a non locally recoverable playback failure occurs.

Summary

Nested types
`@UnstableApi @Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ) @IntDef(value = ) public annotation ExoPlaybackException.Type` The type of source that produced the error.

Constants
`static final int`	`@UnstableApi TYPE_REMOTE = 3` The error occurred in a remote component.
`static final int`	`@UnstableApi TYPE_RENDERER = 1` The error occurred in a `Renderer`.
`static final int`	`@UnstableApi TYPE_SOURCE = 0` The error occurred loading data from a `MediaSource`.
`static final int`	`@UnstableApi TYPE_UNEXPECTED = 2` The error was an unexpected `RuntimeException`.

Public fields
`final @Nullable MediaSource.MediaPeriodId`	`@UnstableApi mediaPeriodId` The `MediaPeriodId` of the media associated with this error, or null if undetermined.
`final @Nullable Format`	`@UnstableApi rendererFormat` If `type` is `TYPE_RENDERER`, this is the `Format` the renderer was using at the time of the exception, or null if the renderer wasn't using a `Format`.
`final int`	`@UnstableApi @C.FormatSupport rendererFormatSupport` If `type` is `TYPE_RENDERER`, this is the level of `FormatSupport` of the renderer for `rendererFormat`.
`final int`	`@UnstableApi rendererIndex` If `type` is `TYPE_RENDERER`, this is the index of the renderer.
`final @Nullable String`	`@UnstableApi rendererName` If `type` is `TYPE_RENDERER`, this is the name of the renderer.
`final int`	`@UnstableApi @ExoPlaybackException.Type type` The `Type` of the playback failure.

Public methods
`static ExoPlaybackException`	`@UnstableApi createForRemote(String message)` Creates an instance of type `TYPE_REMOTE`.
`static ExoPlaybackException`	`@UnstableApi createForRenderer( Throwable cause, String rendererName, int rendererIndex, @Nullable Format rendererFormat, @C.FormatSupport int rendererFormatSupport, boolean isRecoverable, @PlaybackException.ErrorCode int errorCode )` This method is deprecated. Use `createForRenderer` instead.
`static ExoPlaybackException`	`@UnstableApi createForRenderer( Throwable cause, String rendererName, int rendererIndex, @Nullable Format rendererFormat, @C.FormatSupport int rendererFormatSupport, @Nullable MediaSource.MediaPeriodId mediaPeriodId, boolean isRecoverable, @PlaybackException.ErrorCode int errorCode )` Creates an instance of type `TYPE_RENDERER`.
`static ExoPlaybackException`	`@UnstableApi createForSource(IOException cause, int errorCode)` Creates an instance of type `TYPE_SOURCE`.
`static ExoPlaybackException`	`@UnstableApi createForUnexpected(RuntimeException cause)` This method is deprecated. Use `createForUnexpected(RuntimeException, ERROR_CODE_UNSPECIFIED)` instead.
`static ExoPlaybackException`	`@UnstableApi createForUnexpected( RuntimeException cause, @PlaybackException.ErrorCode int errorCode )` Creates an instance of type `TYPE_UNEXPECTED`.
`boolean`	`errorInfoEquals(@Nullable PlaybackException that)` Returns whether the error data associated to this exception equals the error data associated to `other`.
`Exception`	`@UnstableApi getRendererException()` Retrieves the underlying error when `type` is `TYPE_RENDERER`.
`IOException`	`@UnstableApi getSourceException()` Retrieves the underlying error when `type` is `TYPE_SOURCE`.
`RuntimeException`	`@UnstableApi getUnexpectedException()` Retrieves the underlying error when `type` is `TYPE_UNEXPECTED`.

Inherited Constants

From androidx.media3.common.PlaybackException

`static final int`	`CUSTOM_ERROR_CODE_BASE = 1000000` Player implementations that want to surface custom errors can use error codes greater than this value, so as to avoid collision with other error codes defined in this class.
`static final int`	`ERROR_CODE_AUDIO_TRACK_INIT_FAILED = 5001` Caused by an AudioTrack initialization failure.
`static final int`	`ERROR_CODE_AUDIO_TRACK_OFFLOAD_INIT_FAILED = 5004` Caused by an AudioTrack init operation failure in offload mode.
`static final int`	`ERROR_CODE_AUDIO_TRACK_OFFLOAD_WRITE_FAILED = 5003` Caused by an AudioTrack write operation failure in offload mode.
`static final int`	`ERROR_CODE_AUDIO_TRACK_WRITE_FAILED = 5002` Caused by an AudioTrack write operation failure.
`static final int`	`ERROR_CODE_AUTHENTICATION_EXPIRED = -102` Caused by expired authentication.
`static final int`	`ERROR_CODE_BAD_VALUE = -3` Caused by an argument that is illegal.
`static final int`	`ERROR_CODE_BEHIND_LIVE_WINDOW = 1002` Caused by the loading position falling behind the sliding window of available live content.
`static final int`	`ERROR_CODE_CONCURRENT_STREAM_LIMIT = -104` Caused by too many concurrent streams.
`static final int`	`ERROR_CODE_CONTENT_ALREADY_PLAYING = -110` Caused by a request for content that was already playing.
`static final int`	`ERROR_CODE_DECODER_INIT_FAILED = 4001` Caused by a decoder initialization failure.
`static final int`	`ERROR_CODE_DECODER_QUERY_FAILED = 4002` Caused by a decoder query failure.
`static final int`	`ERROR_CODE_DECODING_FAILED = 4003` Caused by a failure while trying to decode media samples.
`static final int`	`ERROR_CODE_DECODING_FORMAT_EXCEEDS_CAPABILITIES = 4004` Caused by trying to decode content whose format exceeds the capabilities of the device.
`static final int`	`ERROR_CODE_DECODING_FORMAT_UNSUPPORTED = 4005` Caused by trying to decode content whose format is not supported.
`static final int`	`ERROR_CODE_DECODING_RESOURCES_RECLAIMED = 4006` Caused by higher priority task reclaiming resources needed for decoding.
`static final int`	`ERROR_CODE_DISCONNECTED = -100` Caused by a disconnected component.
`static final int`	`ERROR_CODE_DRM_CONTENT_ERROR = 6003` Caused by attempting to play incompatible DRM-protected content.
`static final int`	`ERROR_CODE_DRM_DEVICE_REVOKED = 6007` Caused by the device having revoked DRM privileges.
`static final int`	`ERROR_CODE_DRM_DISALLOWED_OPERATION = 6005` Caused by an operation being disallowed by a license policy.
`static final int`	`ERROR_CODE_DRM_LICENSE_ACQUISITION_FAILED = 6004` Caused by a failure while trying to obtain a license.
`static final int`	`ERROR_CODE_DRM_LICENSE_EXPIRED = 6008` Caused by an expired DRM license being loaded into an open DRM session.
`static final int`	`ERROR_CODE_DRM_PROVISIONING_FAILED = 6002` Caused by a failure while provisioning the device.
`static final int`	`ERROR_CODE_DRM_SCHEME_UNSUPPORTED = 6001` Caused by a chosen DRM protection scheme not being supported by the device.
`static final int`	`ERROR_CODE_DRM_SYSTEM_ERROR = 6006` Caused by an error in the DRM system.
`static final int`	`ERROR_CODE_DRM_UNSPECIFIED = 6000` Caused by an unspecified error related to DRM protection.
`static final int`	`ERROR_CODE_END_OF_PLAYLIST = -109` Caused by navigation that failed because the playlist was exhausted.
`static final int`	`ERROR_CODE_FAILED_RUNTIME_CHECK = 1004` Caused by a failed runtime check.
`static final int`	`ERROR_CODE_INVALID_STATE = -2` Caused by a command that cannot be completed because the current state is not valid.
`static final int`	`ERROR_CODE_IO_BAD_HTTP_STATUS = 2004` Caused by an HTTP server returning an unexpected HTTP response status code.
`static final int`	`ERROR_CODE_IO_CLEARTEXT_NOT_PERMITTED = 2007` Caused by the player trying to access cleartext HTTP traffic (meaning http:// rather than https://) when the app's Network Security Configuration does not permit it.
`static final int`	`ERROR_CODE_IO_FILE_NOT_FOUND = 2005` Caused by a non-existent file.
`static final int`	`ERROR_CODE_IO_INVALID_HTTP_CONTENT_TYPE = 2003` Caused by a server returning a resource with an invalid "Content-Type" HTTP header value.
`static final int`	`ERROR_CODE_IO_NETWORK_CONNECTION_FAILED = 2001` Caused by a network connection failure.
`static final int`	`ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT = 2002` Caused by a network timeout, meaning the server is taking too long to fulfill a request.
`static final int`	`ERROR_CODE_IO_NO_PERMISSION = 2006` Caused by lack of permission to perform an IO operation.
`static final int`	`ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE = 2008` Caused by reading data out of the data bound.
`static final int`	`ERROR_CODE_IO_UNSPECIFIED = 2000` Caused by an Input/Output error which could not be identified.
`static final int`	`ERROR_CODE_NOT_AVAILABLE_IN_REGION = -106` Caused by the content being blocked due to being regionally unavailable.
`static final int`	`ERROR_CODE_NOT_SUPPORTED = -6` Caused by a command that is not supported.
`static final int`	`ERROR_CODE_PARENTAL_CONTROL_RESTRICTED = -105` Caused by the content being blocked due to parental controls.
`static final int`	`ERROR_CODE_PARSING_CONTAINER_MALFORMED = 3001` Caused by a parsing error associated with a media container format bitstream.
`static final int`	`ERROR_CODE_PARSING_CONTAINER_UNSUPPORTED = 3003` Caused by attempting to extract a file with an unsupported media container format, or an unsupported media container feature.
`static final int`	`ERROR_CODE_PARSING_MANIFEST_MALFORMED = 3002` Caused by a parsing error associated with a media manifest.
`static final int`	`ERROR_CODE_PARSING_MANIFEST_UNSUPPORTED = 3004` Caused by an unsupported feature in a media manifest.
`static final int`	`ERROR_CODE_PERMISSION_DENIED = -4` Caused by a command that is not allowed.
`static final int`	`ERROR_CODE_PREMIUM_ACCOUNT_REQUIRED = -103` Caused by a premium account that is required but the user is not subscribed.
`static final int`	`ERROR_CODE_REMOTE_ERROR = 1001` Caused by an unidentified error in a remote Player, which is a Player that runs on a different host or process.
`static final int`	`ERROR_CODE_SETUP_REQUIRED = -108` Caused by playback that needs manual user intervention.
`static final int`	`ERROR_CODE_SKIP_LIMIT_REACHED = -107` Caused by the skip limit that is exhausted.
`static final int`	`ERROR_CODE_TIMEOUT = 1003` Caused by a generic timeout.
`static final int`	`ERROR_CODE_UNSPECIFIED = 1000` Caused by an error whose cause could not be identified.
`static final int`	`@UnstableApi ERROR_CODE_VIDEO_FRAME_PROCESSING_FAILED = 7001` Caused by a failure when processing a video frame.
`static final int`	`@UnstableApi ERROR_CODE_VIDEO_FRAME_PROCESSOR_INIT_FAILED = 7000` Caused by a failure when initializing a `VideoFrameProcessor`.
`static final int`	`@UnstableApi FIELD_CUSTOM_ID_BASE = 1000` Defines a minimum field ID value for subclasses to use when implementing `toBundle` and delegating to `PlaybackException`.

Inherited fields

From androidx.media3.common.PlaybackException

`final int`	`@PlaybackException.ErrorCode errorCode` An error code which identifies the cause of the playback failure.
`final Bundle`	`@UnstableApi extras` An extras `Bundle`.
`final long`	`timestampMs` The value of `elapsedRealtime` when this exception was created.

Inherited methods

From androidx.media3.common.PlaybackException

`static boolean`	`@UnstableApi areErrorInfosEqual( @Nullable PlaybackException playbackException1, @Nullable PlaybackException playbackException2 )` Returns true if both `PlaybackException` instances have `the same error info` or both are null.
`static PlaybackException`	`@UnstableApi fromBundle(Bundle bundle)` Restores a `PlaybackException` from a `Bundle`.
`final String`	`getErrorCodeName()` Equivalent to `PlaybackException.getErrorCodeName(this.errorCode)`.
`static String`	`getErrorCodeName(@PlaybackException.ErrorCode int errorCode)` Returns the name of a given `errorCode`.
`Bundle`	`@UnstableApi @CallSuper toBundle()` Returns a `Bundle` representing the information stored in this exception.

From java.lang.Throwable

`synchronized final void`	`addSuppressed(Throwable exception)`
`synchronized Throwable`	`fillInStackTrace()`
`synchronized Throwable`	`getCause()`
`String`	`getLocalizedMessage()`
`String`	`getMessage()`
`StackTraceElement[]`	`getStackTrace()`
`synchronized final Throwable[]`	`getSuppressed()`
`synchronized Throwable`	`initCause(Throwable cause)`
`void`	`printStackTrace()`
`void`	`setStackTrace(StackTraceElement[] stackTrace)`
`String`	`toString()`

Constants

TYPE_REMOTE

@UnstableApi
public static final int TYPE_REMOTE = 3

The error occurred in a remote component.

Call getMessage to retrieve the message associated with the error.

TYPE_RENDERER

@UnstableApi
public static final int TYPE_RENDERER = 1

The error occurred in a Renderer.

Call getRendererException to retrieve the underlying cause.

TYPE_SOURCE

@UnstableApi
public static final int TYPE_SOURCE = 0

The error occurred loading data from a MediaSource.

Call getSourceException to retrieve the underlying cause.

TYPE_UNEXPECTED

@UnstableApi
public static final int TYPE_UNEXPECTED = 2

The error was an unexpected RuntimeException.

Call getUnexpectedException to retrieve the underlying cause.

Public fields

mediaPeriodId

@UnstableApi
public final @Nullable MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId of the media associated with this error, or null if undetermined.

rendererFormat

@UnstableApi
public final @Nullable Format rendererFormat

If type is TYPE_RENDERER, this is the Format the renderer was using at the time of the exception, or null if the renderer wasn't using a Format.

rendererFormatSupport

@UnstableApi
@C.FormatSupport
public final int rendererFormatSupport

If type is TYPE_RENDERER, this is the level of FormatSupport of the renderer for rendererFormat. If rendererFormat is null, this is FORMAT_HANDLED.

rendererIndex

@UnstableApi
public final int rendererIndex

If type is TYPE_RENDERER, this is the index of the renderer.

rendererName

@UnstableApi
public final @Nullable String rendererName

If type is TYPE_RENDERER, this is the name of the renderer.

type

@UnstableApi
@ExoPlaybackException.Type
public final int type

The Type of the playback failure.

Public methods

createForRemote

@UnstableApi
public static ExoPlaybackException createForRemote(String message)

Creates an instance of type TYPE_REMOTE.

Parameters
`String message`	The message associated with the error.

Returns
`ExoPlaybackException`	The created instance.

createForRenderer

@UnstableApi
public static ExoPlaybackException createForRenderer(
    Throwable cause,
    String rendererName,
    int rendererIndex,
    @Nullable Format rendererFormat,
    @C.FormatSupport int rendererFormatSupport,
    boolean isRecoverable,
    @PlaybackException.ErrorCode int errorCode
)

createForRenderer

@UnstableApi
public static ExoPlaybackException createForRenderer(
    Throwable cause,
    String rendererName,
    int rendererIndex,
    @Nullable Format rendererFormat,
    @C.FormatSupport int rendererFormatSupport,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    boolean isRecoverable,
    @PlaybackException.ErrorCode int errorCode
)

Creates an instance of type TYPE_RENDERER.

Parameters
`Throwable cause`	The cause of the failure.
`String rendererName`	The `name` of the renderer in which the failure occurred.
`int rendererIndex`	The index of the renderer in which the failure occurred.
`@Nullable Format rendererFormat`	The `Format` the renderer was using at the time of the exception, or null if the renderer wasn't using a `Format`.
`@C.FormatSupport int rendererFormatSupport`	The `FormatSupport` of the renderer for `rendererFormat`. Ignored if `rendererFormat` is null.
`@Nullable MediaSource.MediaPeriodId mediaPeriodId`	The `mediaPeriodId` of the media associated with this error, or null if undetermined.
`boolean isRecoverable`	If the failure can be recovered by disabling and re-enabling the renderer.
`@PlaybackException.ErrorCode int errorCode`	See `errorCode`.

Returns
`ExoPlaybackException`	The created instance.

createForSource

@UnstableApi
public static ExoPlaybackException createForSource(IOException cause, int errorCode)

Creates an instance of type TYPE_SOURCE.

Parameters
`IOException cause`	The cause of the failure.
`int errorCode`	See `errorCode`.

Returns
`ExoPlaybackException`	The created instance.

createForUnexpected

@UnstableApi
public static ExoPlaybackException createForUnexpected(RuntimeException cause)

createForUnexpected

@UnstableApi
public static ExoPlaybackException createForUnexpected(
    RuntimeException cause,
    @PlaybackException.ErrorCode int errorCode
)

Creates an instance of type TYPE_UNEXPECTED.

Parameters
`RuntimeException cause`	The cause of the failure.
`@PlaybackException.ErrorCode int errorCode`	See `errorCode`.

Returns
`ExoPlaybackException`	The created instance.

errorInfoEquals

public boolean errorInfoEquals(@Nullable PlaybackException that)

Returns whether the error data associated to this exception equals the error data associated to other.

Note that this method does not compare the exceptions' stack traces and extras.

getRendererException

@UnstableApi
public Exception getRendererException()

Retrieves the underlying error when type is TYPE_RENDERER.

Throws
`java.lang.IllegalStateException`	If `type` is not `TYPE_RENDERER`.

getSourceException

@UnstableApi
public IOException getSourceException()

Retrieves the underlying error when type is TYPE_SOURCE.

Throws
`java.lang.IllegalStateException`	If `type` is not `TYPE_SOURCE`.

getUnexpectedException

@UnstableApi
public RuntimeException getUnexpectedException()

Retrieves the underlying error when type is TYPE_UNEXPECTED.

Throws
`java.lang.IllegalStateException`	If `type` is not `TYPE_UNEXPECTED`.

ExoPlaybackException

Summary

Nested types

Constants

Public fields

Public methods

Inherited Constants

Inherited fields

Inherited methods

Constants

TYPE_REMOTE

TYPE_RENDERER

TYPE_SOURCE

TYPE_UNEXPECTED

Public fields

mediaPeriodId

rendererFormat

rendererFormatSupport

rendererIndex

rendererName

type

Public methods

createForRemote

createForRenderer

createForRenderer

createForSource

createForUnexpected

createForUnexpected

errorInfoEquals

getRendererException

getSourceException

getUnexpectedException