ogplayer-core/com.ogplayer.api

Package-level declarations

Types

Playback quality and lifecycle events for analytics integrations.

class AudioTrack(val id: String, val language: String?, val label: String?, val channelCount: Int, val isSelected: Boolean)

A selectable audio track (language/description) of the current media.

BufferReason

enum BufferReason : Enum<BufferReason>

Why a AnalyticsEvent.BufferStart happened — rebuffer-ratio contracts need initial and seek buffering excluded, so the reason is explicit instead of inferred from event order.

ContentRating

sealed interface ContentRating

A content-rating icon shown at program start (Kijkwijzer-style).

DeviceOrientation

enum DeviceOrientation : Enum<DeviceOrientation>

Physical device orientation, as reported by the view layer.

DrmConfig

class DrmConfig

DRM configuration for an OGMediaItem (Widevine).

DrmRenewalReason

enum DrmRenewalReason : Enum<DrmRenewalReason>

Why the SDK silently renewed a DRM session.

DrmScheme

enum DrmScheme : Enum<DrmScheme>

DRM scheme for license acquisition. Widevine is the Android default.

DrmTokenProvider

fun interface DrmTokenProvider

Supplies a DRM license token. Called on every license request — including renewals — so implementations must return a currently valid token each time (fetch it, refresh auth, etc.). Never cache a token beyond its lifetime; the SDK never caches it at all.

DrmTokenRequest

class DrmTokenRequest(val licenseUrl: String, val mediaItem: OGMediaItem)

Context for a DrmTokenProvider.getToken call.

InternalOGPlayerApi

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR])

annotation class InternalOGPlayerApi

Marks declarations that are internal to the ogplayer SDK modules. They carry no compatibility guarantees and must not be used by apps.

LiveInfo

class LiveInfo(val streamType: StreamType, val dvrWindowMs: Long, val atLiveEdge: Boolean, val latencyMs: Long, val playheadWallClockMs: Long? = null)

Runtime facts about the current live stream. Null for VOD.

OGAnalyticsListener

fun interface OGAnalyticsListener

Receives AnalyticsEvents from an OGPlayer. Host apps adapt these to their analytics vendor (Conviva, Tealium, ...).

OGBufferProfile

class OGBufferProfile(val targetBufferBytes: Int, val maxBufferMs: Int)

A capped "standby" buffering profile for players that are prepared but not on screen — the vertical feed keeps its preloaded items on this profile so a whole pool stays within a predictable memory budget. Set it once via OGPlayer.Builder.setStandbyBufferProfile; switch the live role with OGPlayer.setBufferRole.

OGBufferRole

enum OGBufferRole : Enum<OGBufferRole>

Buffering role of a player with a standby profile; see OGBufferProfile.

OGMediaItem

class OGMediaItem

Immutable description of a piece of media to play.

OGPlayer

interface OGPlayer

The ogplayer playback engine.

OGPlayerError

sealed class OGPlayerError

Sealed hierarchy of playback errors surfaced by the SDK.

OGPlayerSdk

object OGPlayerSdk

Entry point metadata for the ogplayer SDK.

PlaybackListener

interface PlaybackListener

Callbacks for playback lifecycle events. All methods have empty defaults.

PlaybackState

enum PlaybackState : Enum<PlaybackState>

High-level playback state of an OGPlayer.

RecoveryReason

enum RecoveryReason : Enum<RecoveryReason>

Why a AnalyticsEvent.PlaybackRecovered re-prepare happened.

StreamType

enum StreamType : Enum<StreamType>

Declared stream type of a media item. Drives default UI behavior.

SubtitleSource

class SubtitleSource(val url: String, val language: String, val label: String? = null, val isDefault: Boolean = false)

A sideloaded subtitle file (WebVTT/TTML/SRT) attached to a media item.

SubtitleStyle

class SubtitleStyle

Caption rendering style. When applyEmbeddedStyles is false (default), this styling always wins over in-stream text styling, while WebVTT positioning (line/position/align cue settings) is always preserved.

TextTrack

class TextTrack(val id: String, val language: String?, val label: String?, val isSelected: Boolean)

A selectable subtitle/caption track of the current media.

VideoQuality

class VideoQuality(val id: String, val width: Int, val height: Int, val bitrate: Int, val isSelected: Boolean)

A selectable video rendition of the current media.

VolumeControlMode

enum VolumeControlMode : Enum<VolumeControlMode>

How the player's volume slider behaves.