Class TimeRange

<theoplayer-time-range> - A seek bar, showing the current time of the player, and which seeks the player when clicked or dragged.

Slot

preview - A slot holding a preview of the seek time, shown while hovering the seek bar. By default, this shows the preview time and the preview thumbnail.

Hierarchy

Range<this> & StateReceiverElement<this>
- TimeRange

Constructors

constructor

new TimeRange(): TimeRange
Returns TimeRange
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).constructor
- Defined in components/TimeRange.ts:60

Properties

`Protected` `Readonly` _pointerEl

_pointerEl: HTMLElement

`Protected` `Readonly` _rangeEl

_rangeEl: HTMLInputElement

`Optional` activeVideoQuality

activeVideoQuality?: VideoQuality

deviceType

deviceType: "mobile" | "tv" | "desktop"

`Optional` error

error?: THEOplayerError

`Optional` fullscreen

fullscreen?: boolean

`Optional` playbackRate

playbackRate?: number

`Optional` previewTime

previewTime?: number

`Optional` targetVideoQualities

targetVideoQualities?: VideoQuality[]

`Readonly` theoplayerUiObservedProperties

theoplayerUiObservedProperties: (keyof StateReceiverPropertyMap)[]

The names of the properties this element will receive.

Accessors

disabled

get disabled(): boolean
Whether the range is disabled.

When disabled, the slider value cannot be changed, and the slider thumb is hidden.

Returns boolean
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).disabled
- Defined in components/Range.ts:83
set disabled(disabled): void
Parameters
- disabled: boolean
Returns void
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).disabled
- Defined in components/Range.ts:87

max

get max(): number
The maximum allowed value.

Returns number
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).max
- Defined in components/Range.ts:118
set max(max): void
Parameters
- max: number
Returns void
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).max
- Defined in components/Range.ts:122

min

get min(): number
The minimum allowed value.

Returns number
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).min
- Defined in components/Range.ts:106
set min(min): void
Parameters
- min: number
Returns void
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).min
- Defined in components/Range.ts:110

player

get player(): undefined | ChromelessPlayer
Returns undefined | ChromelessPlayer
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).player
- Defined in components/TimeRange.ts:83
set player(player): void
Parameters
- player: undefined | ChromelessPlayer
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).player
- Defined in components/TimeRange.ts:87

step

get step(): number | "any"
The granularity at which the value can change.

If set to "any", the value can change with arbitrary precision.

Returns number | "any"
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).step
- Defined in components/Range.ts:132
set step(step): void
Parameters
- step: number | "any"
Returns void
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).step
- Defined in components/Range.ts:137

streamType

get streamType(): StreamType
Returns StreamType
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).streamType
- Defined in components/TimeRange.ts:107
set streamType(streamType): void
Parameters
- streamType: StreamType
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).streamType
- Defined in components/TimeRange.ts:111

value

get value(): number
The current value.

Returns number
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).value
- Defined in components/Range.ts:94
set value(value): void
Parameters
- value: number
Returns void
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).value
- Defined in components/Range.ts:98

`Static` observedAttributes

get observedAttributes(): Attribute[]
Returns Attribute[]
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).observedAttributes
- Defined in components/TimeRange.ts:44

Methods

`Protected` _upgradeProperty

_upgradeProperty(prop): void
Parameters
- prop: keyof TimeRange
Returns void
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType'])._upgradeProperty
- Defined in components/Range.ts:57

attributeChangedCallback

attributeChangedCallback(attrName, oldValue, newValue): void
Parameters
- attrName: string
- oldValue: any
- newValue: any
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).attributeChangedCallback
- Defined in components/TimeRange.ts:166

connectedCallback

connectedCallback(): void
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).connectedCallback
- Defined in components/TimeRange.ts:73

disconnectedCallback

disconnectedCallback(): void
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).disconnectedCallback
- Defined in components/TimeRange.ts:78

`Protected` getAriaLabel

getAriaLabel(): string
Returns string
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).getAriaLabel
- Defined in components/TimeRange.ts:153

`Protected` getAriaValueText

getAriaValueText(): string
Returns string
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).getAriaValueText
- Defined in components/TimeRange.ts:157

`Protected` getBarColors

getBarColors(): ColorStops
Returns ColorStops
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).getBarColors
- Defined in components/TimeRange.ts:295

`Protected` getMinimumStepForVisibleChange_

getMinimumStepForVisibleChange_(): number
Returns number
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).getMinimumStepForVisibleChange_
- Defined in components/Range.ts:248

`Protected` handleInput

handleInput(): void
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).handleInput
- Defined in components/TimeRange.ts:181

`Protected` handleKeyDown_

handleKeyDown_(e): void
Parameters
- e: KeyboardEvent
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).handleKeyDown_
- Defined in components/TimeRange.ts:336

`Protected` update

update(useCachedWidth?): void
Parameters
- Optional useCachedWidth: boolean
Returns void
Inherited from StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).update
- Defined in components/Range.ts:175

`Protected` updatePointer_

updatePointer_(mousePercent, rangeRect): void
Parameters
- mousePercent: number
- rangeRect: DOMRectReadOnly
Returns void
Overrides StateReceiverMixin(Range, ['player', 'streamType', 'deviceType']).updatePointer_
- Defined in components/TimeRange.ts:269

Class TimeRange

Slot

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TimeRange

Properties

Protected Readonly _pointerEl

Protected Readonly _rangeEl

Optional activeVideoQuality

deviceType

Optional error

Optional fullscreen

Optional playbackRate

Optional previewTime

Optional targetVideoQualities

Readonly theoplayerUiObservedProperties

Accessors

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

max

Returns number

Parameters

max: number

Returns void

min

Returns number

Parameters

min: number

Returns void

player

Returns undefined | ChromelessPlayer

Parameters

player: undefined | ChromelessPlayer

Returns void

step

Returns number | "any"

Parameters

step: number | "any"

Returns void

streamType

Returns StreamType

Parameters

streamType: StreamType

Returns void

value

Returns number

Parameters

value: number

Returns void

Static observedAttributes

Returns Attribute[]

Methods

Protected _upgradeProperty

Parameters

prop: keyof TimeRange

Returns void

attributeChangedCallback

Parameters

attrName: string

oldValue: any

newValue: any

Returns void

connectedCallback

Returns void

disconnectedCallback

Returns void

Protected getAriaLabel

Returns string

Protected getAriaValueText

Returns string

Protected getBarColors

`Protected` `Readonly` _pointerEl

`Protected` `Readonly` _rangeEl

`Optional` activeVideoQuality

`Optional` error

`Optional` fullscreen

`Optional` playbackRate

`Optional` previewTime

`Optional` targetVideoQualities

`Readonly` theoplayerUiObservedProperties

`Static` observedAttributes

`Protected` _upgradeProperty

`Protected` getAriaLabel

`Protected` getAriaValueText

`Protected` getBarColors

`Protected` getMinimumStepForVisibleChange_

`Protected` handleInput

`Protected` handleKeyDown_

`Protected` update

`Optional` useCachedWidth: boolean

`Protected` updatePointer_