bitmovin-player-ui
    Preparing search index...

    Interface TouchControlOverlayConfig

    Configuration interface for a Container.

    interface TouchControlOverlayConfig {
        acceptsTouchWithUiHidden?: boolean;
        ariaLabel?: LocalizableText;
        components?: Component<ComponentConfig>[];
        cssClass?: string;
        cssClasses?: string[];
        cssPrefix?: string;
        disabled?: boolean;
        enterFullscreenOnInitialPlayback?: boolean;
        hidden?: boolean;
        id?: string;
        role?: string;
        seekDoubleTapMargin?: number;
        seekDoubleTapTimeout?: number;
        seekTime?: number;
        tabIndex?: number;
        tag?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    acceptsTouchWithUiHidden? ariaLabel? components? cssClass? cssClasses? cssPrefix? disabled? enterFullscreenOnInitialPlayback? hidden? id? role? seekDoubleTapMargin? seekDoubleTapTimeout? seekTime? tabIndex? tag?

    Properties

    acceptsTouchWithUiHidden?: boolean

    Specifies whether the first touch event received by the UIContainer should be prevented or not.

    Default: true

    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

    enterFullscreenOnInitialPlayback?: boolean

    Specify whether the player should be set to enter fullscreen by clicking on the playback toggle button when initiating the initial playback. Default: false.

    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

    seekDoubleTapMargin?: number

    The second tap of a double tap has to be in a specific range of the first tap This specifies how many pixels off the second tap is allowed to be from the first tap in order to trigger the seek events

    Default: 15px

    seekDoubleTapTimeout?: number

    Time in milliseconds within which two consecutive taps are considered a double tap. Default: 200ms

    seekTime?: number

    Specifies how many seconds are seeked incase user seeks through double-tapping Default: 10sec

    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