Skip to content

Lists all participants in a specified stage session

Description

Lists all participants in a specified stage session.

Usage

ivsrealtime_list_participants(stageArn, sessionId, filterByUserId,
  filterByPublished, filterByState, nextToken, maxResults,
  filterByRecordingState)

Arguments

  • stageArn

    [required] Stage ARN.

  • sessionId

    [required] ID of the session within the stage.

  • filterByUserId

    Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

  • filterByPublished

    Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

  • filterByState

    Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

  • nextToken

    The first participant to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults

    Maximum number of results to return. Default: 50.

  • filterByRecordingState

    Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.

Value

A list with the following syntax:

list(
  participants = list(
    list(
      participantId = "string",
      userId = "string",
      state = "CONNECTED"|"DISCONNECTED",
      firstJoinTime = as.POSIXct(
        "2015-01-01"
      ),
      published = TRUE|FALSE,
      recordingState = "STARTING"|"ACTIVE"|"STOPPING"|"STOPPED"|"FAILED"|"DISABLED",
      replicationType = "SOURCE"|"REPLICA"|"NONE",
      replicationState = "ACTIVE"|"STOPPED",
      sourceStageArn = "string",
      sourceSessionId = "string",
      redundantIngest = TRUE|FALSE,
      ingestConfigurationArn = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_participants(
  stageArn = "string",
  sessionId = "string",
  filterByUserId = "string",
  filterByPublished = TRUE|FALSE,
  filterByState = "CONNECTED"|"DISCONNECTED",
  nextToken = "string",
  maxResults = 123,
  filterByRecordingState = "STARTING"|"ACTIVE"|"STOPPING"|"STOPPED"|"FAILED"
)