# Index

A B C D E F G H I L R S T W
All Classes and Interfaces|All Packages|Constant Field Values

## A

addCustomFont(String, Typeface) - Static method in class com.castlabs.subtitles.presentation.SubtitleFonts
  Register the "normal" variant of a custom font.

## B

backgroundColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The text background color as ARGB.
backgroundColor(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the background color as ARGB.
backgroundColorRGB(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the background color as RGB.
backgroundOpacity(float) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the opacity of the background color.
bottomMargin - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The margin in pixels applied to the subtitles located below the horizontal middle of the video view
bottomMargin(int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the bottom margin in pixels, default is zero Note: not supported by com.castlabs.android.player.ExoSubtitlesRendererPlugin

## C

com.castlabs.subtitles.presentation - package com.castlabs.subtitles.presentation
create(Context, boolean) - Static method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Create a new instance of this builder.
create(SubtitlesStyle) - Static method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Create a new instance of this builder based on the provided subtitle style.
CREATOR - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle

## D

DEFAULT_BACKGROUND_COLOR - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default background color
DEFAULT_BOTTOM_MARGIN - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default bottom margin in pixels
DEFAULT_DISPLAY_ALIGN - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying vertical default alignment
DEFAULT_DRAW_BEYOND_VIDEO_AREA - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default draw beyond video area flag
DEFAULT_EDGE_BLUR_RADIUS - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default edge blur radius in pixels
DEFAULT_EDGE_COLOR - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default edge color
DEFAULT_EDGE_THICKNESS - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default edge thickness in pixels
DEFAULT_EDGE_TYPE - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default edge type
DEFAULT_FONT_SCALE - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default font scale
DEFAULT_FOREGROUND_COLOR - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default foreground color
DEFAULT_IMAGE_SCALING_MODE - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Default value for image scaling mode
DEFAULT_LEFT_MARGIN - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default left margin in pixels
DEFAULT_REGION_COLOR - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default region color
DEFAULT_RIGHT_MARGIN - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default right margin in pixels
DEFAULT_TEXT_ALIGN - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying horizontal default alignment
DEFAULT_TOP_MARGIN - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default top margin in pixels
DEFAULT_TYPEFACE - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default typeface.
DEFAULT_WINDOW_COLOR - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The default window color
describeContents() - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle
disableAutoFlowText - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  If set to true the auto-flow text behaviour will be disabled regardless of the font-size and the font-scale.
disableAutoFlowText(boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  If set to true the auto-flow text behaviour will be disabled regardless of the font-size and the font-scale.
DISPLAY_ALIGN_AFTER - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying vertical alignment to the bottom
DISPLAY_ALIGN_BEFORE - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying vertical alignment to the top
DISPLAY_ALIGN_CENTER - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying vertical alignment to the center
displayAlign - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The display alignment
displayAlign(int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the display alignment.
drawBeyondVideoArea - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Enable drawing beyond the video area therefore in case of video area and canvas area (video container) aspect mismatch, the text will go beyond the video area
drawBeyondVideoArea(boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Enable or disable the drawing beyond video area, default is `false` Note: not supported by com.castlabs.android.player.ExoSubtitlesRendererPlugin

## E

EDGE_TYPE_DEPRESSED - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Edge type value specifying depressed bevel character edges.
EDGE_TYPE_DROP_SHADOW - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Edge type value specifying drop-shadowed character edges.
EDGE_TYPE_NONE - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Edge type value specifying no character edges.
EDGE_TYPE_OUTLINE - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Edge type value specifying uniformly outlined character edges.
EDGE_TYPE_RAISED - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Edge type value specifying raised bevel character edges.
edgeBlurRadius - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The edge blur radius in pixels.
edgeBlurRadius(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the edge blur radius in pixels.
edgeColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The edge color as ARGB.
edgeColor(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the edge color as ARGB.
edgeColorRGB(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the edge color as RGB.
edgeThickness - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The edge thickness in pixels.
edgeThickness(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the edge thickness in pixels.
edgeType - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The Edge Type as one of `SubtitlesStyle.EDGE_TYPE_NONE`, `SubtitlesStyle.EDGE_TYPE_OUTLINE`, `SubtitlesStyle.EDGE_TYPE_DROP_SHADOW`, `SubtitlesStyle.EDGE_TYPE_RAISED`, or `SubtitlesStyle.EDGE_TYPE_DEPRESSED`
edgeType(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the edge type to one of `SubtitlesStyle.EDGE_TYPE_NONE`, `SubtitlesStyle.EDGE_TYPE_OUTLINE`, `SubtitlesStyle.EDGE_TYPE_DROP_SHADOW`, `SubtitlesStyle.EDGE_TYPE_RAISED`, or `SubtitlesStyle.EDGE_TYPE_DEPRESSED`.
equals(Object) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle

## F

FONT_CASUAL - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
FONT_CURSIVE - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
FONT_DEFAULT - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
FONT_SANS_SERIF - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
FONT_SANS_SERIF_MONOSPACE - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
FONT_SERIF - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
FONT_SERIF_MONOSPACE - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
FONT_SMALL_CAPITALS - Static variable in class com.castlabs.subtitles.presentation.SubtitleFonts
fontScale - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The font size scaling factor
fontScale(float) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the font scale.
fontSize - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The font size in pixels.
fontSize(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the font size in pixels
foregroundColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The text foreground color as ARGB.
foregroundColor(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the foreground color as ARGB.
foregroundColorRGB(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the foreground color as RGB
foregroundOpacity(float) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the opacity of the foreground color.

## G

get() - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Create and return the new style from this builder.
get(int, Context) - Static method in class com.castlabs.subtitles.presentation.SubtitleFonts
  Get the typeface for the given type.
get(String, Context) - Static method in class com.castlabs.subtitles.presentation.SubtitleFonts
  Returns a Typeface that matches the given font family name.
getVariant(Typeface, int) - Static method in class com.castlabs.subtitles.presentation.SubtitleFonts
  Returns a typeface object that best matches the specified existing typeface and the specified Style.

## H

hasBackgroundColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.backgroundColor` was customized by the user and the setting should overwrite any content styles.
hasEdgeBlurRadius - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.edgeBlurRadius` was customized by the user and the setting should overwrite any content styles.
hasEdgeColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.edgeColor` was customized by the user and the setting should overwrite any content styles.
hasEdgeThickness - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.edgeThickness` was customized by the user and the setting should overwrite any content styles.
hasEdgeType - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.edgeType` was customized by the user and the setting should overwrite any content styles.
hasFontSize - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.fontSize` was customized by the user and the setting should overwrite any content styles.
hasForegroundColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.foregroundColor` was customized by the user and the setting should overwrite any content styles.
hashCode() - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle
hasRegionAutoSizedToFit - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.regionAutoSizedToFit` was customized by the user and the setting should overwrite any content styles.
hasRegionColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.regionColor` was customized by the user and the setting should overwrite any content styles.
hasTypeface - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.typeface` was customized by the user and the setting should overwrite any content styles.
hasWindowColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  True if the `SubtitlesStyle.windowColor` was customized by the user and the setting should overwrite any content styles.

## I

IMAGE_SCALE_FILL - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Image scale mode specifying image will fill the container without taking aspect ratio into consideration.
IMAGE_SCALE_FIT - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Image scale mode specifying image will be scaled as big as possible inside the container but keeping aspect ratio.
IMAGE_SCALE_WIDTH_BOTTOM - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Image scale mode specifying image will be scaled to fill width of container and its height will be scaled keeping the aspect ratio, even if it results higher than the container.
IMAGE_SCALE_WIDTH_TOP - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Image scale mode specifying image will be scaled to fill width of container and its height will be scaled keeping the aspect ratio, even if it results higher than the container.
imageScalingMode - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The image scaling mode for pre rendered subtitle images as one of `SubtitlesStyle.IMAGE_SCALE_FILL`, `SubtitlesStyle.IMAGE_SCALE_WIDTH_BOTTOM`, `SubtitlesStyle.IMAGE_SCALE_WIDTH_TOP` or `SubtitlesStyle.IMAGE_SCALE_FIT`
imageScalingMode(int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the Image scaling mode for pre rendered subtitle images

## L

leftMargin - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The margin in pixels applied to the subtitles located to the left of the vertical middle of the video view
leftMargin(int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the left margin in pixels, default is zero Note: not supported by com.castlabs.android.player.ExoSubtitlesRendererPlugin

## R

regionAutoSizedToFit - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Whether the region will be automatically sized to fit
regionAutoSizedToFit(boolean, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the auto-sized to fit region.
regionColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The region color as ARGB.
regionColor(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the region color as ARGB.
regionOpacity(float) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the opacity of the region color.
rightMargin - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The margin in pixels applied to the subtitles located to the right of the vertical middle of the video view
rightMargin(int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the right margin in pixels, default is zero Note: not supported by com.castlabs.android.player.ExoSubtitlesRendererPlugin

## S

set(int, Typeface) - Static method in class com.castlabs.subtitles.presentation.SubtitleFonts
  Set the typeface for a given type
setVariant(Context, int, Typeface, int) - Static method in class com.castlabs.subtitles.presentation.SubtitleFonts
  Register a typeface variant for the given source typeface.
setVariant(Typeface, Typeface, int) - Static method in class com.castlabs.subtitles.presentation.SubtitleFonts
  Register a typeface variant for the given source typeface.
SubtitleFonts - Class in com.castlabs.subtitles.presentation
  This class contains static helpers and functions to manage additional fonts for subtitles and closed captions.
SubtitleFonts.SubtitleFont - Annotation Type in com.castlabs.subtitles.presentation
SubtitlesStyle - Class in com.castlabs.subtitles.presentation
  This is the model class that contains all the styling information used by the subtitles plugins to render subtitles and closed captions.
SubtitlesStyle(Parcel) - Constructor for class com.castlabs.subtitles.presentation.SubtitlesStyle
SubtitlesStyle.Builder - Class in com.castlabs.subtitles.presentation
SubtitlesStyle.DisplayAlign - Annotation Type in com.castlabs.subtitles.presentation
SubtitlesStyle.EdgeType - Annotation Type in com.castlabs.subtitles.presentation
SubtitlesStyle.ImageScalingMode - Annotation Type in com.castlabs.subtitles.presentation
SubtitlesStyle.TextAlign - Annotation Type in com.castlabs.subtitles.presentation

## T

TEXT_ALIGN_CENTER - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying horizontal alignment to the center
TEXT_ALIGN_END - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying horizontal alignment to the end
TEXT_ALIGN_LEFT - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying horizontal alignment to the left
TEXT_ALIGN_RIGHT - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying horizontal alignment to the right
TEXT_ALIGN_START - Static variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  Text align value specifying horizontal alignment to the start
textAlign - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The text alignment
textAlign(int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the text alignment.
topMargin - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The margin in pixels applied to the subtitles located above the horizontal middle of the video view
topMargin(int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the top margin in pixels, default is zero Note: not supported by com.castlabs.android.player.ExoSubtitlesRendererPlugin
typeface - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
typeface(Typeface) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the typeface.

## W

windowColor - Variable in class com.castlabs.subtitles.presentation.SubtitlesStyle
  The window color as ARGB.
windowColor(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the window color as ARGB.
windowColorRGB(int, boolean) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the window color as RGB.
windowOpacity(float) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle.Builder
  Set the opacity of the window color.
writeToParcel(Parcel, int) - Method in class com.castlabs.subtitles.presentation.SubtitlesStyle

A B C D E F G H I L R S T W
All Classes and Interfaces|All Packages|Constant Field Values