com.google.android.exoplayer2.text.webvtt

Class WebvttCssStyle

java.lang.Object

com.google.android.exoplayer2.text.webvtt.WebvttCssStyle

public final class WebvttCssStyle
extends java.lang.Object

Style object of a Css style block in a Webvtt file.

See Also:

W3C specification - Apply CSS properties

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WebvttCssStyle.FontSizeUnit Font size unit enum.
static interface	WebvttCssStyle.StyleFlags Style flag enum.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FONT_SIZE_UNIT_EM
static int	FONT_SIZE_UNIT_PERCENT
static int	FONT_SIZE_UNIT_PIXEL
static int	STYLE_BOLD
static int	STYLE_BOLD_ITALIC
static int	STYLE_ITALIC
static int	STYLE_NORMAL
static int	UNSPECIFIED

Constructor Summary

Constructors

Constructor and Description
WebvttCssStyle()

Method Summary

Modifier and Type	Method and Description
void	cascadeFrom(WebvttCssStyle style)
int	getBackgroundColor()
int	getFontColor()
java.lang.String	getFontFamily()
float	getFontSize()
int	getFontSizeUnit()
int	getSpecificityScore(java.lang.String id, java.lang.String tag, java.lang.String[] classes, java.lang.String voice) Returns a value in a score system compliant with the CSS Specificity rules.
int	getStyle() Returns the style or UNSPECIFIED when no style information is given.
android.text.Layout.Alignment	getTextAlign()
boolean	hasBackgroundColor()
boolean	hasFontColor()
boolean	isLinethrough()
boolean	isUnderline()
void	reset()
WebvttCssStyle	setBackgroundColor(int backgroundColor)
WebvttCssStyle	setBold(boolean bold)
WebvttCssStyle	setFontColor(int color)
WebvttCssStyle	setFontFamily(java.lang.String fontFamily)
WebvttCssStyle	setFontSize(float fontSize)
WebvttCssStyle	setFontSizeUnit(short unit)
WebvttCssStyle	setItalic(boolean italic)
WebvttCssStyle	setLinethrough(boolean linethrough)
void	setTargetClasses(java.lang.String[] targetClasses)
void	setTargetId(java.lang.String targetId)
void	setTargetTagName(java.lang.String targetTag)
void	setTargetVoice(java.lang.String targetVoice)
WebvttCssStyle	setTextAlign(android.text.Layout.Alignment textAlign)
WebvttCssStyle	setUnderline(boolean underline)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNSPECIFIED

public static final int UNSPECIFIED

See Also:

Constant Field Values

STYLE_NORMAL

public static final int STYLE_NORMAL

See Also:

Constant Field Values

STYLE_BOLD

public static final int STYLE_BOLD

See Also:

Constant Field Values

STYLE_ITALIC

public static final int STYLE_ITALIC

See Also:

Constant Field Values

STYLE_BOLD_ITALIC

public static final int STYLE_BOLD_ITALIC

See Also:

Constant Field Values

FONT_SIZE_UNIT_PIXEL

public static final int FONT_SIZE_UNIT_PIXEL

See Also:

Constant Field Values

FONT_SIZE_UNIT_EM

public static final int FONT_SIZE_UNIT_EM

See Also:

Constant Field Values

FONT_SIZE_UNIT_PERCENT

public static final int FONT_SIZE_UNIT_PERCENT

See Also:

Constant Field Values

Constructor Detail

WebvttCssStyle

public WebvttCssStyle()

Method Detail

reset

public void reset()

setTargetId

public void setTargetId(java.lang.String targetId)

setTargetTagName

public void setTargetTagName(java.lang.String targetTag)

setTargetClasses

public void setTargetClasses(java.lang.String[] targetClasses)

setTargetVoice

public void setTargetVoice(java.lang.String targetVoice)

getSpecificityScore

public int getSpecificityScore(java.lang.String id,
                               java.lang.String tag,
                               java.lang.String[] classes,
                               java.lang.String voice)

Returns a value in a score system compliant with the CSS Specificity rules.

Parameters:

id - The id of the cue if present, null otherwise.

tag - Name of the tag, null if it refers to the entire cue.

classes - An array containing the classes the tag belongs to. Must not be null.

voice - Annotated voice if present, null otherwise.

Returns:

The score of the match, zero if there is no match.

See Also:

CSS Cascading The score works as follows:

• Id match adds 0x40000000 to the score.
• Each class and voice match adds 4 to the score.
• Tag matching adds 2 to the score.
• Universal selector matching scores 1.

getStyle

@WebvttCssStyle.StyleFlags
public int getStyle()

Returns the style or UNSPECIFIED when no style information is given.

Returns:

UNSPECIFIED, STYLE_NORMAL, STYLE_BOLD, STYLE_BOLD or STYLE_BOLD_ITALIC.

isLinethrough

public boolean isLinethrough()

setLinethrough

public WebvttCssStyle setLinethrough(boolean linethrough)

isUnderline

public boolean isUnderline()

setUnderline

public WebvttCssStyle setUnderline(boolean underline)

setBold

public WebvttCssStyle setBold(boolean bold)

setItalic

public WebvttCssStyle setItalic(boolean italic)

getFontFamily

public java.lang.String getFontFamily()

setFontFamily

public WebvttCssStyle setFontFamily(java.lang.String fontFamily)

getFontColor

public int getFontColor()

setFontColor

public WebvttCssStyle setFontColor(int color)

hasFontColor

public boolean hasFontColor()

getBackgroundColor

public int getBackgroundColor()

setBackgroundColor

public WebvttCssStyle setBackgroundColor(int backgroundColor)

hasBackgroundColor

public boolean hasBackgroundColor()

getTextAlign

public android.text.Layout.Alignment getTextAlign()

setTextAlign

public WebvttCssStyle setTextAlign(android.text.Layout.Alignment textAlign)

setFontSize

public WebvttCssStyle setFontSize(float fontSize)

setFontSizeUnit

public WebvttCssStyle setFontSizeUnit(short unit)

getFontSizeUnit

@WebvttCssStyle.FontSizeUnit
public int getFontSizeUnit()

getFontSize

public float getFontSize()

cascadeFrom

public void cascadeFrom(WebvttCssStyle style)