useAudioPlayback
function useAudioPlayback(_room?): {
canPlayAudio: boolean;
startAudio: () => Promise<void>;
};Defined in: packages/react/src/hooks/visualizer/useAudioPlayback.ts:30
Note. This feature is experimental and may change or be removed based on developer feedback and real-world usage. In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a
Parameters
| Parameter | Type |
|---|---|
_room? | unknown |
Returns
{
canPlayAudio: boolean;
startAudio: () => Promise<void>;
}canPlayAudio
canPlayAudio: boolean;startAudio
startAudio: () => Promise<void>;Returns
Promise<void>
Example
// Basic — unlock playback after a user gesture.
const { canPlayAudio, startAudio } = useAudioPlayback();
// Advanced — show a start-audio action only when needed.
function AudioGate({ room }: { room: Room }) {
const { canPlayAudio, startAudio } = useAudioPlayback(room);
return (
<VoiceRoom agent={agent}>
{!canPlayAudio && <button onClick={startAudio}>Start audio</button>}
<RoomAudioRenderer />
</VoiceRoom>
);
}