Interface OmakaseTrackApi

utils

add

• add(track: Track): Track

  Registers a pre-constructed track instance.

  Parameters

  • track: Track

    The track to add.

  Returns Track

  The added track.

delete

• delete(id: string): boolean

  Removes the track with the given ID.

  Parameters

  • id: string

    The unique identifier of the track to remove.

  Returns boolean

  true if the track was found and removed, false otherwise.

find

• find(
      predicate?: (
          value: Track,
          index: number,
          array: Track<TrackState, OmpEvent<any, any>>[],
      ) => unknown,
  ): Track<TrackState, OmpEvent<any, any>>[]

  Returns all tracks that satisfy the predicate, or all tracks if no predicate is provided.

  Parameters

  • Optionalpredicate: (
        value: Track,
        index: number,
        array: Track<TrackState, OmpEvent<any, any>>[],
    ) => unknown

    Optional filter function applied to each track.

  Returns Track<TrackState, OmpEvent<any, any>>[]

findFirst

• findFirst(
      predicate?: (
          value: Track,
          index: number,
          array: Track<TrackState, OmpEvent<any, any>>[],
      ) => unknown,
  ): Track<TrackState, OmpEvent<any, any>> | undefined

  Parameters

  • Optionalpredicate: (
        value: Track,
        index: number,
        array: Track<TrackState, OmpEvent<any, any>>[],
    ) => unknown

  Returns Track<TrackState, OmpEvent<any, any>> | undefined

get

• get(id: string): Track<TrackState, OmpEvent<any, any>> | undefined

  Returns the track with the given ID, or undefined if not found.

  Parameters

  • id: string

    The unique identifier of the track.

  Returns Track<TrackState, OmpEvent<any, any>> | undefined

load

• load(
      source: Source,
      loadOptions?: TrackLoadOptions,
  ): Observable<Track<TrackState, OmpEvent<any, any>>>

  Loads a track from a Source object or a URL string.

  Parameters

  • source: Source

    A Source descriptor or a URL string pointing to the track resource.

  • OptionalloadOptions: TrackLoadOptions

    Optional type-specific load options (e.g. marker or thumbnail track options).

  Returns Observable<Track<TrackState, OmpEvent<any, any>>>

  An Observable that emits the loaded Track.

• load(
      url: string,
      loadOptions?: TrackLoadOptions,
  ): Observable<Track<TrackState, OmpEvent<any, any>>>

  Parameters

  • url: string
  • OptionalloadOptions: TrackLoadOptions

  Returns Observable<Track<TrackState, OmpEvent<any, any>>>