removeMember

View as Markdown

removeMember

  • removeMember(params): Promise<void>

Removes a specific participant from the room.

Parameters

params
object

Object containing the parameters of the method.

memberId
string

Id of the member to remove.

Returns

Promise<void>

Permissions

  • room.member.remove: to remove a remote member.

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

Example

1const id = "de550c0c-3fac-4efd-b06f-b5b8614b8966"; // you can get this from getMembers()
2await roomSession.removeMember({ memberId: id });