fl-player-interface/com.quickplay.vstb7.player

Package-level declarations

Types

data class AudioLanguageInfo(val languageCode: String, val roles: List<AudioTrackRole>? = null, val mimeType: String? = null)

Represents audio language information including language code, roles, and mime type.

AudioTrackRole

enum AudioTrackRole : Enum<AudioTrackRole>

Represents different roles that an audio track can have. Maps to ExoPlayer's role flags for consistency with accessibility standards.

ComposablePlayer

interface ComposablePlayer : Player

ContentURLOverrideAction

typealias ContentURLOverrideAction = suspend (rawPlayer: Any, contentURL: String, params: Map<String, Any>?) -> String

CustomPlaybackSessionContext

data class CustomPlaybackSessionContext(val contentURLOverrideAction: ContentURLOverrideAction, val contextData: Map<String, Any>? = null)

LanguageTrackSelector

interface LanguageTrackSelector

Interface for selecting preferred audio and subtitle languages for media playback. When specifying a language, this should be a valid IETF BCP 47 language code. Note that language code tag can also be specified as an ISO 639-2/3 (three-letter codes). BCP 47 is the IETF's Best Current Practices for language tags, defined in RFC 5646, and it incorporates ISO 639 codes as primary language subtag. The authoritative source for valid BCP 47 subtag, including those derived from ISO 639, is the IANA Language Subtag Registry. This registry ensures a single, unambiguous subtag for each language, resolving potential conflicts or ambiguities that might arise from different ISO 639 parts.

LivePlaybackRecoveryPreemptStep

typealias LivePlaybackRecoveryPreemptStep = () -> Unit

A suspend-free action invoked synchronously inside the recovery coroutine, immediately before the adapter resets its media source during live recovery. Intended for analytics providers (e.g. NPAW) to set flags that suppress spurious stop events that may be triggered by that recovery reset.

MediaPlaylistControllable

interface MediaPlaylistControllable

Represents Player protocol to support playback with sequential list of playable media content a.k.a playlist.

MediaPlaylistItem

data class MediaPlaylistItem(val baseConfiguration: MediaPlaylistItem.BaseConfiguration, val drmConfiguration: MediaPlaylistItem.DRMConfiguration? = null, val adsConfiguration: MediaPlaylistItem.AdsConfiguration? = null, val downloadConfiguration: MediaPlaylistItem.DownloadConfiguration? = null, val advancedConfiguration: MediaPlaylistItem.AdvancedConfiguration? = null)

Represents a single item of playable media content within a playlist.

MediaPlaylistItemTransitionInfo

data class MediaPlaylistItemTransitionInfo(val mediaPlaylistItem: MediaPlaylistItem, val transitionTrigger: Int)

Represents MediaPlaylistItem transition payload.

MediaPlaylistItemTransitionTrigger

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.TYPE_PARAMETER, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.TYPE])

annotation class MediaPlaylistItemTransitionTrigger

MediaTrackControllable

interface MediaTrackControllable : LanguageTrackSelector

Interface for controlling and querying media tracks, specifically focusing on track variants and language selection.

PlaybackPolicyHandler

interface PlaybackPolicyHandler

Handler interface that enforces the policies related to the content with ads, and promos where special handling is required for seeking, timeline adjustment, interrupt handling etc.

Player

interface Player : MediaTrackControllable, MediaPlaylistControllable, EventSender

A Player interface defining traditional high-level functionality such as play, pause, seek etc, and properties of currently playing media content.

PlayerAdapter

interface PlayerAdapter : MediaTrackControllable, MediaPlaylistControllable, AdControllable

A generic adapter interface that any RAW player must adapt to, for seamless working with Player and it's internal state-machines.

PlayerInterfaceLibraryInfo

object PlayerInterfaceLibraryInfo

Information about the library such as version and name.

PlaylistPreloadConfiguration