player-core/com.bitmovin.player.api.media.subtitle/Cue

Cue

class Cue(val start: Double, val end: Double, val text: String?, val html: String?, val image: Bitmap?, val textAlignment: Layout.Alignment?, val line: Float, val lineType: Cue.LineType, val lineAnchor: Cue.AnchorType, val fractionalPosition: Float, val positionAnchor: Cue.AnchorType, val size: Float, val bitmapHeight: Float, val isWindowColorSet: Boolean, val windowColor: Int, val verticalType: Cue.VerticalType)

Represents a cue of a subtitle track.

Constructors

Cue

constructor(start: Double, end: Double, text: String?, html: String?)

constructor(start: Double, end: Double, image: Bitmap?)

constructor(start: Double, end: Double, text: String?, html: String?, image: Bitmap?, textAlignment: Layout.Alignment?, line: Float, lineType: Cue.LineType, lineAnchor: Cue.AnchorType, fractionalPosition: Float, positionAnchor: Cue.AnchorType, size: Float, bitmapHeight: Float, isWindowColorSet: Boolean, windowColor: Int, verticalType: Cue.VerticalType)

Types

AnchorType

enum AnchorType : Enum<Cue.AnchorType>

Represents the available anchor types for the cue.

Companion

object Companion

LineType

enum LineType : Enum<Cue.LineType>

Represents the available line types for the cue.

VerticalType

enum VerticalType : Enum<Cue.VerticalType>

Represents the vertical formatting for the cue.

Properties

bitmapHeight

val bitmapHeight: Float

The bitmap height as a fraction of the of the viewport size, or DIMEN_UNSET if the bitmap should be displayed at its natural height given the bitmap dimensions and the specified size.

end

val end: Double

The end time of the Cue in seconds.

fractionalPosition

val fractionalPosition: Float

The fractional position of the positionAnchor of the cue within the viewport in the orthogonal direction to line, or DIMEN_UNSET.

html

val html: String?

The cue text as HTML.

image

val image: Bitmap?

The cue image.

isWindowColorSet

val isWindowColorSet: Boolean

True iff the windowColor property is set.

line

val line: Float

The position of the line anchor of the cue box within the viewport in orthogonal direction to the writing direction, or DIMEN_UNSET. Interpretation depends on the value of lineType.

lineAnchor

val lineAnchor: Cue.AnchorType

The cues anchor positioned by line. One of AnchorType.AnchorTypeStart, AnchorType.AnchorTypeMiddle, AnchorType.AnchorTypeEnd and AnchorType.TypeUnset.