Interface Audio

Represents an audio control implementation

Hierarchy

Audio

Implemented by

Index

Properties

loop playbackRate volume

Methods

getPlaybackPosition getTotalPlaybackDuration isPaused isPlaying pause play seek stop

Properties

loop

loop: boolean

Whether the audio should loop (repeat forever)

playbackRate

playbackRate: number

Set the playbackRate, default is 1.0 at normal speed. For example 2.0 is double speed, and 0.5 is half speed.

volume

volume: number

The volume (between 0 and 1)

Methods

getPlaybackPosition

getPlaybackPosition(): number
Return the current playback time of the playing track in seconds from the start

Returns number
- Defined in Interfaces/Audio.ts:50

getTotalPlaybackDuration

getTotalPlaybackDuration(): number
Return the duration of the sound

Returns number
- Defined in Interfaces/Audio.ts:45

isPaused

isPaused(): boolean
Returns if the audio is paused

Returns boolean
- Defined in Interfaces/Audio.ts:29

isPlaying

isPlaying(): boolean
Whether or not any audio is playing

Returns boolean
- Defined in Interfaces/Audio.ts:24

pause

pause(): void
Pause the sound

Returns void
- Defined in Interfaces/Audio.ts:55

play

play(): Promise<any>
Will play the sound or resume if paused

Returns Promise<any>
- Defined in Interfaces/Audio.ts:34

seek

seek(position: number): void
Seek to a position (in seconds) in the audio
Parameters
- position: number
Returns void
- Defined in Interfaces/Audio.ts:40

stop

stop(): void
Stop playing the sound and reset

Returns void
- Defined in Interfaces/Audio.ts:60