Share via

Participant class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

Represents a participant in a conversation. Added in version 1.4.0

Constructors

Participant(string, string, string, boolean, boolean, boolean, string, string)

Properties

avatar

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

The participant's display name. Please note that there may be more than one participant with the same name. You can use property to tell them apart.
id

The unique identifier for the participant.
isHost

Gets whether or not this participant is the host.
isMuted

Gets whether or not this participant is muted.
isUsingTts

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

The participant's preferred spoken language.
properties

Contains properties of the participant.
voice

The participant's voice signature

Methods

From(string, string, string)

Constructor Details

Participant(string, string, string, boolean, boolean, boolean, string, string) 

new Participant(id: string, avatar: string, displayName: string, isHost: boolean, isMuted: boolean, isUsingTts: boolean, preferredLanguage: string, voice?: string)

Parameters

id

string

avatar

string

displayName

string

isHost

boolean

isMuted

boolean

isUsingTts

boolean

preferredLanguage

string

voice

string

Property Details

avatar

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

string avatar

Property Value

string

displayName

The participant's display name. Please note that there may be more than one participant with the same name. You can use property to tell them apart.

string displayName

Property Value

string

id

The unique identifier for the participant.

string id

Property Value

string

isHost

Gets whether or not this participant is the host.

boolean isHost

Property Value

boolean

isMuted

Gets whether or not this participant is muted.

boolean isMuted

Property Value

boolean

isUsingTts

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

boolean isUsingTts

Property Value

boolean

preferredLanguage

The participant's preferred spoken language.

string preferredLanguage

Property Value

string

properties

Contains properties of the participant.

PropertyCollection properties

Property Value

PropertyCollection

voice

The participant's voice signature

string voice

Property Value

string

Method Details

From(string, string, string) 

static function From(id: string, language: string, voice: string): IParticipant

Parameters

id

string

language

string

voice

string

Returns

IParticipant