ivsrealtime / Client / list_participants

list_participants#

ivsrealtime.Client.list_participants(**kwargs)#

Lists all participants in a specified stage session.

See also: AWS API Documentation

Request Syntax

response = client.list_participants(
    stageArn='string',
    sessionId='string',
    filterByUserId='string',
    filterByPublished=True|False,
    filterByState='CONNECTED'|'DISCONNECTED',
    nextToken='string',
    maxResults=123,
    filterByRecordingState='STARTING'|'ACTIVE'|'STOPPING'|'STOPPED'|'FAILED'
)
Parameters:

  • stageArn (string) –

    [REQUIRED]

    Stage ARN.

  • sessionId (string) –

    [REQUIRED]

    ID of the session within the stage.

  • filterByUserId (string) – 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 (boolean) – 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 (string) – 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 (string) – The first participant to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults (integer) – Maximum number of results to return. Default: 50.

  • filterByRecordingState (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'participants': [
        {
            'participantId': 'string',
            'userId': 'string',
            'state': 'CONNECTED'|'DISCONNECTED',
            'firstJoinTime': datetime(2015, 1, 1),
            'published': True|False,
            'recordingState': 'STARTING'|'ACTIVE'|'STOPPING'|'STOPPED'|'FAILED'|'DISABLED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • participants (list) –

      List of the matching participants (summary information only).

      • (dict) –

        Summary object describing a participant that has joined a stage.

        • participantId (string) –

          Unique identifier for this participant, assigned by IVS.

        • userId (string) –

          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. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

        • state (string) –

          Whether the participant is connected to or disconnected from the stage.

        • firstJoinTime (datetime) –

          ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

        • published (boolean) –

          Whether the participant ever published to the stage session.

        • recordingState (string) –

          The participant’s recording state.

    • nextToken (string) –

      If there are more participants than maxResults, use nextToken in the request to get the next set.

Exceptions