Disconnect Participant

ivsrealtime_disconnect_participant

R Documentation

Disconnects a specified participant from a specified stage¶

Description¶

Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

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. IVS assigns this; it is returned by create_participant_token (for streams using WebRTC ingest) or create_ingest_configuration (for streams using RTMP ingest).

reason

Description of why this participant is being disconnected.

Value¶

An empty list.

Request syntax¶

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