sdk/com.brightcove.player.view/BrightcoveClosedCaptioningView

BrightcoveClosedCaptioningView

@Emits(events = [EventType.CAPTIONS_AVAILABLE])
@ListensFor(events = [EventType.CAPTION, EventType.COMPLETED, EventType.DID_LOAD_CLOSED_CAPTIONS, EventType.PROGRESS, EventType.TOGGLE_CLOSED_CAPTIONS, ShowHideController.DID_SHOW_MEDIA_CONTROLS, ShowHideController.DID_HIDE_MEDIA_CONTROLS, EventType.SELECT_CLOSED_CAPTION_TRACK, EventType.DID_ENTER_PICTURE_IN_PICTURE_MODE, EventType.DID_EXIT_PICTURE_IN_PICTURE_MODE, EventType.SEEKBAR_DRAGGING_START, EventType.SEEKBAR_DRAGGING_STOP, EventType.AD_BREAK_STARTED, EventType.AD_BREAK_COMPLETED])
open class BrightcoveClosedCaptioningView : Component

This view (a FrameLayout) implements the proper layout and formatting for closed captions for a BaseVideoView. This view is also a component which is responsible for initiating the loading and parsing of captions.

Constructors

Link copied to clipboard
constructor(context: Context)
constructor(context: Context, attrs: AttributeSet)
constructor(context: Context, attrs: AttributeSet, defStyle: Int)

Types

Link copied to clipboard
enum ClosedCaptioningMode
Specifies the type of captions being used currently.

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open fun clear()
Clears the currently loaded captions from this CaptionsView.
Link copied to clipboard
open fun findCaptionsForPosition(position: Int): ArrayList<LinearLayout>

open fun findCaptionsForPosition(position: Long): ArrayList<LinearLayout>
Retrieves the specific view block containing rendered captions for the given video position in milliseconds, if one exists.
Link copied to clipboard
open fun getCurrentCaptionBlocks(): ArrayList<LinearLayout>
Link copied to clipboard
Link copied to clipboard
open fun getSafeAreaMarginHeight(): Int
Computes the FCC "safe-area margin" height based on the current height of this instance and the SAFE_AREA.
Link copied to clipboard
open fun getSafeAreaMarginWidth(): Int
Computes the FCC "safe-area margin" width based on the current width of this instance and the SAFE_AREA.
Link copied to clipboard
open fun initialize(emitter: EventEmitter)
Initializes the CaptionsView with the given EventEmitter.
open fun initialize(emitter: EventEmitter, baseVideoView: BaseVideoView)
Initializes the CaptionsView with the given EventEmitter and BaseVideoView.
Link copied to clipboard
open fun prepareDFXPCaptions(document: TTMLDocument)
Prepares the rendered View blocks for all captions listed in the given TTMLDocument.
Link copied to clipboard
open fun prepareLayout()
Link copied to clipboard
open fun prepareWebVTTCaptions(document: WebVTTDocument)
Prepares the rendered View blocks for all captions listed in the given WebVTTDocument.
Link copied to clipboard
open fun refreshCaptions()
open fun refreshCaptions(seekToTime: Int)
open fun refreshCaptions(seekToTime: Long)
Link copied to clipboard
open fun setKeepCaptionsWithinVideoBounds(keepCaptionsWithinVideoBounds: Boolean)
The default behaviour of the BrightcoveClosedCaptioningView is to restrict the caption positioning to be within the bounds of the actual video, not the VideoView.
Link copied to clipboard
open fun setMode(mode: BrightcoveClosedCaptioningView.ClosedCaptioningMode)
Specifies the CaptionMode for this CaptionsView.
Link copied to clipboard
open fun setSafeAreaPercent(safeAreaPercent: Float)
Optionally override the default SAFE_AREA with a custom percent.