sdk/com.brightcove.player.controller/BrightcoveClosedCaptioningController

BrightcoveClosedCaptioningController

@ListensFor(events = [EventType.CAPTIONS_LANGUAGES, EventType.STOP, EventType.ENTER_TV_MODE, EventType.HIDE_PLAYER_OPTIONS, EventType.ACTIVITY_RESUMED])
@Emits(events = [EventType.CAPTIONS_DIALOG_OK, EventType.CAPTIONS_DIALOG_SETTINGS, EventType.TOGGLE_CLOSED_CAPTIONS, EventType.SELECT_CLOSED_CAPTION_TRACK])
open class BrightcoveClosedCaptioningController : AbstractComponent

A controller class for managing closed captioning dialogue windows.

Constructors

Link copied to clipboard
constructor(videoView: BaseVideoView, context: Context)
Constructor

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open fun addListener(eventType: String, listener: EventListener)
Convenience method to add an EventListener for the given type using the EventEmitter.on() method.
Link copied to clipboard
open fun addOnceListener(eventType: String, listener: EventListener)
Convenience method to add an EventListener for the given type using the EventEmitter.once() method.
Link copied to clipboard
open fun checkIfCaptionsExist(video: Video): Boolean
Check to see if the Video passed in has closed captioning data.
Link copied to clipboard
open fun getEventEmitter(): EventEmitter
Provides a reference to the EventEmitter with which this component was initialized
Link copied to clipboard
open fun isCaptioningEnabled(): Boolean
Checks the closed captioning enabled/disabled state from the applications shared preferences.
Link copied to clipboard
open fun removeListener(eventType: String)
Removes the specified listener from the EventEmitter.
Link copied to clipboard
open fun removeListeners()
Removes all set listeners from the EventEmitter.
Link copied to clipboard
open fun saveClosedCaptioningState(state: Boolean)
Save the closed captioning enabled/disabled state to the applications shared preferences.
Link copied to clipboard
open fun selectCaptions(trackIndex: Int)
Selects the caption option and and emits the one selected.
Link copied to clipboard
open fun setLocaleCode(localeCode: String)
Stores the locale code in the default shared preferences, so it will be persisted.
Link copied to clipboard
open fun setShouldImportSystemSettings(shouldImport: Boolean)
Method to set whether to import the system caption settings before displaying captions on a video.
Link copied to clipboard
open fun showCaptionsDialog()
Helper that prepares the captions dialog with the current state and displays the dialog over the video player.
Link copied to clipboard
open fun validateCaptionSourcesField(obj: Any): Boolean
Helper method to validate the types of the CAPTION_SOURCES video field, which should always be a List