Cue.Builder

Kotlin |Java

@UnstableApi
public final class Cue.Builder

A builder for Cue objects.

Summary

Public fields
`@Nullable Bitmap`	`bitmap`
`float`	`bitmapHeight`
`float`	`line`
`int`	`@Cue.AnchorType lineAnchor`
`int`	`@Cue.LineType lineType`
`float`	`position`
`int`	`@Cue.AnchorType positionAnchor`
`float`	`size`
`@Nullable CharSequence`	`text`
`@Nullable Layout.Alignment`	`textAlignment`
`float`	`textSize`
`int`	`@Cue.TextSizeType textSizeType`
`int`	`@Cue.VerticalType verticalType`
`@ColorInt int`	`windowColor`
`int`	`zIndex`

Public constructors
`Builder()`

Public methods
`Cue`	`build()` Build the cue.
`Cue.Builder`	`@CanIgnoreReturnValue clearWindowColor()` Sets `windowColorSet` to false.
`@Nullable Bitmap`	`@Pure getBitmap()` Gets the cue image.
`float`	`@Pure getBitmapHeight()` Gets the bitmap height as a fraction of the viewport size.
`float`	`@Pure getLine()` Gets the position of the `lineAnchor` of the cue box within the viewport in the direction orthogonal to the writing direction.
`int`	`@Pure @Cue.AnchorType getLineAnchor()` Gets the cue box anchor positioned by `line`.
`int`	`@Pure @Cue.LineType getLineType()` Gets the type of the value of `getLine`.
`float`	`@Pure getPosition()` Gets the fractional position of the `positionAnchor` of the cue box within the viewport in the direction orthogonal to `line`.
`int`	`@Pure @Cue.AnchorType getPositionAnchor()` Gets the cue box anchor positioned by `position`.
`float`	`@Pure getSize()` Gets the size of the cue box in the writing direction specified as a fraction of the viewport size in that direction.
`@Nullable CharSequence`	`@Pure getText()` Gets the cue text.
`@Nullable Layout.Alignment`	`@Pure getTextAlignment()` Gets the alignment of the cue text within the cue box, or null if the alignment is undefined.
`float`	`@Pure getTextSize()` Gets the default text size for this cue's text.
`int`	`@Pure @Cue.TextSizeType getTextSizeType()` Gets the default text size type for this cue's text.
`int`	`@Pure @Cue.VerticalType getVerticalType()` Gets the vertical formatting for this Cue.
`@ColorInt int`	`@Pure getWindowColor()` Gets the fill color of the window.
`int`	`@Pure getZIndex()` Gets the zIndex for this Cue.
`boolean`	`isWindowColorSet()` Returns true if the fill color of the window is set.
`Cue.Builder`	`@CanIgnoreReturnValue setBitmap(Bitmap bitmap)` Sets the cue image.
`Cue.Builder`	`@CanIgnoreReturnValue setBitmapHeight(float bitmapHeight)` Sets the bitmap height as a fraction of the viewport size.
`Cue.Builder`	`@CanIgnoreReturnValue setLine(float line, @Cue.LineType int lineType)` Sets the position of the cue box within the viewport in the direction orthogonal to the writing direction.
`Cue.Builder`	`@CanIgnoreReturnValue setLineAnchor(@Cue.AnchorType int lineAnchor)` Sets the cue box anchor positioned by `line`.
`Cue.Builder`	`@CanIgnoreReturnValue setMultiRowAlignment(@Nullable Layout.Alignment multiRowAlignment)` Sets the multi-row alignment of the cue.
`Cue.Builder`	`@CanIgnoreReturnValue setPosition(float position)` Sets the fractional position of the `positionAnchor` of the cue box within the viewport in the direction orthogonal to `line`.
`Cue.Builder`	`@CanIgnoreReturnValue setPositionAnchor(@Cue.AnchorType int positionAnchor)` Sets the cue box anchor positioned by `position`.
`Cue.Builder`	`@CanIgnoreReturnValue setShearDegrees(float shearDegrees)` Sets the shear angle for this Cue.
`Cue.Builder`	`@CanIgnoreReturnValue setSize(float size)` Sets the size of the cue box in the writing direction specified as a fraction of the viewport size in that direction.
`Cue.Builder`	`@CanIgnoreReturnValue setText(CharSequence text)` Sets the cue text.
`Cue.Builder`	`@CanIgnoreReturnValue setTextAlignment(@Nullable Layout.Alignment textAlignment)` Sets the alignment of the cue text within the cue box.
`Cue.Builder`	`@CanIgnoreReturnValue setTextSize(float textSize, @Cue.TextSizeType int textSizeType)` Sets the default text size and type for this cue's text.
`Cue.Builder`	`@CanIgnoreReturnValue setVerticalType(@Cue.VerticalType int verticalType)` Sets the vertical formatting for this Cue.
`Cue.Builder`	`@CanIgnoreReturnValue setWindowColor(@ColorInt int windowColor)` Sets the fill color of the window.
`Cue.Builder`	`@CanIgnoreReturnValue setZIndex(int zIndex)` Sets the zIndex for this Cue.

Public fields

bitmap

public @Nullable Bitmap bitmap

bitmapHeight

public float bitmapHeight

line

public float line

lineAnchor

@Cue.AnchorType
public int lineAnchor

lineType

@Cue.LineType
public int lineType

position

public float position

positionAnchor

@Cue.AnchorType
public int positionAnchor

size

public float size

text

public @Nullable CharSequence text

textAlignment

public @Nullable Layout.Alignment textAlignment

textSizeType

@Cue.TextSizeType
public int textSizeType

verticalType

@Cue.VerticalType
public int verticalType

windowColor

public @ColorInt int windowColor

zIndex

public int zIndex

Public constructors

Builder

public Builder()

Public methods

build

public Cue build()

Build the cue.

clearWindowColor

@CanIgnoreReturnValue
public Cue.Builder clearWindowColor()

Sets windowColorSet to false.

getBitmap

@Pure
public @Nullable Bitmap getBitmap()

Gets the cue image.

See also
`bitmap`

getBitmapHeight

@Pure
public float getBitmapHeight()

Gets the bitmap height as a fraction of the viewport size.

See also
`bitmapHeight`

getLine

@Pure
public float getLine()

Gets the position of the lineAnchor of the cue box within the viewport in the direction orthogonal to the writing direction.

See also
`line`

getLineAnchor

@Pure
@Cue.AnchorType
public int getLineAnchor()

Gets the cue box anchor positioned by line.

See also
`lineAnchor`

getLineType

@Pure
@Cue.LineType
public int getLineType()

Gets the type of the value of getLine.

See also
`lineType`

getPosition

@Pure
public float getPosition()

Gets the fractional position of the positionAnchor of the cue box within the viewport in the direction orthogonal to line.

See also
`position`

getPositionAnchor

@Pure
@Cue.AnchorType
public int getPositionAnchor()

Gets the cue box anchor positioned by position.

See also
`positionAnchor`

getSize

@Pure
public float getSize()

Gets the size of the cue box in the writing direction specified as a fraction of the viewport size in that direction.

See also
`size`

getText

@Pure
public @Nullable CharSequence getText()

Gets the cue text.

See also
`text`

getTextAlignment

@Pure
public @Nullable Layout.Alignment getTextAlignment()

Gets the alignment of the cue text within the cue box, or null if the alignment is undefined.

See also
`textAlignment`

getTextSize

@Pure
public float getTextSize()

Gets the default text size for this cue's text.

See also
`textSize`

getTextSizeType

@Pure
@Cue.TextSizeType
public int getTextSizeType()

Gets the default text size type for this cue's text.

See also
`textSizeType`

getVerticalType

@Pure
@Cue.VerticalType
public int getVerticalType()

Gets the vertical formatting for this Cue.

See also
`verticalType`

getWindowColor

@Pure
public @ColorInt int getWindowColor()

Gets the fill color of the window.

See also
`windowColor`

getZIndex

@Pure
public int getZIndex()

Gets the zIndex for this Cue.

isWindowColorSet

public boolean isWindowColorSet()

Returns true if the fill color of the window is set.

See also
`windowColorSet`

setBitmap

@CanIgnoreReturnValue
public Cue.Builder setBitmap(Bitmap bitmap)

Sets the cue image.

Note that this will also set the text to null.

See also
`bitmap`

setBitmapHeight

@CanIgnoreReturnValue
public Cue.Builder setBitmapHeight(float bitmapHeight)

Sets the bitmap height as a fraction of the viewport size.

See also
`bitmapHeight`

setLine

@CanIgnoreReturnValue
public Cue.Builder setLine(float line, @Cue.LineType int lineType)

Sets the position of the cue box within the viewport in the direction orthogonal to the writing direction.

See also
`line`
`lineType`

setLineAnchor

@CanIgnoreReturnValue
public Cue.Builder setLineAnchor(@Cue.AnchorType int lineAnchor)

Sets the cue box anchor positioned by line.

See also
`lineAnchor`

setMultiRowAlignment

@CanIgnoreReturnValue
public Cue.Builder setMultiRowAlignment(@Nullable Layout.Alignment multiRowAlignment)

Sets the multi-row alignment of the cue.

Passing null means the alignment is undefined.

See also
`multiRowAlignment`

setPosition

@CanIgnoreReturnValue
public Cue.Builder setPosition(float position)

Sets the fractional position of the positionAnchor of the cue box within the viewport in the direction orthogonal to line.

See also
`position`

setPositionAnchor

@CanIgnoreReturnValue
public Cue.Builder setPositionAnchor(@Cue.AnchorType int positionAnchor)

Sets the cue box anchor positioned by position.

See also
`positionAnchor`

setShearDegrees

@CanIgnoreReturnValue
public Cue.Builder setShearDegrees(float shearDegrees)

Sets the shear angle for this Cue.

setSize

@CanIgnoreReturnValue
public Cue.Builder setSize(float size)

Sets the size of the cue box in the writing direction specified as a fraction of the viewport size in that direction.

See also
`size`

setText

@CanIgnoreReturnValue
public Cue.Builder setText(CharSequence text)

Sets the cue text.

Note that text may be decorated with styling spans.

Note that this will also set the bitmap to null.

See also
`text`

setTextAlignment

@CanIgnoreReturnValue
public Cue.Builder setTextAlignment(@Nullable Layout.Alignment textAlignment)

Sets the alignment of the cue text within the cue box.

Passing null means the alignment is undefined.

See also
`textAlignment`

setTextSize

@CanIgnoreReturnValue
public Cue.Builder setTextSize(float textSize, @Cue.TextSizeType int textSizeType)

Sets the default text size and type for this cue's text.

See also
`textSize`
`textSizeType`

setVerticalType

@CanIgnoreReturnValue
public Cue.Builder setVerticalType(@Cue.VerticalType int verticalType)

Sets the vertical formatting for this Cue.

See also
`verticalType`

setWindowColor

@CanIgnoreReturnValue
public Cue.Builder setWindowColor(@ColorInt int windowColor)

Sets the fill color of the window.

Also sets windowColorSet to true.

See also
`windowColor`
`windowColorSet`

setZIndex

@CanIgnoreReturnValue
public Cue.Builder setZIndex(int zIndex)

Sets the zIndex for this Cue.