ivsrealtime / Client / get_participant

get_participant#

ivsrealtime.Client.get_participant(**kwargs)#

Gets information about the specified participant token.

See also: AWS API Documentation

Request Syntax

response = client.get_participant(
    stageArn='string',
    sessionId='string',
    participantId='string'
)
Parameters:

  • stageArn (string) –

    [REQUIRED]

    Stage ARN.

  • sessionId (string) –

    [REQUIRED]

    ID of a session within the stage.

  • participantId (string) –

    [REQUIRED]

    Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.

Return type:

dict

Returns:

Response Syntax

{
    'participant': {
        'participantId': 'string',
        'userId': 'string',
        'state': 'CONNECTED'|'DISCONNECTED',
        'firstJoinTime': datetime(2015, 1, 1),
        'attributes': {
            'string': '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',
        'protocol': 'UNKNOWN'|'WHIP'|'RTMP'|'RTMPS'
    }
}

Response Structure

  • (dict) –

    • participant (dict) –

      The participant that is returned.

      • 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.

      • attributes (dict) –

        Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

        • (string) –

          • (string) –

      • published (boolean) –

        Whether the participant ever published to the stage session.

      • ispName (string) –

        The participant’s Internet Service Provider.

      • osName (string) –

        The participant’s operating system.

      • osVersion (string) –

        The participant’s operating system version.

      • browserName (string) –

        The participant’s browser.

      • browserVersion (string) –

        The participant’s browser version.

      • sdkVersion (string) –

        The participant’s SDK version.

      • recordingS3BucketName (string) –

        Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.

      • recordingS3Prefix (string) –

        S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.

      • recordingState (string) –

        The participant’s recording state.

      • protocol (string) –

        Type of ingest protocol that the participant employs for broadcasting.

Exceptions