useLocalParticipantPermissions
function useLocalParticipantPermissions():
| ParticipantPermission
| undefined;Defined in: packages/react/src/hooks/participant/useLocalParticipantPermissions.ts:31
The useLocalParticipantPermissions hook returns the local participant's permissions.
Returns
| ParticipantPermission
| undefined
Example
// Basic — read the local participant's publish permissions.
const permissions = useLocalParticipantPermissions();
const canPublish = permissions?.canPublish;
// Advanced — disable controls based on local permissions.
function PermissionAwareControls() {
const permissions = useLocalParticipantPermissions();
const { enabled, toggle } = useTrackToggle("microphone");
return <button onClick={() => toggle()} disabled={!permissions?.canPublish}>{enabled ? "Mute" : "Unmute"}</button>;
}
function RoomPermissions() {
return (
<VoiceRoom agent={agent}>
<PermissionAwareControls />
</VoiceRoom>
);
}