Class AudioPlayer

constructor

• new AudioPlayer(debug?): AudioPlayer

• Constructs an instance of the AudioPlayer class.

  Parameters

  • debug: boolean = false

  Returns AudioPlayer

logger

onTrackEndCallback

selectedTrack

trackList

addMultipleTracksToTrackList

• addMultipleTracksToTrackList(tracks, options?): void

• Adds multiple tracks to the track list.

  Parameters

  • tracks: NewTrackDetails[]

    An array of track details to be added.

  • options: {
        selectTrack: boolean;
    } = ...

    Additional options for track addition.

    • selectTrack: boolean

      Set to true to select the first added track, false by default.

  Returns void

  Remarks

  This function adds multiple tracks to the track list and optionally selects one of them as the currently playing track.

addTrackToTrackList

• addTrackToTrackList(details, options?): AudioTrack

• Adds a new track to the track list.

  Parameters

  • details: NewTrackDetails

    Details of the new track.

  • options: {
        selectTrack: boolean;
    } = ...

    Additional options for track addition.

    • selectTrack: boolean

      Set to true to select the added track, false by default.

  Returns AudioTrack

  The newly created AudioTrack instance.

getNextTrack

• getNextTrack(): null | AudioTrack

• Retrieves the next track in the track list if available.

  Returns null | AudioTrack

  The next track or null if not available.

getPreviousTrack

• getPreviousTrack(): null | AudioTrack

• Retrieves the previous track in the track list if available.

  Returns null | AudioTrack

  The previous track or null if not available.

getSelectedTrack

• getSelectedTrack(): null | AudioTrack

• Retrieves the currently selected track.

  Returns null | AudioTrack

  The currently selected track.

getSelectedTrackDurationAsync

• getSelectedTrackDurationAsync(): Promise<number>

• Retrieves the duration of the currently selected track asynchronously.

  Returns Promise<number>

  A promise that resolves with the duration of the track (in seconds).

  Throws

  If no track is loaded.

getSelectedTrackPlaybackPosition

• getSelectedTrackPlaybackPosition(): null | number

• Retrieves the current playback position of the selected track.

  Returns null | number

  The current playback position in seconds or null if unavailable.

getSelectedTrackTimePlayed

• getSelectedTrackTimePlayed(): null | number

• Calculates the played time of the currently selected track.

  Returns null | number

  The played time in seconds, or null if no track is selected.

getSelectedTrackTimeRemaining

• getSelectedTrackTimeRemaining(): null | number

• Calculates the remaining time of the currently selected track.

  Returns null | number

  The remaining time in seconds, or null if no track is selected.

getTrackList

• getTrackList(): {
      artists: Artist[];
      artwork: Artwork;
      id: string;
      label: string;
      productUrl: string;
      title: string;
      url: string;
  }[]

• Retrieves a copy of the track list without the 'howl' property.

  Returns {
      artists: Artist[];
      artwork: Artwork;
      id: string;
      label: string;
      productUrl: string;
      title: string;
      url: string;
  }[]

  A copy of the track list.

getVolume

• getVolume(): number

• Retrieves the current volume level.

  Returns number

  The current volume level.

mute

• mute(shouldMute): void

• Mutes or unmutes the audio playback.

  Parameters

  • shouldMute: boolean

    Set to true to mute, false to unmute.

  Returns void

pauseSelectedTrack

• pauseSelectedTrack(): void

• Pauses the currently selected track at it's current playback position.

  Returns void

playSelectedTrack

• playSelectedTrack(): void

• Plays the currently selected track.

  Returns void

removeAllTracks

• removeAllTracks(): void

• Removes all tracks from the track list and stops playback.

  Returns void

seekToTimestampForSelectedTrack

• seekToTimestampForSelectedTrack(timestamp): null | number

• Seeks to a specified timestamp in the currently selected track.

  Parameters

  • timestamp: number

    The timestamp to seek to in seconds.

  Returns null | number

  The updated playback position or null if seeking failed.

selectAndPlayNextTrack

• selectAndPlayNextTrack(): void

• Plays the next track in the track list.

  Returns void

selectAndPlayPreviousTrack

• selectAndPlayPreviousTrack(): void

• Plays the previous track in the track list or restarts the current track if it's the first.

  Returns void

selectedTrackIsPlaying

• selectedTrackIsPlaying(): boolean

• Checks if any track is currently playing.

  Returns boolean

  true if a track is playing, otherwise false.

setOnTrackEndCallback

• setOnTrackEndCallback(callback): void

• Sets the callback function to be triggered when a track ends.

  Parameters

  • callback: (() => void)

    The callback function.

    • • (): void

      • Returns void

  Returns void

setVolume

• setVolume(volume): number

• Sets the volume level for audio playback.

  Parameters

  • volume: number

    The new volume level (between 0 and 1).

  Returns number

  The updated volume level.

stopAllTracks

• stopAllTracks(): void

• Stops playback of all tracks and resets their playback positions to 0.

  Returns void

stopSelectedTrack

• stopSelectedTrack(): void

• Stops the currently selected track and resets its playback position to 0s.

  Returns void