Get Participant

ivsrealtime_get_participant

R Documentation

Gets information about the specified participant token

Description

Gets information about the specified participant token.

Usage

ivsrealtime_get_participant(stageArn, sessionId, participantId)

Arguments

stageArn

[required] Stage ARN.

sessionId

[required] ID of a session within the stage.

participantId

[required] Unique identifier for the participant. This is assigned by IVS and returned by create_participant_token.

Value

A list with the following syntax:

list(
  participant = list(
    participantId = "string",
    userId = "string",
    state = "CONNECTED"|"DISCONNECTED",
    firstJoinTime = as.POSIXct(
      "2015-01-01"
    ),
    attributes = list(
      "string"
    ),
    published = TRUE|FALSE,
    ispName = "string",
    osName = "string",
    osVersion = "string",
    browserName = "string",
    browserVersion = "string",
    sdkVersion = "string",
    recordingS3BucketName = "string",
    recordingS3Prefix = "string",
    recordingState = "STARTING"|"ACTIVE"|"STOPPING"|"STOPPED"|"FAILED"|"DISABLED"
  )
)

Request syntax

svc$get_participant(
  stageArn = "string",
  sessionId = "string",
  participantId = "string"
)