Share via

Participant Class

  • Reference

An object that represents conversation participant.

Inheritance
builtins.object
Participant

Constructor

Participant(user_id: str, preferred_language: str, voice_signature: str | None = None)

Parameters

Name Description
user_id
Required

The user identification string.
preferred_language
Required

The preferred language of user in BCP-47 format.
voice_signature

User's voice signature (optional).

Default value: None

Methods

set_preferred_language

Sets the preferred language of the participant
set_voice_signature

Sets the voice signature of the participant used for identification.

set_preferred_language

Sets the preferred language of the participant

set_preferred_language(language: str) -> None

Parameters

Name Description
language
Required

The language in BCP-47 format.

set_voice_signature

Sets the voice signature of the participant used for identification.

set_voice_signature(signature: str) -> None

Parameters

Name Description
signature
Required

The language in BCP-47 format.

Attributes

avatar

Gets the colour of the user's avatar as an HTML hex string (e.g. FF0000 for red).

display_name

The participant's display name. Please note that each participant within the same conversation must have a different display name. Duplicate names within the same conversation are not allowed. You can use the Id property as another way to refer to each participant.

is_host

Gets whether or not the participant is the host.

is_muted

Gets whether or not the participant is muted.

is_using_tts

Gets whether or not the participant is using Text To Speech (TTS).

participant_id

Get the identifier for the participant.

properties

A collection of properties and their values defined for this Participant.