Interface VolumeSliderConfig

Configuration interface for the VolumeSlider component.

interface VolumeSliderConfig {
    addCurrentTimeToAriaLabel?: boolean;
    ariaLabel?: LocalizableText;
    cssClass?: string;
    cssClasses?: string[];
    cssPrefix?: string;
    disabled?: boolean;
    enableSeekPreview?: boolean;
    hidden?: boolean;
    hideIfVolumeControlProhibited?: boolean;
    id?: string;
    keyStepIncrements?: {
        leftRight: number;
        upDown: number;
    };
    label?: SeekBarLabel;
    role?: string;
    smoothPlaybackPositionUpdateIntervalMs?: number;
    snappingEnabled?: boolean;
    snappingRange?: number;
    tabIndex?: number;
    tag?: string;
    vertical?: boolean;
}

Hierarchy (view full)

Properties

addCurrentTimeToAriaLabel? ariaLabel? cssClass? cssClasses? cssPrefix? disabled? enableSeekPreview? hidden? hideIfVolumeControlProhibited? id? keyStepIncrements? label? role? smoothPlaybackPositionUpdateIntervalMs? snappingEnabled? snappingRange? tabIndex? tag? vertical?

Properties

OptionaladdCurrentTimeToAriaLabel

addCurrentTimeToAriaLabel?: boolean

Used to add the current playback time into the aria-label attribute. This allows screen readers to read the current current time even on platforms that do not support the aria-valuetext attribute, such as Samsung Tizen.

OptionalariaLabel

ariaLabel?: LocalizableText

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

OptionalcssClass

cssClass?: string

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

OptionalcssClasses

cssClasses?: string[]

Additional CSS classes of the component.

OptionalcssPrefix

cssPrefix?: string

A prefix to prepend all CSS classes with.

Optionaldisabled

disabled?: boolean

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

OptionalenableSeekPreview

enableSeekPreview?: boolean

Used to enable/disable seek preview

Optionalhidden

hidden?: boolean

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

OptionalhideIfVolumeControlProhibited

hideIfVolumeControlProhibited?: boolean

Specifies if the volume slider should be automatically hidden when volume control is prohibited by the browser or platform. This currently only applies to iOS. Default: true

Optionalid

id?: string

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

OptionalkeyStepIncrements

keyStepIncrements?: {
    leftRight: number;
    upDown: number;
}

Used for seekBar control increments and decrements

Optionallabel

label?: SeekBarLabel

The label above the seek position.

Optionalrole

role?: string

Specifies the component role for WCAG20 standard

OptionalsmoothPlaybackPositionUpdateIntervalMs

smoothPlaybackPositionUpdateIntervalMs?: number

The interval in milliseconds in which the playback position on the seek bar will be updated. The shorter the interval, the smoother it looks and the more resource intense it is. The update interval will be kept as steady as possible to avoid jitter. Set to -1 to disable smooth updating and update it on player TimeChanged events instead. Default: 50 (50ms = 20fps).

OptionalsnappingEnabled

snappingEnabled?: boolean

Used to enable/disable snapping to markers on the seek bar when seeking near them. Default: true

OptionalsnappingRange

snappingRange?: number

Defines tolerance for snapping to markers, if snapping to seek bar markers is enabled.

OptionaltabIndex

tabIndex?: number

WCAG20 requirement for screen reader navigation

Optionaltag

tag?: string

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

Optionalvertical

vertical?: boolean

Bar will be vertical instead of horizontal if set to true.

Settings

Member Visibility

On This Page

Properties