Microphone

#Overview

The Microphone API provides access to the device's microphone for recording audio. It offers a fluent interface for starting and managing recordings, tracking them with unique identifiers, and responding to completion events.

Import

Copied!

use Native\Mobile\Facades\Microphone;

use Native\Mobile\Facades\Microphone;

Copied!

import { microphone, on, off, Events } from '#nativephp';

import { microphone, on, off, Events } from '#nativephp';

#Methods

#`record()`

Start an audio recording. Returns a PendingMicrophone instance that controls the recording lifecycle.

Record Audio

Copied!

Microphone::record()->start();

Microphone::record()->start();

Copied!

// Basic recording
await microphone.record();
 
// With identifier for tracking
await microphone.record()
    .id('voice-memo');

// Basic recording
await microphone.record();
// With identifier for tracking
await microphone.record()
.id('voice-memo');

#`stop()`

Stop the current audio recording. If this results in a saved file, this dispatches the AudioRecorded event with the recording file path.

Stop Recording

Copied!

Microphone::stop();

Microphone::stop();

Copied!

await microphone.stop();

await microphone.stop();

#`pause()`

Pause the current audio recording without ending it.

Pause Recording

Copied!

Microphone::pause();

Microphone::pause();

Copied!

await microphone.pause();

await microphone.pause();

#`resume()`

Resume a paused audio recording.

Resume Recording

Copied!

Microphone::resume();

Microphone::resume();

Copied!

await microphone.resume();

await microphone.resume();

#`getStatus()`

Get the current recording status.

Returns: string - One of: "idle", "recording", or "paused"

Get Status

Copied!

$status = Microphone::getStatus();
 
if ($status === 'recording') {
    // A recording is in progress
}

$status = Microphone::getStatus();
if ($status === 'recording') {
// A recording is in progress
}

Copied!

const result = await microphone.getStatus();
 
if (result.status === 'recording') {
    // A recording is in progress
}

const result = await microphone.getStatus();
if (result.status === 'recording') {
// A recording is in progress
}

#`getRecording()`

Get the file path to the last recorded audio file.

Returns: string|null - Path to the last recording, or null if none exists

Get Recording

Copied!

$path = Microphone::getRecording();
 
if ($path) {
    // Process the recording file
}

$path = Microphone::getRecording();
if ($path) {
// Process the recording file
}

Copied!

const result = await microphone.getRecording();
 
if (result.path) {
    // Process the recording file
}

const result = await microphone.getRecording();
if (result.path) {
// Process the recording file
}

#PendingMicrophone

The PendingMicrophone provides a fluent interface for configuring and starting audio recordings. Most methods return $this for method chaining.

#`id(string $id)`

Set a unique identifier for this recording. This ID will be included in the AudioRecorded event, allowing you to correlate recordings with completion events.

Copied!

$recorderId = 'message-recording-' . $this->id;
 
Microphone::record()
    ->id($recorderId)
    ->start();

$recorderId = 'message-recording-' . $this->id;

Microphone::record()
    ->id($recorderId)
    ->start();

#`getId()`

Get the recorder's unique identifier. If no ID was set, one is automatically generated (UUID v4).

Copied!

$recorder = Microphone::record()
    ->id('my-recording');
 
$id = $recorder->getId(); // 'my-recording'

$recorder = Microphone::record()
    ->id('my-recording');

$id = $recorder->getId(); // 'my-recording'

#`event(string $eventClass)`

Set a custom event class to dispatch when recording completes. By default, AudioRecorded is used.

Throws: InvalidArgumentException if the event class does not exist

Copied!

use App\Events\VoiceMessageRecorded;
 
Microphone::record()
    ->event(VoiceMessageRecorded::class)
    ->start();

use App\Events\VoiceMessageRecorded;

Microphone::record()
    ->event(VoiceMessageRecorded::class)
    ->start();

#`remember()`

Store the recorder's ID in the session for later retrieval. This is useful when the recording completes on the next request.

Copied!

Microphone::record()
    ->id('voice-note')
    ->remember()
    ->start();

Microphone::record()
    ->id('voice-note')
    ->remember()
    ->start();

#`lastId()`

Retrieve the last remembered audio recorder ID from the session. Use this in event listeners to correlate recordings.

Copied!

use Native\Mobile\Attributes\OnNative;
use Native\Mobile\Events\Microphone\MicrophoneRecorded;
 
#[OnNative(MicrophoneRecorded::class)]
public function handleAudioRecorded(string $path, string $mimeType, ?string $id)
{
    // For comparing with remembered IDs
    if ($id === Audio::record()->lastId()) {
        $this->saveRecording($path);
    }
}

use Native\Mobile\Attributes\OnNative;
use Native\Mobile\Events\Microphone\MicrophoneRecorded;

#[OnNative(MicrophoneRecorded::class)]
public function handleAudioRecorded(string $path, string $mimeType, ?string $id)
{
    // For comparing with remembered IDs
    if ($id === Audio::record()->lastId()) {
        $this->saveRecording($path);
    }
}

#`start()`

Explicitly start the audio recording. This is optional - recordings auto-start if you don't call this method.

Returns: bool - true if recording started successfully, false if it failed or was already started

Copied!

$recorder = Microphone::record()->id('my-recording');
 
if ($recorder->start()) {
    // Recording started
} else {
    // Recording failed - likely due to permission denial
}

$recorder = Microphone::record()->id('my-recording');

if ($recorder->start()) {
    // Recording started
} else {
    // Recording failed - likely due to permission denial
}

#Events

#`MicrophoneRecorded`

Dispatched when an audio recording completes. The event includes the file path and recording ID.

Payload:

string $path - File path to the recorded audio
string $mimeType - MIME type of the audio (default: 'audio/m4a')
?string $id - The recorder's ID, if one was set

MicrophoneRecorded Event

Copied!

#[OnNative(MicrophoneRecorded::class)]
public function handleAudioRecorded(string $path, string $mimeType, ?string $id)
{
    // Store or process the recording
    $this->recordings[] = [
        'path' => $path,
        'mimeType' => $mimeType,
        'id' => $id,
    ];
}

#[OnNative(MicrophoneRecorded::class)]
public function handleAudioRecorded(string $path, string $mimeType, ?string $id)
{
    // Store or process the recording
    $this->recordings[] = [
        'path' => $path,
        'mimeType' => $mimeType,
        'id' => $id,
    ];
}

Copied!

import { on, off, Events } from '#nativephp';
import { ref, onMounted, onUnmounted } from 'vue';
 
const recordings = ref([]);
 
const handleAudioRecorded = (payload) => {
    const { path, mimeType, id } = payload;
    recordings.value.push({ path, mimeType, id });
};
 
onMounted(() => {
    on(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
});
 
onUnmounted(() => {
    off(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
});

import { on, off, Events } from '#nativephp';
import { ref, onMounted, onUnmounted } from 'vue';
const recordings = ref([]);
const handleAudioRecorded = (payload) => {
const { path, mimeType, id } = payload;
recordings.value.push({ path, mimeType, id });
};
onMounted(() => {
on(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
});
onUnmounted(() => {
off(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
});

Copied!

import { on, off, Events } from '#nativephp';
import { useState, useEffect } from 'react';
 
const [recordings, setRecordings] = useState([]);
 
const handleAudioRecorded = (payload) => {
    const { path, mimeType, id } = payload;
    setRecordings(prev => [...prev, { path, mimeType, id }]);
};
 
useEffect(() => {
    on(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
 
    return () => {
        off(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
    };
}, []);

import { on, off, Events } from '#nativephp';
import { useState, useEffect } from 'react';
const [recordings, setRecordings] = useState([]);
const handleAudioRecorded = (payload) => {
const { path, mimeType, id } = payload;
setRecordings(prev => [...prev, { path, mimeType, id }]);
};
useEffect(() => {
on(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
    
        
            Copied!
            
        
        return () =&gt; {
    off(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
};

return () =&gt; {
    off(Events.Microphone.MicrophoneRecorded, handleAudioRecorded);
};
    
}, []);

#Notes

Microphone Permission: The first time your app requests microphone access, users will be prompted for permission. If denied, recording functions will fail silently.
Microphone Background Permission: You can allow your app to record audio while the device is locked by toggling microphone_background to true in the config
File Format: Recordings are stored as M4A/AAC audio files (.m4a). This format is optimized for small file sizes while maintaining quality.
Recording State: Only one recording can be active at a time. Calling start() while a recording is in progress will return false.
Auto-Start Behavior: If you don't explicitly call start(), the recording will automatically start when the `PendingMicrophone is destroyed. This maintains backward compatibility with earlier versions.

Microphone

On this page

#Overview

#Methods

#record()

#stop()

#pause()

#resume()

#getStatus()

#getRecording()

#PendingMicrophone

#id(string $id)

#getId()

#event(string $eventClass)

#remember()

#lastId()

#start()

#Events

#MicrophoneRecorded

#Notes

#`record()`

#`stop()`

#`pause()`

#`resume()`

#`getStatus()`

#`getRecording()`

#`id(string $id)`

#`getId()`

#`event(string $eventClass)`

#`remember()`

#`lastId()`

#`start()`

#`MicrophoneRecorded`