IParticipant interface

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

Represents a participant in a conversation. Added in version 1.4.0

Extends

TranscriptionParticipant

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.
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).
properties

Contains properties of the participant.

Inherited Properties

id

The unique identifier for the participant.
preferredLanguage

The participant's preferred spoken language.
voice

The participant's voice signature

Property Details

avatar

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

avatar: string

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.

displayName: string

Property Value

string

isHost

Gets whether or not this participant is the host.

isHost: boolean

Property Value

boolean

isMuted

Gets whether or not this participant is muted.

isMuted: boolean

Property Value

boolean

isUsingTts

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

isUsingTts: boolean

Property Value

boolean

properties

Contains properties of the participant.

properties: PropertyCollection

Property Value

PropertyCollection

Inherited Property Details

id

The unique identifier for the participant.

id: string

Property Value

string

Inherited From TranscriptionParticipant.id

preferredLanguage

The participant's preferred spoken language.

preferredLanguage: string

Property Value

string

Inherited From TranscriptionParticipant.preferredLanguage

voice

The participant's voice signature

voice: string

Property Value

string

Inherited From TranscriptionParticipant.voice