sdk/com.brightcove.player.view/BaseVideoView

BaseVideoView

abstract class BaseVideoView : Component

BaseVideoView provides the base functionality for BrightcoveVideoView, which for historical reasons isn't named BrightcoveSurfaceVideoView, and BrightcoveTextureVideoView. Those two classes are designed to be dropped into your XML layouts as a replacement for Android's native VideoView. This class provides public methods to mirror that of VideoView, plus additional logic for handling things like playlists. This class uses an EventEmitter to wire together components, like the VideoDisplayComponent and VideoPlaybackController.

Inheritors

BrightcoveVideoView

BrightcoveTextureVideoView

Constructors

BaseVideoView

constructor(context: Context)

constructor(context: Context, attributeSet: AttributeSet)

constructor(context: Context, attributeSet: AttributeSet, defStyle: Int)

Types

OnVideoViewSizeChangedListener

interface OnVideoViewSizeChangedListener

Interface definition for a callback to be invoked when the BaseVideoView's size changes.

Properties

concurrencyClient

open val concurrencyClient: ConcurrencyClient

isVideoZoomingEnabled

open var isVideoZoomingEnabled: Boolean

zoomController

open val zoomController: ZoomController

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(newVideos: Collection<Video>)

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

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

Inserts all videos in the collection at the specified index.

addListener

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

addOnVideoViewSizeChangedListener

open fun addOnVideoViewSizeChangedListener(onVideoViewSizeChangedListener: BaseVideoView.OnVideoViewSizeChangedListener)

addSubtitleSource

open fun addSubtitleSource(uri: Uri, format: BrightcoveCaptionFormat)

For adding subtitle sources to the Brightcove Player.

canPause

open fun canPause(): Boolean

canSeekBackward

open fun canSeekBackward(): Boolean

canSeekForward

open fun canSeekForward(): Boolean

clear

open fun clear()

Removes all videos from the list.

clearOnCompletionListener

open fun clearOnCompletionListener()

clearOnPreparedListener

open fun clearOnPreparedListener()

disableClosedCaptioningRendering

open fun disableClosedCaptioningRendering()

disableStreamConcurrency

open fun disableStreamConcurrency()

Disable Generic Stream Concurrency

dispatchKeyEvent

open fun dispatchKeyEvent(event: KeyEvent): Boolean

enableStreamConcurrency

open fun enableStreamConcurrency()

Enable Generic Stream Concurrency Note: Stream Concurrency can only be enable before video playback

finishInitialization

open fun finishInitialization()

This method finishes initializing the BaseVideoView.

get

open fun get(index: Int): Video

getAnalytics

open fun getAnalytics(): Analytics

Returns the analytics component, the part of the player that monitors and tracks video playback and engagement.

getAudioSessionId

open fun getAudioSessionId(): Int

getAudioTracksController

open fun getAudioTracksController(): BrightcoveAudioTracksController

getBrightcoveMediaController

open fun getBrightcoveMediaController(): BrightcoveMediaController

Access the Brightcove media controller.

getBufferPercentage

open fun getBufferPercentage(): Int

getCalculateSize

fun BaseVideoView.getCalculateSize(width: String?, height: String?): <Error class: unknown class><Int, Int>

getCalculateSize is an extension function that return the correct Sizes from an element taking the BaseVideoView width and height as 100%

getClosedCaptioningController

open fun getClosedCaptioningController(): BrightcoveClosedCaptioningController

getClosedCaptioningView

open fun getClosedCaptioningView(): BrightcoveClosedCaptioningView

getCurrentIndex

open fun getCurrentIndex(): Int

getCurrentPosition

open fun ~~getCurrentPosition~~(): Int

getCurrentPositionLong

open fun getCurrentPositionLong(): Long

getCurrentVideo

open fun getCurrentVideo(): Video

getDuration

open fun ~~getDuration~~(): Int

getDurationLong

open fun getDurationLong(): Long

getEventEmitter

open fun getEventEmitter(): EventEmitter

Getter for the EventEmitter used by this View

getList

open fun getList(): List<Video>

getMeasuredVideoHeight

open fun getMeasuredVideoHeight(): Int

Gets the rendered height of the video on the screen.

getMeasuredVideoWidth

open fun getMeasuredVideoWidth(): Int

Gets the rendered width of the video on the screen.

getMediaController

open fun getMediaController(): MediaController

Access the legacy media controller.

getPictureInPictureManager

open fun getPictureInPictureManager(): PictureInPictureManager

getPlayback

open fun getPlayback(): MediaPlayback

getPlaybackController

open fun getPlaybackController(): VideoPlaybackController

Returns the video playback controller, the component of the player responsible for managing video playback and emitting cue points.

getRenderView

abstract fun getRenderView(): RenderView

Gets refers to the view that will render the video.

getScreenLayoutParams

fun BaseVideoView.getScreenLayoutParams(top: String?, left: String?, width: Int? = 0, height: Int? = 0): <Error class: unknown class>?

getScreenLayoutParams is an extension function that get the position (top, left) as a percentage from the API and return the layout parameters taking the BaseVideoView width and height as 100% if it is an image or layout will also receive the width and height to add the sizes

getScreenSizes