Interface TrackUtilsApi

interface TrackUtilsApi {
    convertTextTrack(
        source: Source,
        conversionOptions: TextTrackConversionOptions,
        loadOptions?: TextTrackLoadOptions,
    ): Observable<Track<TrackState, OmpEvent<any, any>>>;
    convertTextTrack(
        url: string,
        conversionOptions: TextTrackConversionOptions,
        loadOptions?: TextTrackLoadOptions,
    ): Observable<Track<TrackState, OmpEvent<any, any>>>;
    destroy(): void;
    downsampleTrack(
        id: string,
        options: DownsampleOptions,
    ): Observable<Track<TrackState, OmpEvent<any, any>>>;
    fetchTimedItems(id: string): Observable<void>;
    preloadTrack(id: string): Observable<Track<TrackState, OmpEvent<any, any>>>;
}

Hierarchy

Destroyable
- TrackUtilsApi

Index

Methods

convertTextTrack destroy downsampleTrack fetchTimedItems preloadTrack

Methods

convertTextTrack

convertTextTrack(
    source: Source,
    conversionOptions: TextTrackConversionOptions,
    loadOptions?: TextTrackLoadOptions,
): Observable<Track<TrackState, OmpEvent<any, any>>>
Converts a text track to a different subtitle format, optionally applying time slewing.

Accepts either a Source or a plain URL string pointing to the source subtitle file. The converted track is registered in the repository with a DERIVED_FROM relation pointing to the source track.
Parameters
- source: Source
  A Source or URL string of the subtitle file to convert.
- conversionOptions: TextTrackConversionOptions
  Target format and optional slew configuration.
- OptionalloadOptions: TextTrackLoadOptions
  Optional load-time overrides (track type, file format, etc.).
Returns Observable<Track<TrackState, OmpEvent<any, any>>>
An Observable that emits the newly created converted Track once complete.
- Defined in src/track/track-utils.ts:121
convertTextTrack(
    url: string,
    conversionOptions: TextTrackConversionOptions,
    loadOptions?: TextTrackLoadOptions,
): Observable<Track<TrackState, OmpEvent<any, any>>>
Parameters
- url: string
- conversionOptions: TextTrackConversionOptions
- OptionalloadOptions: TextTrackLoadOptions
Returns Observable<Track<TrackState, OmpEvent<any, any>>>
- Defined in src/track/track-utils.ts:122

destroy

destroy(): void
Returns void
Inherited from Destroyable.destroy
- Defined in src/common/capabilities.ts:23

downsampleTrack

downsampleTrack(
id: string,
options: DownsampleOptions,
): Observable<Track<TrackState, OmpEvent<any, any>>>
Downsamples a timed-items track and registers the result as a new derived track in the repository.

The downsampled track has a DERIVED_FROM relation pointing to the source track.
Parameters
- id: string
  The ID of the source TimedItemsTrack to downsample.
- options: DownsampleOptions
  Downsampling options (period and strategy).
Returns Observable<Track<TrackState, OmpEvent<any, any>>>
An Observable that emits the newly created downsampled Track once complete.
- Defined in src/track/track-utils.ts:96

fetchTimedItems

fetchTimedItems(id: string): Observable<void>
Fetches and populates timed items for the given track.

Concurrent calls for the same track ID are deduplicated — subsequent subscribers receive the result of the in-flight request rather than starting a new one.
Parameters
- id: string
  The ID of the track whose timed items should be fetched.
Returns Observable<void>
An Observable that completes once the timed items have been loaded.
- Defined in src/track/track-utils.ts:107

preloadTrack

preloadTrack(id: string): Observable<Track<TrackState, OmpEvent<any, any>>>
Preloads a track by resolving its segments into a self-contained, locally accessible form.

For HLS audio tracks, segments are fetched and merged into a single blob URL. For HLS text tracks, VTT segments are concatenated and exposed as a blob URL. The resulting track is registered in the repository with a DERIVED_FROM relation pointing to the original track.
Parameters
- id: string
  The ID of the track to preload.
Returns Observable<Track<TrackState, OmpEvent<any, any>>>
An Observable that emits the newly created derived Track once preloading is complete.
- Defined in src/track/track-utils.ts:85