List Participant Events

ivsrealtime_list_participant_events

R Documentation

Lists events for a specified participant that occurred during a specified stage session¶

Description¶

Lists events for a specified participant that occurred during a specified stage session.

Usage¶

ivsrealtime_list_participant_events(stageArn, sessionId, participantId,
  nextToken, maxResults)

Arguments¶

stageArn: [required] Stage ARN.
sessionId: [required] ID of a session within the stage.
participantId: [required] Unique identifier for this participant. This is assigned by IVS and returned by create_participant_token.
nextToken: The first participant event to retrieve. This is used for pagination; see the nextToken response field.
maxResults: Maximum number of results to return. Default: 50.

Value¶

A list with the following syntax:

list(
  events = list(
    list(
      name = "JOINED"|"LEFT"|"PUBLISH_STARTED"|"PUBLISH_STOPPED"|"SUBSCRIBE_STARTED"|"SUBSCRIBE_STOPPED"|"PUBLISH_ERROR"|"SUBSCRIBE_ERROR"|"JOIN_ERROR",
      participantId = "string",
      eventTime = as.POSIXct(
        "2015-01-01"
      ),
      remoteParticipantId = "string",
      errorCode = "INSUFFICIENT_CAPABILITIES"|"QUOTA_EXCEEDED"|"PUBLISHER_NOT_FOUND"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_participant_events(
  stageArn = "string",
  sessionId = "string",
  participantId = "string",
  nextToken = "string",
  maxResults = 123
)