sdk/com.brightcove.player.captioning/BrightcoveClosedCaption

BrightcoveClosedCaption

open class BrightcoveClosedCaption : Block

A class for describing a closed caption, comprised of a start and end time as well as the caption text.

Constructors

Link copied to clipboard
constructor()
constructor(beginTime: Int, endTime: Int, textLines: List<List<Span>>)
Deprecated.
constructor(beginTime: Long, endTime: Long, textLines: List<List<Span>>)
Initializes a Caption with the given begin time, end time, and text lines.
constructor(beginTime: Int, endTime: Int, caption: String)
Deprecated.
constructor(beginTime: Long, endTime: Long, caption: String)
Initializes a Caption with the given begin time, end time, and text lines.

Properties

Link copied to clipboard
open val caption: String
Link copied to clipboard
open var lines: List<List<Span>>

Functions

Link copied to clipboard
open fun getBackgroundColor(): String
The background color string.
Link copied to clipboard
open fun getBeginTime(): Int
Deprecated.
Link copied to clipboard
open fun getBeginTimeLong(): Long
The starting time of the element in milliseconds.
Link copied to clipboard
open fun getColor(): String
The color string.
Link copied to clipboard
open fun getEndTime(): Int
Deprecated.
Link copied to clipboard
open fun getEndTimeLong(): Long
The ending time of the element in milliseconds.
Link copied to clipboard
open fun getFontFamily(): String
Link copied to clipboard
open fun getFontSize(): Length
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun getID(): String
The identifier of the element.
Link copied to clipboard
open fun getRegion(): String
The region name for this timed-text element.
Link copied to clipboard
open fun getStyleName(): String
The style name string.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun setBackgroundColor(backgroundColor: String)
The background color string.
Link copied to clipboard
open fun setBeginTime(beginTime: Int)
Deprecated.
open fun setBeginTime(beginTime: Long)
The starting time of the element in milliseconds.
Link copied to clipboard
open fun setColor(color: String)
The color string.
Link copied to clipboard
open fun setEndTime(endTime: Int)
Deprecated.
open fun setEndTime(endTime: Long)
The ending time of the element in milliseconds.
Link copied to clipboard
open fun setFontFamily(fontFamily: String)
Link copied to clipboard
open fun setFontSize(fontSize: Length)
Link copied to clipboard
open fun setFontStyle(fontStyle: StyledElement.FontStyle)
Link copied to clipboard
open fun setFontWeight(fontWeight: StyledElement.FontWeight)
Link copied to clipboard
open fun setID(id: String)
The identifier of the element.
Link copied to clipboard
open fun setRegion(region: String)
The region name for this timed-text element.
Link copied to clipboard
open fun setStyleName(styleName: String)
The style name string.
Link copied to clipboard
open fun setTextAlign(textAlign: StyledElement.TextAlign)
Link copied to clipboard