ExoPlaybackException

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

class ExoPlaybackException : PlaybackException

kotlin.Any
↳	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 = ) annotation ExoPlaybackException.Type` The type of source that produced the error.

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

Public functions
`java-static ExoPlaybackException!`	`@UnstableApi createForRemote(message: String!)` Creates an instance of type `TYPE_REMOTE`.
`java-static ExoPlaybackException!`	`@UnstableApi createForRenderer( cause: Throwable!, rendererName: String!, rendererIndex: Int, rendererFormat: Format?, @C.FormatSupport rendererFormatSupport: Int, isRecoverable: Boolean, @PlaybackException.ErrorCode errorCode: Int )` This function is deprecated. Use `createForRenderer` instead.
`java-static ExoPlaybackException!`	`@UnstableApi createForRenderer( cause: Throwable!, rendererName: String!, rendererIndex: Int, rendererFormat: Format?, @C.FormatSupport rendererFormatSupport: Int, mediaPeriodId: MediaSource.MediaPeriodId?, isRecoverable: Boolean, @PlaybackException.ErrorCode errorCode: Int )` Creates an instance of type `TYPE_RENDERER`.
`java-static ExoPlaybackException!`	`@UnstableApi createForSource(cause: IOException!, errorCode: Int)` Creates an instance of type `TYPE_SOURCE`.
`java-static ExoPlaybackException!`	`@UnstableApi createForUnexpected(cause: RuntimeException!)` This function is deprecated. Use `createForUnexpected(RuntimeException, ERROR_CODE_UNSPECIFIED)` instead.
`java-static ExoPlaybackException!`	`@UnstableApi createForUnexpected( cause: RuntimeException!, @PlaybackException.ErrorCode errorCode: Int )` Creates an instance of type `TYPE_UNEXPECTED`.
`Boolean`	`errorInfoEquals(that: PlaybackException?)` 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`.

Public properties
`MediaSource.MediaPeriodId?`	`@UnstableApi mediaPeriodId` The `MediaPeriodId` of the media associated with this error, or null if undetermined.
`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`.
`Int`	`@UnstableApi @C.FormatSupport rendererFormatSupport` If `type` is `TYPE_RENDERER`, this is the level of `FormatSupport` of the renderer for `rendererFormat`.
`Int`	`@UnstableApi rendererIndex` If `type` is `TYPE_RENDERER`, this is the index of the renderer.
`String?`	`@UnstableApi rendererName` If `type` is `TYPE_RENDERER`, this is the name of the renderer.
`Int`	`@UnstableApi @ExoPlaybackException.Type type` The `Type` of the playback failure.

Inherited Constants

From androidx.media3.common.PlaybackException

`const 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.
`const Int`	`ERROR_CODE_AUDIO_TRACK_INIT_FAILED = 5001` Caused by an AudioTrack initialization failure.
`const Int`	`ERROR_CODE_AUDIO_TRACK_OFFLOAD_INIT_FAILED = 5004` Caused by an AudioTrack init operation failure in offload mode.
`const Int`	`ERROR_CODE_AUDIO_TRACK_OFFLOAD_WRITE_FAILED = 5003` Caused by an AudioTrack write operation failure in offload mode.
`const Int`	`ERROR_CODE_AUDIO_TRACK_WRITE_FAILED = 5002` Caused by an AudioTrack write operation failure.
`const Int`	`ERROR_CODE_AUTHENTICATION_EXPIRED = -102` Caused by expired authentication.
`const Int`	`ERROR_CODE_BAD_VALUE = -3` Caused by an argument that is illegal.
`const Int`	`ERROR_CODE_BEHIND_LIVE_WINDOW = 1002` Caused by the loading position falling behind the sliding window of available live content.
`const Int`	`ERROR_CODE_CONCURRENT_STREAM_LIMIT = -104` Caused by too many concurrent streams.
`const Int`	`ERROR_CODE_CONTENT_ALREADY_PLAYING = -110` Caused by a request for content that was already playing.
`const Int`	`ERROR_CODE_DECODER_INIT_FAILED = 4001` Caused by a decoder initialization failure.
`const Int`	`ERROR_CODE_DECODER_QUERY_FAILED = 4002` Caused by a decoder query failure.
`const Int`	`ERROR_CODE_DECODING_FAILED = 4003` Caused by a failure while trying to decode media samples.
`const Int`	`ERROR_CODE_DECODING_FORMAT_EXCEEDS_CAPABILITIES = 4004` Caused by trying to decode content whose format exceeds the capabilities of the device.
`const Int`	`ERROR_CODE_DECODING_FORMAT_UNSUPPORTED = 4005` Caused by trying to decode content whose format is not supported.
`const Int`	`ERROR_CODE_DECODING_RESOURCES_RECLAIMED = 4006` Caused by higher priority task reclaiming resources needed for decoding.
`const Int`	`ERROR_CODE_DISCONNECTED = -100` Caused by a disconnected component.
`const Int`	`ERROR_CODE_DRM_CONTENT_ERROR = 6003` Caused by attempting to play incompatible DRM-protected content.
`const Int`	`ERROR_CODE_DRM_DEVICE_REVOKED = 6007` Caused by the device having revoked DRM privileges.
`const Int`	`ERROR_CODE_DRM_DISALLOWED_OPERATION = 6005` Caused by an operation being disallowed by a license policy.
`const Int`	`ERROR_CODE_DRM_LICENSE_ACQUISITION_FAILED = 6004` Caused by a failure while trying to obtain a license.
`const Int`	`ERROR_CODE_DRM_LICENSE_EXPIRED = 6008` Caused by an expired DRM license being loaded into an open DRM session.
`const Int`	`ERROR_CODE_DRM_PROVISIONING_FAILED = 6002` Caused by a failure while provisioning the device.
`const Int`	`ERROR_CODE_DRM_SCHEME_UNSUPPORTED = 6001` Caused by a chosen DRM protection scheme not being supported by the device.
`const Int`	`ERROR_CODE_DRM_SYSTEM_ERROR = 6006` Caused by an error in the DRM system.
`const Int`	`ERROR_CODE_DRM_UNSPECIFIED = 6000` Caused by an unspecified error related to DRM protection.
`const Int`	`ERROR_CODE_END_OF_PLAYLIST = -109` Caused by navigation that failed because the playlist was exhausted.
`const Int`	`ERROR_CODE_FAILED_RUNTIME_CHECK = 1004` Caused by a failed runtime check.
`const Int`	`ERROR_CODE_INVALID_STATE = -2` Caused by a command that cannot be completed because the current state is not valid.
`const Int`	`ERROR_CODE_IO_BAD_HTTP_STATUS = 2004` Caused by an HTTP server returning an unexpected HTTP response status code.
`const 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.
`const Int`	`ERROR_CODE_IO_FILE_NOT_FOUND = 2005` Caused by a non-existent file.
`const Int`	`ERROR_CODE_IO_INVALID_HTTP_CONTENT_TYPE = 2003` Caused by a server returning a resource with an invalid "Content-Type" HTTP header value.
`const Int`	`ERROR_CODE_IO_NETWORK_CONNECTION_FAILED = 2001` Caused by a network connection failure.
`const Int`	`ERROR_CODE_IO_NETWORK_CONNECTION_TIMEOUT = 2002` Caused by a network timeout, meaning the server is taking too long to fulfill a request.
`const Int`	`ERROR_CODE_IO_NO_PERMISSION = 2006` Caused by lack of permission to perform an IO operation.
`const Int`	`ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE = 2008` Caused by reading data out of the data bound.
`const Int`	`ERROR_CODE_IO_UNSPECIFIED = 2000` Caused by an Input/Output error which could not be identified.
`const Int`	`ERROR_CODE_NOT_AVAILABLE_IN_REGION = -106` Caused by the content being blocked due to being regionally unavailable.
`const Int`	`ERROR_CODE_NOT_SUPPORTED = -6` Caused by a command that is not supported.
`const Int`	`ERROR_CODE_PARENTAL_CONTROL_RESTRICTED = -105` Caused by the content being blocked due to parental controls.
`const Int`	`ERROR_CODE_PARSING_CONTAINER_MALFORMED = 3001` Caused by a parsing error associated with a media container format bitstream.
`const 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.
`const Int`	`ERROR_CODE_PARSING_MANIFEST_MALFORMED = 3002` Caused by a parsing error associated with a media manifest.
`const Int`	`ERROR_CODE_PARSING_MANIFEST_UNSUPPORTED = 3004` Caused by an unsupported feature in a media manifest.
`const Int`	`ERROR_CODE_PERMISSION_DENIED = -4` Caused by a command that is not allowed.
`const Int`	`ERROR_CODE_PREMIUM_ACCOUNT_REQUIRED = -103` Caused by a premium account that is required but the user is not subscribed.
`const 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.
`const Int`	`ERROR_CODE_SETUP_REQUIRED = -108` Caused by playback that needs manual user intervention.
`const Int`	`ERROR_CODE_SKIP_LIMIT_REACHED = -107` Caused by the skip limit that is exhausted.
`const Int`	`ERROR_CODE_TIMEOUT = 1003` Caused by a generic timeout.
`const Int`	`ERROR_CODE_UNSPECIFIED = 1000` Caused by an error whose cause could not be identified.
`const Int`	`@UnstableApi ERROR_CODE_VIDEO_FRAME_PROCESSING_FAILED = 7001` Caused by a failure when processing a video frame.
`const Int`	`@UnstableApi ERROR_CODE_VIDEO_FRAME_PROCESSOR_INIT_FAILED = 7000` Caused by a failure when initializing a `VideoFrameProcessor`.
`const 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 functions

From androidx.media3.common.PlaybackException

`java-static Boolean`	`@UnstableApi areErrorInfosEqual( playbackException1: PlaybackException?, playbackException2: PlaybackException? )` Returns true if both `PlaybackException` instances have `the same error info` or both are null.
`java-static PlaybackException!`	`@UnstableApi fromBundle(bundle: Bundle!)` Restores a `PlaybackException` from a `Bundle`.
`String!`	`getErrorCodeName()` Equivalent to `PlaybackException.getErrorCodeName(this.errorCode)`.
`java-static String!`	`getErrorCodeName(@PlaybackException.ErrorCode errorCode: Int)` 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 Unit`	`addSuppressed(exception: Throwable!)`
`synchronized Throwable!`	`fillInStackTrace()`
`synchronized Throwable!`	`getCause()`
`String!`	`getLocalizedMessage()`
`String!`	`getMessage()`
`Array<StackTraceElement!>!`	`getStackTrace()`
`synchronized Array<Throwable!>!`	`getSuppressed()`
`synchronized Throwable!`	`initCause(cause: Throwable!)`
`Unit`	`printStackTrace()`
`Unit`	`setStackTrace(stackTrace: Array<StackTraceElement!>!)`
`String!`	`toString()`

Inherited properties

From androidx.media3.common.PlaybackException

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

Constants

TYPE_REMOTE

@UnstableApi
const val TYPE_REMOTE = 3: Int

The error occurred in a remote component.

Call getMessage to retrieve the message associated with the error.

TYPE_RENDERER

@UnstableApi
const val TYPE_RENDERER = 1: Int

The error occurred in a Renderer.

Call getRendererException to retrieve the underlying cause.

TYPE_SOURCE

@UnstableApi
const val TYPE_SOURCE = 0: Int

The error occurred loading data from a MediaSource.

Call getSourceException to retrieve the underlying cause.

TYPE_UNEXPECTED

@UnstableApi
const val TYPE_UNEXPECTED = 2: Int

The error was an unexpected RuntimeException.

Call getUnexpectedException to retrieve the underlying cause.

Public functions

createForRemote

@UnstableApi
java-static fun createForRemote(message: String!): ExoPlaybackException!

Creates an instance of type TYPE_REMOTE.

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

Returns
`ExoPlaybackException!`	The created instance.

createForRenderer

@UnstableApi
java-static fun createForRenderer(
    cause: Throwable!,
    rendererName: String!,
    rendererIndex: Int,
    rendererFormat: Format?,
    @C.FormatSupport rendererFormatSupport: Int,
    isRecoverable: Boolean,
    @PlaybackException.ErrorCode errorCode: Int
): ExoPlaybackException!

createForRenderer

@UnstableApi
java-static fun createForRenderer(
    cause: Throwable!,
    rendererName: String!,
    rendererIndex: Int,
    rendererFormat: Format?,
    @C.FormatSupport rendererFormatSupport: Int,
    mediaPeriodId: MediaSource.MediaPeriodId?,
    isRecoverable: Boolean,
    @PlaybackException.ErrorCode errorCode: Int
): ExoPlaybackException!

Creates an instance of type TYPE_RENDERER.

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

Returns
`ExoPlaybackException!`	The created instance.

createForSource

@UnstableApi
java-static fun createForSource(cause: IOException!, errorCode: Int): ExoPlaybackException!

Creates an instance of type TYPE_SOURCE.

Parameters
`cause: IOException!`	The cause of the failure.
`errorCode: Int`	See `errorCode`.

Returns
`ExoPlaybackException!`	The created instance.

createForUnexpected

@UnstableApi
java-static fun createForUnexpected(cause: RuntimeException!): ExoPlaybackException!

createForUnexpected

@UnstableApi
java-static fun createForUnexpected(
    cause: RuntimeException!,
    @PlaybackException.ErrorCode errorCode: Int
): ExoPlaybackException!

Creates an instance of type TYPE_UNEXPECTED.

Parameters
`cause: RuntimeException!`	The cause of the failure.
`@PlaybackException.ErrorCode errorCode: Int`	See `errorCode`.

Returns
`ExoPlaybackException!`	The created instance.

errorInfoEquals

fun errorInfoEquals(that: PlaybackException?): Boolean

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
fun getRendererException(): Exception!

Retrieves the underlying error when type is TYPE_RENDERER.

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

getSourceException

@UnstableApi
fun getSourceException(): IOException!

Retrieves the underlying error when type is TYPE_SOURCE.

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

getUnexpectedException

@UnstableApi
fun getUnexpectedException(): RuntimeException!

Retrieves the underlying error when type is TYPE_UNEXPECTED.

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

Public properties

mediaPeriodId

@UnstableApi
val mediaPeriodId: MediaSource.MediaPeriodId?

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

rendererFormat

@UnstableApi
val rendererFormat: Format?

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
val rendererFormatSupport: Int

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
val rendererIndex: Int

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

rendererName

@UnstableApi
val rendererName: String?

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

type

@UnstableApi
@ExoPlaybackException.Type
val type: Int

The Type of the playback failure.

ExoPlaybackException

Summary

Nested types

Constants

Public functions

Public properties

Inherited Constants

Inherited functions

Inherited properties

Constants

TYPE_REMOTE

TYPE_RENDERER

TYPE_SOURCE

TYPE_UNEXPECTED

Public functions

createForRemote

createForRenderer

createForRenderer

createForSource

createForUnexpected

createForUnexpected

errorInfoEquals

getRendererException

getSourceException

getUnexpectedException

Public properties

mediaPeriodId

rendererFormat

rendererFormatSupport

rendererIndex

rendererName

type