VideoRoomSessionMethods

setRaisedHand

View as Markdown

setRaisedHand

  • setRaisedHand(params): Promise<void>

Sets the raised hand status for the current member.

Parameters

NameTypeDescription
paramsObject-
params.memberIdstringId of the member to affect.
params.raised?booleanWhether to raise or lower the hand. Default: true. If omitted, the hand status is toggled to the opposite of the current status.

Returns

Promise<void>

Permissions

  • video.member.raisehand: to raise a hand
  • video.member.lowerhand: to lower a hand

You need to specify the permissions when creating the Video Room Token on the server side.

Example

1await room.setRaisedHand({
2  memberId: "de550c0c-3fac-4efd-b06f-b5b86...",
3  raised: false
4});