Share via

class Transcription::Participant

  • Article

Represents a participant in a conversation. Added in version 1.5.0.

Members

Id

Syntax: public const std::string & Id;

Get the identifier for the participant.

Avatar

Syntax: public const std::string & Avatar;

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

DisplayName

Syntax: public const std::string & DisplayName;

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.

IsUsingTts

Syntax: public const bool & IsUsingTts;

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

IsMuted

Syntax: public const bool & IsMuted;

Gets whether or not this participant is muted.

IsHost

Syntax: public const bool & IsHost;

Gets whether or not this participant is the host.

Properties

Syntax: public PropertyCollection & Properties;

Collection of additional participant properties.

Participant

Syntax: public inline explicit Participant ( SPXPARTICIPANTHANDLE hparticipant );

Internal constructor. Creates a new instance using the provided handle.

Parameters

  • hparticipant participant handle.

~Participant

Syntax: public inline virtual ~Participant ( );

Virtual destructor.

operator SPXPARTICIPANTHANDLE

Syntax: public inline explicit operator SPXPARTICIPANTHANDLE ( ) const;

Internal operator used to get underlying handle value.

Returns

A handle.

SetPreferredLanguage

Syntax: public inline void SetPreferredLanguage ( const std::string & preferredLanguage );

Set preferred language.

Parameters

  • preferredLanguage The preferred language, such as "en-us".

SetVoiceSignature

Syntax: public inline void SetVoiceSignature ( const std::string & voiceSignature );

Set voice signature. If voice signature is empty then user will not be identified.

Parameters

  • voiceSignature The participant's voice signature."

From

Syntax: public inline static std::shared_ptr< Participant > From ( const std::string & userId , const std::string & preferredLanguage , const std::string & voiceSignature );

Create a participant using user id, her/his preferred language and her/his voice signature. If voice signature is empty then user will not be identified.

Parameters

  • userId A user ids.

  • preferredLanguage The preferred languages of the user. It can be optional.

  • voiceSignature The voice signature of the user. It can be optional.

Returns

A smart pointer of Participant