Play native audio from a Capacitor app.

• 🔈 Toggle between Speaker and Earpiece as audio output
• 🎶 Audio keeps playing in the background, when app is minimized
• 🔓 Native players in notifications and lock screens
• 📱 Support for Android, iOS, Web (only Speaker)

npm install @smartcompanion/native-audio-player
npx cap sync

In folder ./example a full usage example is available. This example is also used for manual testing.

Demo App	Native Audio Player

• setEarpiece()
• setSpeaker()
• start(...)
• stop()
• play()
• pause()
• select(...)
• next()
• previous()
• seekTo(...)
• getDuration()
• getPosition()
• addListener('update', ...)
• Interfaces

setEarpiece() => Promise<void>

Set the audio output to the earpiece.

setSpeaker() => Promise<void>

Set the audio output to the speaker.

start(options: StartOptions) => Promise<{ id: string; }>

Initialize the audio player with a list of audio items.

Returns: Promise<{ id: string; }>

stop() => Promise<void>

Stop the currently playing audio item and clear the playlist.

play() => Promise<void>

Play the currently selected audio item.

pause() => Promise<void>

Pause the currently playing audio item.

select(options: { id: string; }) => Promise<{ id: string; }>

Select an audio item from the playlist by its id.

Returns: Promise<{ id: string; }>

next() => Promise<{ id: string; }>

Skip to the next audio item in the playlist.

Returns: Promise<{ id: string; }>

previous() => Promise<{ id: string; }>

Skip to the previous audio item in the playlist.

Returns: Promise<{ id: string; }>

seekTo(options: { position: number; }) => Promise<void>

Seek to a specific position in the currently playing audio item.

getDuration() => Promise<{ value: number; }>

Get the duration of the current audio item in seconds.

Returns: Promise<{ value: number; }>

getPosition() => Promise<{ value: number; }>

Get the current position of the audio item in seconds.

Returns: Promise<{ value: number; }>

addListener(eventName: 'update', listener: (result: { state: 'playing' | 'paused' | 'skip' | 'completed'; id: string; }) => void) => Promise<PluginListenerHandle>

Add an event listener for the update event. The listener should accept an event object containing the current state and id of the audio item.

Returns: Promise<PluginListenerHandle>

Options for starting the audio player.

Represents an audio item in the playlist.