Class AudioTrackLane

Hierarchy

VttTimelineLane<
    AudioTrackLaneConfig,
    AudioTrackLaneStyle,
    AudioVttCue,
    AudioVttFile,
>
- AudioTrackLane

Implements

AudioTrackLaneApi

Constructors

constructor

new AudioTrackLane(
config: TimelineLaneConfigDefaultsExcluded<AudioTrackLaneConfig>,
): AudioTrackLane
Parameters
- config: TimelineLaneConfigDefaultsExcluded<AudioTrackLaneConfig>
Returns AudioTrackLane
Overrides VttTimelineLane<AudioTrackLaneConfig, AudioTrackLaneStyle, AudioVttCue, AudioVttFile>.constructor
- Defined in project/src/timeline/audio-track/audio-track-lane.ts:75

Accessors

description

set description(value: string): void
Parameters
- value: string
Returns void
Inherited from VttTimelineLane.description
- Defined in project/src/timeline/timeline-lane.ts:536

id

get id(): string
Returns string
TimelineLane id
Inherited from VttTimelineLane.id
- Defined in project/src/timeline/timeline-lane.ts:394

mainLeftFlexGroup

get mainLeftFlexGroup(): KonvaFlexGroup
Internal
Returns KonvaFlexGroup
Inherited from VttTimelineLane.mainLeftFlexGroup
- Defined in project/src/timeline/timeline-lane.ts:398

mainRightFlexGroup

get mainRightFlexGroup(): KonvaFlexGroup
Internal
Returns KonvaFlexGroup
Inherited from VttTimelineLane.mainRightFlexGroup
- Defined in project/src/timeline/timeline-lane.ts:402

onPlayheadCueEvent$

get onPlayheadCueEvent$(): Observable<OmakaseVttCueEvent<Q>>
Fires on VTT cue entry/exit on playhead drag

Returns Observable<OmakaseVttCueEvent<Q>>
Implementation of AudioTrackLaneApi.onPlayheadCueEvent$
Inherited from VttTimelineLane.onPlayheadCueEvent$
- Defined in project/src/timeline/vtt-timeline-lane.ts:67

onScrubberCueEvent$

get onScrubberCueEvent$(): Observable<OmakaseVttCueEvent<Q>>
Fires on VTT cue entry/exit on scrubber move

Returns Observable<OmakaseVttCueEvent<Q>>
Implementation of AudioTrackLaneApi.onScrubberCueEvent$
Inherited from VttTimelineLane.onScrubberCueEvent$
- Defined in project/src/timeline/vtt-timeline-lane.ts:75

onVideoCueEvent$

get onVideoCueEvent$(): Observable<OmakaseVttCueEvent<Q>>
Fires on VTT cue entry/exit on video time change

Returns Observable<OmakaseVttCueEvent<Q>>
Implementation of AudioTrackLaneApi.onVideoCueEvent$
Inherited from VttTimelineLane.onVideoCueEvent$
- Defined in project/src/timeline/vtt-timeline-lane.ts:59

onVttFileLoaded$

get onVttFileLoaded$(): Observable<T>
Fires when VTT file is loaded

Returns Observable<T>
Implementation of AudioTrackLaneApi.onVttFileLoaded$
Inherited from VttTimelineLane.onVttFileLoaded$
- Defined in project/src/timeline/vtt-timeline-lane.ts:55

style

get style(): S
Style getter / setter

Returns S
Inherited from VttTimelineLane.style
- Defined in project/src/timeline/timeline-lane.ts:528
set style(value: Partial<S>): void
Style getter / setter
Parameters
- value: Partial<S>
Returns void
Inherited from VttTimelineLane.style
- Defined in project/src/timeline/timeline-lane.ts:532

vttFile

get vttFile(): undefined | T
VTT file content

Returns undefined | T
Implementation of AudioTrackLaneApi.vttFile
Inherited from VttTimelineLane.vttFile
- Defined in project/src/timeline/vtt-timeline-lane.ts:87
set vttFile(vttFile: undefined | T): void
VTT file content
Parameters
- vttFile: undefined | T
Returns void
Implementation of AudioTrackLaneApi.vttFile
Inherited from VttTimelineLane.vttFile
- Defined in project/src/timeline/vtt-timeline-lane.ts:95

vttUrl

get vttUrl(): undefined | string
URL pointing to the VTT file

Returns undefined | string
Implementation of AudioTrackLaneApi.vttUrl
Inherited from VttTimelineLane.vttUrl
- Defined in project/src/timeline/vtt-timeline-lane.ts:83
set vttUrl(vttUrl: undefined | string): void
URL pointing to the VTT file
Parameters
- vttUrl: undefined | string
Returns void
Implementation of AudioTrackLaneApi.vttUrl
Inherited from VttTimelineLane.vttUrl
- Defined in project/src/timeline/vtt-timeline-lane.ts:91

Methods

addTimelineNode

addTimelineNode(config: TimelineLaneComponentConfig): TimelineNode
Adds new timeline node to timeline lane
Parameters
- config: TimelineLaneComponentConfig
Returns TimelineNode
Inherited from VttTimelineLane.addTimelineNode
- Defined in project/src/timeline/timeline-lane.ts:406

clearContent

clearContent(): void
Returns void
Overrides VttTimelineLane.clearContent
- Defined in project/src/timeline/audio-track/audio-track-lane.ts:159

destroy

destroy(): void
Returns void
Overrides VttTimelineLane.destroy
- Defined in project/src/timeline/audio-track/audio-track-lane.ts:367

getTimecodedPointerPosition

getTimecodedPointerPosition(): undefined | Position
Internal
Returns undefined | Position
Inherited from VttTimelineLane.getTimecodedPointerPosition
- Defined in project/src/timeline/timeline-lane.ts:386

getTimecodedPointerPositionTime

getTimecodedPointerPositionTime(): number
Internal
Returns number
Inherited from VttTimelineLane.getTimecodedPointerPositionTime
- Defined in project/src/timeline/timeline-lane.ts:390

getTimecodedRect

getTimecodedRect(): RectMeasurement
Internal
Returns RectMeasurement
Inherited from VttTimelineLane.getTimecodedRect
- Defined in project/src/timeline/timeline-lane.ts:375

getVttLoadOptions

getVttLoadOptions(axiosConfig?: AxiosRequestConfig<any>): VttLoadOptions
Parameters
- OptionalaxiosConfig: AxiosRequestConfig<any>
Returns VttLoadOptions
Inherited from VttTimelineLane.getVttLoadOptions
- Defined in project/src/timeline/vtt-timeline-lane.ts:119

isMinimized

isMinimized(): boolean
Returns boolean
is timeline lane minimized
Inherited from VttTimelineLane.isMinimized
- Defined in project/src/timeline/timeline-lane.ts:425

loadVtt

loadVtt(
vttUrl: string,
options?: VttLoadOptions,
): Observable<undefined | AudioVttFile>
Loads data from VTT file
Parameters
- vttUrl: string
- options: VttLoadOptions = {}
Returns Observable<undefined | AudioVttFile>
Implementation of AudioTrackLaneApi.loadVtt
Inherited from VttTimelineLane.loadVtt
- Defined in project/src/timeline/vtt-timeline-lane.ts:99

maximize

maximize(): void
Maximize

Returns void
Inherited from VttTimelineLane.maximize
- Defined in project/src/timeline/timeline-lane.ts:450

maximizeEased

maximizeEased(): Observable<void>
Maximize with easing

Returns Observable<void>
Inherited from VttTimelineLane.maximizeEased
- Defined in project/src/timeline/timeline-lane.ts:483

maximizeInternal

maximizeInternal(refreshLayout?: boolean): void
Parameters
- refreshLayout: boolean = true
Returns void
Inherited from VttTimelineLane.maximizeInternal
- Defined in project/src/timeline/timeline-lane.ts:437

minimize

minimize(): void
Minimize

Returns void
Inherited from VttTimelineLane.minimize
- Defined in project/src/timeline/timeline-lane.ts:446

minimizeEased

minimizeEased(): Observable<void>
Minimize with easing

Returns Observable<void>
Inherited from VttTimelineLane.minimizeEased
- Defined in project/src/timeline/timeline-lane.ts:454

minimizeInternal

minimizeInternal(refreshLayout?: boolean): void
Parameters
- refreshLayout: boolean = true
Returns void
Inherited from VttTimelineLane.minimizeInternal
- Defined in project/src/timeline/timeline-lane.ts:429

onMeasurementsChange

onMeasurementsChange(): void
Returns void
Inherited from VttTimelineLane.onMeasurementsChange
- Defined in project/src/timeline/timeline-lane.ts:331

prepareForTimeline

prepareForTimeline(
timeline: Timeline,
videoController: VideoControllerApi,
): void
Parameters
- timeline: Timeline
- videoController: VideoControllerApi
Returns void
Overrides VttTimelineLane.prepareForTimeline
- Defined in project/src/timeline/audio-track/audio-track-lane.ts:81

toggleMinimizeMaximize

toggleMinimizeMaximize(): void
Toggles minimize / maximize

Returns void
Inherited from VttTimelineLane.toggleMinimizeMaximize
- Defined in project/src/timeline/timeline-lane.ts:512

toggleMinimizeMaximizeEased

toggleMinimizeMaximizeEased(): Observable<void>
Toggles minimize / maximize with easing

Returns Observable<void>
Inherited from VttTimelineLane.toggleMinimizeMaximizeEased
- Defined in project/src/timeline/timeline-lane.ts:520

updateLayoutDimensions

updateLayoutDimensions(refreshLayout?: boolean): void
Parameters
- refreshLayout: boolean = true
Returns void
Inherited from VttTimelineLane.updateLayoutDimensions
- Defined in project/src/timeline/timeline-lane.ts:360

Class AudioTrackLane

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AudioTrackLane

Accessors

description

Parameters

Returns void

id

Returns string

mainLeftFlexGroup

Returns KonvaFlexGroup

mainRightFlexGroup

Returns KonvaFlexGroup

onPlayheadCueEvent$

Returns Observable<OmakaseVttCueEvent<Q>>

onScrubberCueEvent$

Returns Observable<OmakaseVttCueEvent<Q>>

onVideoCueEvent$

Returns Observable<OmakaseVttCueEvent<Q>>

onVttFileLoaded$

Returns Observable<T>

style

Returns S

Parameters

Returns void

vttFile

Returns undefined | T

Parameters

Returns void

vttUrl

Returns undefined | string

Parameters

Returns void

Methods

addTimelineNode

Parameters

Returns TimelineNode

clearContent

Returns void

destroy

Returns void

getTimecodedPointerPosition

Returns undefined | Position

getTimecodedPointerPositionTime

Returns number

getTimecodedRect

Returns RectMeasurement

getVttLoadOptions

Parameters

Returns VttLoadOptions

isMinimized

Returns boolean

loadVtt

Parameters

Returns Observable<undefined | AudioVttFile>

maximize

Returns void

maximizeEased

Returns Observable<void>

maximizeInternal

Parameters

Returns void

minimize

Returns void

minimizeEased

Returns Observable<void>

minimizeInternal

Parameters

Returns void

onMeasurementsChange

Returns void

prepareForTimeline