bitmovin-player-ui
    Preparing search index...

    Interface SubtitleOverlayConfig

    Configuration interface for a Container.

    interface SubtitleOverlayConfig {
        ariaLabel?: LocalizableText;
        components?: Component<ComponentConfig>[];
        cssClass?: string;
        cssClasses?: string[];
        cssPrefix?: string;
        disabled?: boolean;
        enableCea608CaptionFormatting?: boolean;
        hidden?: boolean;
        id?: string;
        role?: string;
        tabIndex?: number;
        tag?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    ariaLabel? components? cssClass? cssClasses? cssPrefix? disabled? enableCea608CaptionFormatting? hidden? id? role? tabIndex? tag?

    Properties

    ariaLabel?: LocalizableText

    WCAG20 standard for defining info about the component (usually the name)

    components?: Component<ComponentConfig>[]

    Child components of the container.

    cssClass?: string

    The CSS classes of the component. This is usually the class from where the component takes its styling.

    cssClasses?: string[]

    Additional CSS classes of the component.

    cssPrefix?: string

    A prefix to prepend all CSS classes with.

    disabled?: boolean

    Specifies if the component is enabled (interactive) or not. Default: false

    enableCea608CaptionFormatting?: boolean

    Controls whether CEA-608 caption-specific text formatting (monospaced font, uppercase transform, and character letter-spacing) is applied. The CEA-608 grid-based row/column positioning is always preserved so captions still render at their authored on-screen positions.

    Defaults to true (CEA-608 text formatting is applied, matching historical behavior).

    hidden?: boolean

    Specifies if the component should be hidden at startup. Default: false

    id?: string

    The HTML ID of the component. Default: automatically generated with pattern 'ui-id-{guid}'.

    role?: string

    Specifies the component role for WCAG20 standard

    tabIndex?: number

    WCAG20 requirement for screen reader navigation

    tag?: string

    The HTML tag name of the component. Default: 'div'

    Settings

    Member Visibility

    On This Page

    Properties