usePermissions

usePermissions(): Object

usePermissions is a convenience hook to access the local participant's permissions.

Return type

Returns an object with the following properties:

NameTypeDescription
canSendAudiobooleantrue in case the local participant's permissions.canSend is true, or includes 'audio'
canSendVideobooleantrue in case the local participant's permissions.canSend is true, or includes 'video'
canSendCustomAudiobooleantrue in case the local participant's permissions.canSend is true, or includes 'customAudio'
canSendCustomVideobooleantrue in case the local participant's permissions.canSend is true, or includes 'customVideo'
canSendScreenAudiobooleantrue in case the local participant's permissions.canSend is true, or includes 'screenAudio'
canSendScreenVideobooleantrue in case the local participant's permissions.canSend is true, or includes 'screenVideo'
hasPresencebooleantrue in case the local participant's permissions.hasPresence is true
permissionsObjectThe local participant's permissions object, as returned from participants()

Sample code