Disconnect Participant

ivsrealtime_disconnect_participant

R Documentation

Disconnects a specified participant and revokes the participant permanently from a specified stage

Description

Disconnects a specified participant and revokes the participant permanently from a specified stage.

Usage

ivsrealtime_disconnect_participant(stageArn, participantId, reason)

Arguments

stageArn

[required] ARN of the stage to which the participant is attached.

participantId

[required] Identifier of the participant to be disconnected. This is assigned by IVS and returned by create_participant_token.

reason

Description of why this participant is being disconnected.

Value

An empty list.

Request syntax

svc$disconnect_participant(
  stageArn = "string",
  participantId = "string",
  reason = "string"
)