sdk/com.brightcove.player.model/Region

Region

open class Region : StyledElement

Represents a region definition for targeting caption rendering on screen in a TTML document.

See also

<a href="http://www.w3.org/TR/ttaf1-dfxp/#layout-vocabulary-region">http://www.w3.org/TR/ttaf1-dfxp/#layout-vocabulary-region</a>

Constructors

constructor()

Types

enum DisplayAlign

Properties

open var displayAlign: Region.DisplayAlign

open var extentX: Length

open var extentY: Length

open var originX: Length

open var originY: Length

Functions

getBackgroundColor

open fun getBackgroundColor(): String

The background color string.

open fun getColor(): String

The color string.

open fun getFontFamily(): String

open fun getFontSize(): Length

open fun getFontStyle(): StyledElement.FontStyle

open fun getFontWeight(): StyledElement.FontWeight

open fun getID(): String

The identifier of the element.

open fun getStyleName(): String

The style name string.

open fun getTextAlign(): StyledElement.TextAlign

getTextDecoration

open fun getTextDecoration(): StyledElement.TextDecoration

setBackgroundColor

open fun setBackgroundColor(backgroundColor: String)

The background color string.

open fun setColor(color: String)

The color string.

open fun setFontFamily(fontFamily: String)

open fun setFontSize(fontSize: Length)

open fun setFontStyle(fontStyle: StyledElement.FontStyle)

open fun setFontWeight(fontWeight: StyledElement.FontWeight)

open fun setID(id: String)

The identifier of the element.

open fun setStyleName(styleName: String)

The style name string.

open fun setTextAlign(textAlign: StyledElement.TextAlign)

setTextDecoration

open fun setTextDecoration(textDecoration: StyledElement.TextDecoration)