JWCaptionStyling

@interface JWCaptionStyling : NSObject

Configuration object used to customize the captions. Must be set to the JWConfig object used to create the JWPlayerController.

Styles specified using this structure will only be applied if the user’s accessibility settings allow it, and only for SRT and WebVTT captions. EIA-608 captions always default to the user’s accessibility settings.

Accessing Captions Styling Attributes

  • Overrides the default font color of the captions, including its opacity.

    Note

    Styles specified using this property will only be applied if the user’s accessibility settings allow it, and only for SRT and WebVTT captions. EIA-608 captions always default to the user’s accessibility settings.

    Declaration

    Objective-C

    @property (nonatomic, retain, readwrite, nullable) UIColor *color;
  • Changes the background color and the opacity of the overall window the captions reside in.

    Note

    Styles specified using this property will only be applied if the user’s accessibility settings allow it, and only for SRT and WebVTT captions. EIA-608 captions always default to the user’s accessibility settings.

    Declaration

    Objective-C

    @property (nonatomic, retain, readwrite, nullable) UIColor *windowColor;
  • Changes the highlight color and highlight opacity of the text.

    Note

    Styles specified using this property will only be applied if the user’s accessibility settings allow it, and only for SRT and WebVTT captions. EIA-608 captions always default to the user’s accessibility settings.

    Declaration

    Objective-C

    @property (nonatomic, retain, readwrite, nullable) UIColor *backgroundColor;
  • Overrides the default font style and font size.

    Note

    Styles specified using this property will only be applied if the user’s accessibility settings allow it, and only for SRT and WebVTT captions. EIA-608 captions always default to the user’s accessibility settings.

    Declaration

    Objective-C

    @property (nonatomic, retain, readwrite, nullable) UIFont *font;
  • The edge style is an option to put emphasis around text. The available options are: none, dropshadow, raised, depressed, and uniform.

    Note

    Styles specified using this property will only be applied if the user’s accessibility settings allow it, and only for SRT and WebVTT captions. EIA-608 captions always default to the user’s accessibility settings.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        JWEdgeStyle edgeStyle;