sdk/com.brightcove.player.playback/MediaPlayerPlayback

MediaPlayerPlayback

@ListensFor(events = [EventType.BUFFERED_UPDATE, EventType.COMPLETED, EventType.DID_PLAY, EventType.DID_SET_SOURCE, EventType.ON_FRAME_AVAILABLE, EventType.PLAY, EventType.PAUSE, EventType.PREBUFFER_NEXT_VIDEO, EventType.READY_TO_PLAY, EventType.STOP, EventType.SEEK_TO, EventType.SET_SOURCE, EventType.SET_VOLUME, EventType.VIDEO_DURATION_CHANGED, EventType.WILL_CHANGE_VIDEO, EventType.WILL_INTERRUPT_CONTENT, EventType.WILL_RESUME_CONTENT])

open class MediaPlayerPlayback : AbstractComponent, MediaPlayback<Player>

Constructors

MediaPlayerPlayback

constructor(renderView: RenderView, context: Context, eventEmitter: EventEmitter)

Types

OnSetSourceListener

open inner class OnSetSourceListener : EventListener

Properties

analytics

open val analytics: Analytics

currentIndex

open var currentIndex: Int

currentSource

open val currentSource: Source

currentVideo

open val currentVideo: Video

isPlayingForTesting

open var isPlayingForTesting: Boolean

onBufferingUpdateListener

val onBufferingUpdateListener: OnBufferingUpdateListener

onCompletionListener

val onCompletionListener: OnCompletionListener

onErrorListener

val onErrorListener: OnErrorListener

onInfoListener

val onInfoListener: OnInfoListener

onPreparedListener

val onPreparedListener: OnPreparedListener

onSeekCompleteListener

val onSeekCompleteListener: OnSeekCompleteListener

playlist

val playlist: List<Video>

sourceController

val sourceController: DefaultSourceSelectionController

Functions

add

open fun add(video: Video)

Adds the video to the end of the video list.

open fun add(index: Int, video: Video)

Adds the video to the video list at the specified index.

addAll

open fun addAll(videos: Collection<Video>)

Add all videos in the collection to the end of the list.

open fun addAll(index: Int, videos: Collection<Video>)

Inserts all videos in the collection at the specified index.

addListener

open fun addListener(eventType: String, listener: EventListener)

Convenience method to add an EventListener for the given type using the EventEmitter.on() method.

addOnceListener

open fun addOnceListener(eventType: String, listener: EventListener)

Convenience method to add an EventListener for the given type using the EventEmitter.once() method.

clear

open fun clear()

Removes all videos from the list.

destroyPlayer

open fun destroyPlayer()

Destroys the current player and releases it from memory.

emitErrorEvent

open fun emitErrorEvent(message: String)

Emits an error event with the message passed in the event's properties

open fun emitErrorEvent(message: String, exception: Exception)

Emits an error event including the message passed and the exception in the properties

getBufferPercentage

open fun getBufferPercentage(): Int

Returns the buffer percentage

getCurrentPosition

open fun getCurrentPosition(): Long

Returns the current playhead position of the underlying video player.

getEventEmitter

open fun getEventEmitter(): EventEmitter

Provides a reference to the EventEmitter with which this component was initialized

getLiveEdge

open fun getLiveEdge(): Long

Obtains the playhead position of the "live edge".

getNotification

open fun getNotification(): PlaybackNotification

Get the object which handles showing an on-going player notification.

getPlayer

open fun getPlayer(): MediaPlayer

Get the player used for media playback.

getVideoAt

open fun getVideoAt(index: Int): Video

Gets a video from the video list at the specified index

getVolume

open fun getVolume(): Float

hasDvr

open fun hasDvr(): Boolean

Indicates if Live with DVR is supported.

isCurrentVideo360Mode

open fun isCurrentVideo360Mode(): Boolean

Returns true if the video is a 360 video otherwise returns false

isInLiveEdge

open fun isInLiveEdge(): Boolean

Checks the current playhead position with the live edge position and determines if it is in live edge.

isLive

open fun isLive(): Boolean

Provides a default for handling live videos.

isPlaying

open fun isPlaying(): Boolean

isPlayingAudioOnly

open fun isPlayingAudioOnly(): Boolean

Check if the player is currently playing and the media is audio-only.

isSourceSet

open fun isSourceSet(): Boolean

Returns if a source has been set

onTaskRemoved

open fun onTaskRemoved(rootIntent: Intent)

This is called when the MediaPlaybackService is currently running and the user has removed a task that comes from the service's application.

openCurrentVideoSource

open fun openCurrentVideoSource()

Prepares the player to play the current video source.

openVideo

open fun openVideo(video: Video, source: Source)

Creates, configures, and prepares a new instance of MediaPlayback

remove

open fun remove(index: Int)

Removes the video at the specified index.

removeListener

open fun removeListener(eventType: String)

Removes the specified listener from the EventEmitter.

removeListeners

open fun removeListeners()

Removes all set listeners from the EventEmitter.

replace

open fun replace(index: Int, video: Video)

Removes and replaces the video at the specified index.

setProgressInterval

open fun setProgressInterval(progressInterval: Int)

Sets the the interval in milliseconds at which to fire PROGRESS events during playback.

setVideoPath

open fun setVideoPath(path: String): Video

Replaces player content with the video at the specified path.

open fun setVideoPath(videoPath: String, languageCodeCaptionsMap: Map<String, String>): Video

Replace player content with the video and captions at the specified paths.

setVideoSource

open fun setVideoSource(video: Video, source: Source)

Sets the video source that will be used for playback.