ogplayer-core/com.ogplayer.api/OGPlayerError

OGPlayerError

sealed class OGPlayerError

Sealed hierarchy of playback errors surfaced by the SDK.

Every error carries a stable numeric code (see Codes for the full table), a matching machine-readable codeName, a human-readable message, a retryable hint (true when retrying the same load has a reasonable chance of succeeding), and the underlying Media3 media3ErrorCode + cause for deep debugging. Codes are stable across SDK releases: new codes may be added, existing ones never change meaning.

Typical handling:

override fun onError(error: OGPlayerError) {
    analytics.log("playback_error", error.code, error.codeName)
    when (error) {
        is OGPlayerError.Network -> if (error.retryable) scheduleRetry()
        is OGPlayerError.Drm -> showEntitlementMessage(error.httpStatusCode)
        else -> showGenericError(error.code)
    }
}

Inheritors

Types

object Codes

The complete, stable OGPlayer error code table.

class Download : OGPlayerError

Download / offline failure (surfaced via OGDownloadListener).

class Drm : OGPlayerError

DRM failure that survived the SDK's automatic recovery attempts.

class Live : OGPlayerError

Live-stream failure that survived automatic recovery.

class Network : OGPlayerError

Network-level failure while loading media (connectivity, HTTP).

class Renderer : OGPlayerError

Decoding/rendering failed on this device.

class Source : OGPlayerError

The media itself is malformed or unsupported (manifest, container).

class Unknown(val message: String, val media3ErrorCode: Int, val cause: Throwable?) : OGPlayerError

Anything not covered above.

Properties

val cause: Throwable?

Stable OGPlayer error code — full table in Codes.

val codeName: String

Stable machine-readable name for code (log/analytics friendly).

media3ErrorCode

val media3ErrorCode: Int

Underlying androidx.media3 PlaybackException error code.

val message: String

Human-readable detail for logs; not intended for end users.

val retryable: Boolean

True when retrying the same load may succeed (transient failures).

Functions

open override fun toString(): String