NativePHP Audio Player Plugin#

A NativePHP plugin for audio playback on mobile devices.

Features#

Play/Pause/Resume - Full control over audio playback
Stop - Stop and reset playback position
Seek - Jump to any position in the audio
Volume Control - Set volume programmatically
Duration/Position - Get audio duration and current position

🚀 Future Roadmap#

I'm actively working on the following features and will update the package soon:

MediaSession Support - Send track metadata (artist, title, album, artwork) to Bluetooth devices, lock screens, and OS media centers.
Remote Controls - Handle playback commands (play, pause, next, previous) from connected devices and headphone buttons.
Audio Focus - Automatic pausing/ducking when other apps play audio or during incoming calls.
Background Playback - Enhanced support for playing audio when the app is in the background or the screen is off.

Installation#

Copied!

# Install the package
composer require theunwindfront/nativephp-audio
 
# Publish the plugins provider (first time only)
php artisan vendor:publish --tag=nativephp-plugins-provider
 
# Register the plugin
php artisan native:plugin:register theunwindfront/nativephp-audio
 
# Verify registration
php artisan native:plugin:list

# Install the package
composer require theunwindfront/nativephp-audio

# Publish the plugins provider (first time only)
php artisan vendor:publish --tag=nativephp-plugins-provider

# Register the plugin
php artisan native:plugin:register theunwindfront/nativephp-audio

# Verify registration
php artisan native:plugin:list

Usage#

PHP (Livewire/Blade)#

Copied!

use Theunwindfront\Audio\Facades\Audio;
 
// Play an audio file (using a sample open-source link for testing)
Audio::play('https://www.w3schools.com/html/horse.mp3');
 
// Pause
Audio::pause();
 
// Resume
Audio::resume();
 
// Seek to 30 seconds
Audio::seek(30.0);
 
// Set volume (0.0 to 1.0)
Audio::setVolume(0.8);
 
// Get info
$duration = Audio::getDuration();
$position = Audio::getCurrentPosition();

use Theunwindfront\Audio\Facades\Audio;

// Play an audio file (using a sample open-source link for testing)
Audio::play('https://www.w3schools.com/html/horse.mp3');

// Pause
Audio::pause();

// Resume
Audio::resume();

// Seek to 30 seconds
Audio::seek(30.0);

// Set volume (0.0 to 1.0)
Audio::setVolume(0.8);

// Get info
$duration = Audio::getDuration();
$position = Audio::getCurrentPosition();

JavaScript (Vue/React/Inertia)#

Copied!

import { audioPlayer } from '@theunwindfront/nativephp-audio';
 
// Play an audio file
await audioPlayer.play('https://www.w3schools.com/html/horse.mp3');
 
// Pause/Resume
await audioPlayer.pause();
await audioPlayer.resume();
 
// Stop and reset
await audioPlayer.stop();
 
// Seek to 30 seconds
await audioPlayer.seek(30.0);
 
// Volume Control (0.0 to 1.0)
await audioPlayer.setVolume(1.0);
 
// Get Duration and Current Position
const duration = await audioPlayer.getDuration();
const position = await audioPlayer.getCurrentPosition();
 
// Event Listeners
window.addEventListener('audio-started', (e) => console.log('Started:', e.detail.url));
window.addEventListener('audio-paused', () => console.log('Paused'));
window.addEventListener('audio-stopped', () => console.log('Stopped'));
window.addEventListener('audio-completed', (e) => console.log('Completed:', e.detail.url));

import { audioPlayer } from '@theunwindfront/nativephp-audio';

// Play an audio file
await audioPlayer.play('https://www.w3schools.com/html/horse.mp3');

// Pause/Resume
await audioPlayer.pause();
await audioPlayer.resume();

// Stop and reset
await audioPlayer.stop();

// Seek to 30 seconds
await audioPlayer.seek(30.0);

// Volume Control (0.0 to 1.0)
await audioPlayer.setVolume(1.0);

// Get Duration and Current Position
const duration = await audioPlayer.getDuration();
const position = await audioPlayer.getCurrentPosition();

// Event Listeners
window.addEventListener('audio-started', (e) => console.log('Started:', e.detail.url));
window.addEventListener('audio-paused', () => console.log('Paused'));
window.addEventListener('audio-stopped', () => console.log('Stopped'));
window.addEventListener('audio-completed', (e) => console.log('Completed:', e.detail.url));

API Reference#

Method	Returns	Description
`play(string $url)`	`bool`	Play an audio file
`pause()`	`bool`	Pause playback
`resume()`	`bool`	Resume playback
`stop()`	`bool`	Stop playback
`seek(float $seconds)`	`bool`	Seek to position
`setVolume(float $level)`	`bool`	Set volume (0.0-1.0)
`getDuration()`	`?float`	Get audio duration
`getCurrentPosition()`	`?float`	Get current position

Version Support#

Platform	Minimum Version
Android	5.0 (API 21)
iOS	13.0

Support#

For questions or issues, email [email protected]

License#

The MIT License (MIT). Please see License File for more information.