bbnativeplayersdk-kotlin/com.bluebillywig.bbnativeplayersdk/BBNativePlayerAPI

BBNativePlayerAPI

class BBNativePlayerAPI(playerView: BBNativePlayerView, eventBus: EventBus?) : EventListenerInterface

BBNativePlayerAPI is the convenience API, accessible via BBNativePlayerView::player. It simply wraps BBNativePlayerView::callApiMethod & BBNativePlayerView::getApiProperty

Parameters

playerView

Constructors

BBNativePlayerAPI

constructor(playerView: BBNativePlayerView, eventBus: EventBus?)

no need to call this directly; use the playerView's player property

Properties

adMediaHeight

val adMediaHeight: Int?

Ad media height in pixels (read-only)

adMediaWidth

val adMediaWidth: Int?

Ad media width in pixels (read-only)

clipData

val clipData: MediaClip?

Clip data (read-only)

controls

var controls: Boolean?

Controls shown

duration

val duration: Double?

Media duration in seconds (read-only)

inView

var inView: Boolean?

InView override

mode

val mode: String?

Mode (read-only)

muted

var muted: Boolean?

Muted state

phase

val phase: Phase?

Phase (read-only)

playoutData

val playoutData: Playout?

Playout data (read-only)

projectData

val projectData: Project?

Project data (read-only)

relatedItems

var relatedItems: List<ContentItemInterface>?

Functions

__destruct

fun __destruct()

Destruct, freeing all memory allocated internally

autoPlayNextCancel

fun autoPlayNextCancel()

Cancel AutoPlayNext countdown

collapse

fun collapse()

Collapse

enterFullScreen

fun enterFullScreen()

Enter fullscreen

exitFullScreen

fun exitFullScreen()

Leave fullscreen

expand

fun expand()

Expand

loadWithClip

fun loadWithClip(clip: MediaClip, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Clip

loadWithClipId

fun loadWithClipId(clipId: String, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Clip Id

loadWithClipJson

fun loadWithClipJson(clipJson: String, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Clip JSON

loadWithClipList

fun loadWithClipList(clipList: MediaClipList, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Clip List

loadWithClipListId

fun loadWithClipListId(clipListId: String, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Clip List Id

loadWithClipListJson

fun loadWithClipListJson(clipListJson: String, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Clip List JSON

loadWithProject

fun loadWithProject(project: Project, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Project

loadWithProjectId

fun loadWithProjectId(projectId: String, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Project Id

loadWithProjectJson

fun loadWithProjectJson(projectJson: String, initiator: String? = "external", autoPlay: Boolean? = true, seekTo: Number? = null)

Load With Project JSON

onEvent

open override fun onEvent(eventType: EventName, data: Map<String, Any?>?)

pause

fun pause()

Pause playback

play

fun play()

Start / Resume playback

seek

fun seek(offsetInSeconds: Number)

Seek to time offset

setMuted

fun setMuted(muted: Boolean, userAction: Boolean = false)

Set Muted state

setVolume

fun setVolume(volume: Double, userAction: Boolean = false)

Set Volume