Class MarkerLane

Hierarchy

VttTimelineLane<MarkerLaneConfig, MarkerLaneStyle, MarkerVttCue, MarkerVttFile>
- MarkerLane

Implements

MarkerLaneApi

Constructors

constructor

new MarkerLane(
config: TimelineLaneConfigDefaultsExcluded<MarkerLaneConfig>,
): MarkerLane
Parameters
- config: TimelineLaneConfigDefaultsExcluded<MarkerLaneConfig>
Returns MarkerLane
Overrides VttTimelineLane<MarkerLaneConfig, MarkerLaneStyle, MarkerVttCue, MarkerVttFile>.constructor
- Defined in project/src/timeline/marker/marker-lane.ts:76

Properties

`Readonly`onMarkerCreate$

onMarkerCreate$: Subject<MarkerCreateEvent> = ...

Fires on marker create

`Readonly`onMarkerDelete$

onMarkerDelete$: Subject<MarkerDeleteEvent> = ...

Fires on marker delete

`Readonly`onMarkerFocus$

onMarkerFocus$: Subject<MarkerFocusEvent> = ...

Fires on marker focus

`Readonly`onMarkerInit$

onMarkerInit$: Subject<MarkerInitEvent> = ...

Fires on loading the initial list of markers

`Readonly`onMarkerSelected$

onMarkerSelected$: Subject<MarkerSelectedEvent> = ...

Fires on marker selected

`Readonly`onMarkerUpdate$

onMarkerUpdate$: Subject<MarkerUpdateEvent> = ...

Fires on marker update

Accessors

description

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

id

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

mainLeftFlexGroup

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

mainRightFlexGroup

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

name

get name(): string
Track name

Returns string
Implementation of MarkerLaneApi.name
- Defined in project/src/timeline/marker/marker-lane.ts:167

onPlayheadCueEvent$

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

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

onScrubberCueEvent$

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

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

onVideoCueEvent$

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

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

onVttFileLoaded$

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

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

style

get style(): S
Style getter / setter

Returns S
Inherited from VttTimelineLane.style
- Defined in project/src/timeline/timeline-lane.ts:529
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:533

vttFile

get vttFile(): undefined | T
VTT file content

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

vttUrl

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

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

Methods

addMarker

addMarker(marker: Marker): Marker
Adds Marker to MarkerLane
Parameters
- marker: Marker
  Marker instance
Returns Marker
Implementation of MarkerLaneApi.addMarker
- Defined in project/src/timeline/marker/marker-lane.ts:179

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:407

clearContent

clearContent(): void
Returns void
Overrides VttTimelineLane.clearContent
- Defined in project/src/timeline/marker/marker-lane.ts:160

createMomentMarker

createMomentMarker(
config: ConfigWithOptionalStyle<MomentMarkerConfig>,
): MomentMarker
Creates new MomentMarker instance and adds it to MarkerLane
Parameters
- config: ConfigWithOptionalStyle<MomentMarkerConfig>
  MomentMarker configuration
Returns MomentMarker
Implementation of MarkerLaneApi.createMomentMarker
- Defined in project/src/timeline/marker/marker-lane.ts:171

createPeriodMarker

createPeriodMarker(
config: ConfigWithOptionalStyle<PeriodMarkerConfig>,
): PeriodMarker
Creates new PeriodMarker instance and adds it to MarkerLane
Parameters
- config: ConfigWithOptionalStyle<PeriodMarkerConfig>
  PeriodMarkern configuration
Returns PeriodMarker
Implementation of MarkerLaneApi.createPeriodMarker
- Defined in project/src/timeline/marker/marker-lane.ts:175

destroy

destroy(): void
Returns void
Overrides VttTimelineLane.destroy
- Defined in project/src/timeline/marker/marker-lane.ts:395

focusMarker

focusMarker(id: string): void
Focuses Marker by ID
Parameters
- id: string
  Marker ID
Returns void
Implementation of MarkerLaneApi.focusMarker
- Defined in project/src/timeline/marker/marker-lane.ts:266

getMarker

getMarker(id: string): undefined | Marker
Parameters
- id: string
  Marker ID
Returns undefined | Marker
Marker by ID
Implementation of MarkerLaneApi.getMarker
- Defined in project/src/timeline/marker/marker-lane.ts:250

getMarkerInFocus

getMarkerInFocus(): undefined | Marker
Returns undefined | Marker
Marker in focus
Implementation of MarkerLaneApi.getMarkerInFocus
- Defined in project/src/timeline/marker/marker-lane.ts:281

getMarkers

getMarkers(): Marker[]
Returns Marker[]
all Markers
Implementation of MarkerLaneApi.getMarkers
- Defined in project/src/timeline/marker/marker-lane.ts:258

getSelectedMarker

getSelectedMarker(): undefined | Marker
Get currently active marker

Returns undefined | Marker
Implementation of MarkerLaneApi.getSelectedMarker
- Defined in project/src/timeline/marker/marker-lane.ts:314

getTimecodedPointerPosition

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

getTimecodedPointerPositionTime

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

getTimecodedRect

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

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:89

isMinimized

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

loadVtt

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

maximize

maximize(): void
Maximize

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

maximizeEased

maximizeEased(): Observable<void>
Maximize with easing

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

maximizeInternal

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

minimize

minimize(): void
Minimize

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

minimizeEased

minimizeEased(): Observable<void>
Minimize with easing

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

minimizeInternal

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

onMeasurementsChange

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

prepareForTimeline

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

removeAllMarkers

removeAllMarkers(): void
Removes all Marker's

Returns void
Implementation of MarkerLaneApi.removeAllMarkers
- Defined in project/src/timeline/marker/marker-lane.ts:222

removeMarker

removeMarker(id: string): void
Removes Marker by ID
Parameters
- id: string
  Marker ID
Returns void
Implementation of MarkerLaneApi.removeMarker
- Defined in project/src/timeline/marker/marker-lane.ts:234

toggleMarker

toggleMarker(markerId: string): void
Set selected Marker as active
Parameters
- markerId: string
Returns void
Implementation of MarkerLaneApi.toggleMarker
- Defined in project/src/timeline/marker/marker-lane.ts:289

toggleMinimizeMaximize

toggleMinimizeMaximize(): void
Toggles minimize / maximize

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

toggleMinimizeMaximizeEased

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

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

updateLayoutDimensions

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

updateMarker

updateMarker(markerId: string, updateData: Partial<Marker>): void
Updates Marker by ID
Parameters
- markerId: string
- updateData: Partial<Marker>
Returns void
Implementation of MarkerLaneApi.updateMarker
- Defined in project/src/timeline/marker/marker-lane.ts:318

Class MarkerLane

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MarkerLane

Properties

ReadonlyonMarkerCreate$

ReadonlyonMarkerDelete$

ReadonlyonMarkerFocus$

ReadonlyonMarkerInit$

ReadonlyonMarkerSelected$

ReadonlyonMarkerUpdate$

Accessors

description

Parameters

Returns void

id

Returns string

mainLeftFlexGroup

Returns KonvaFlexGroup

mainRightFlexGroup

Returns KonvaFlexGroup

name

Returns string

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

addMarker

Parameters

Returns Marker

addTimelineNode

Parameters

Returns TimelineNode

clearContent

Returns void

createMomentMarker

Parameters

Returns MomentMarker

createPeriodMarker

Parameters

Returns PeriodMarker

destroy

Returns void

focusMarker

Parameters

Returns void

getMarker

Parameters

Returns undefined | Marker

getMarkerInFocus

Returns undefined | Marker

getMarkers

Returns Marker[]

getSelectedMarker

Returns undefined | Marker

`Readonly`onMarkerCreate$

`Readonly`onMarkerDelete$

`Readonly`onMarkerFocus$

`Readonly`onMarkerInit$

`Readonly`onMarkerSelected$

`Readonly`onMarkerUpdate$