ivsrealtime_disconnect_participant: Disconnects a specified participant from a specified stage
In paws.analytics: 'Amazon Web Services' Analytics Services
View source: R/ivsrealtime_operations.R
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.
See https://www.paws-r-sdk.com/docs/ivsrealtime_disconnect_participant/ for full documentation.
Usage
ivsrealtime_disconnect_participant(stageArn, participantId, reason = NULL)
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.
paws.analytics documentation built on April 3, 2025, 11:10 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/ivsrealtime_operations.R
| 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.
See https://www.paws-r-sdk.com/docs/ivsrealtime_disconnect_participant/ for full documentation.
Usage
ivsrealtime_disconnect_participant(stageArn, participantId, reason = NULL)
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
|
reason |
Description of why this participant is being disconnected. |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.