Skip to main content
usePermissions(sessionId?: string): Object

Parameters

string
A unique identifier for the participant

Return value

Returns an object with the following properties:
boolean
true in case the local participant’s permissions.canSend is true, or includes 'audio'
boolean
true in case the local participant’s permissions.canSend is true, or includes 'video'
boolean
true in case the local participant’s permissions.canSend is true, or includes 'customAudio'
boolean
true in case the local participant’s permissions.canSend is true, or includes 'customVideo'
boolean
true in case the local participant’s permissions.canSend is true, or includes 'screenAudio'
boolean
true in case the local participant’s permissions.canSend is true, or includes 'screenVideo'
boolean
true in case the local participant’s permissions.hasPresence is true
boolean
true in case the local participant’s permissions.canAdmin is true, or includes 'participants'
boolean
true in case the local participant’s permissions.canAdmin is true, or includes 'streaming'
boolean
true in case the local participant’s permissions.canAdmin is true, or includes 'transcription'
Object
The local participant’s permissions object, as returned from participants()

Example

See also