theolive/com.theolive.player.api/THEOlivePlayer

THEOlivePlayer

class THEOlivePlayer

The player API.

Properties

var muted: Boolean

Get or set whether the audio is muted.

val paused: Boolean

Get or set whether the player is paused.

var volume: Double

Get the volume of the audio.

Functions

addEventListener

fun addEventListener(eventListener: EventListener)

Add an event listener.

addHeaderProvider

fun addHeaderProvider(headerProvider: HeaderProvider)

Add a header provider which allows adding headers to the requests the player makes.

fun goLive()

Seek to the live edge.

fun loadChannel(channelId: String)

Load a channel.

fun pause()

Pause playback.

fun play()

Start or resume playback.

preloadChannels

fun preloadChannels(channelIds: Array<String>)

Preload some channels to allow faster switching between channels. This will retrieve the metadata of all the given channel ids and store it so next loadChannel calls are faster.

removeEventListener

fun removeEventListener(eventListener: EventListener)

Remove an event listener.

removeHeaderProvider

fun removeHeaderProvider(headerProvider: HeaderProvider)

Remove a previously added header provider.

fun reset()

Resets the player. This will stop playback and reset the state. But unlike destroy, can be followed up with a new loadChannel call.