Meeting class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

Properties

authorizationToken
config
isConnected
meetingId
meetingInfo
participants
properties
speechRecognitionLanguage

Methods

addParticipantAsync(IParticipant, Callback, Callback)

Add Participant to Meeting.
createMeetingAsync(SpeechTranslationConfig, string, Callback, Callback)

Create a meeting
deleteMeetingAsync(Callback, Callback)

Delete a meeting. After this no one will be able to join the meeting.
endMeetingAsync(Callback, Callback)

End a meeting.
lockMeetingAsync(Callback, Callback)

Lock a meeting. This will prevent new participants from joining.
muteAllParticipantsAsync(Callback, Callback)

Mute all other participants in the Meeting. After this no other participants will have their speech recognitions broadcast, nor be able to send text messages.
muteParticipantAsync(string, Callback, Callback)

Mute a participant.
removeParticipantAsync(string | IParticipant | IUser, Callback, Callback)

Remove a participant from a meeting using the user id, Participant or User object
startMeetingAsync(Callback, Callback)

Start a meeting.
unlockMeetingAsync(Callback, Callback)

Unlocks a meeting.
unmuteAllParticipantsAsync(Callback, Callback)

Unmute all other participants in the meeting.
unmuteParticipantAsync(string, Callback, Callback)

Unmute a participant.

Property Details

authorizationToken 

string authorizationToken

Property Value

string

config 

SpeechTranslationConfig config

Property Value

SpeechTranslationConfig

isConnected 

boolean isConnected

Property Value

boolean

meetingId 

string meetingId

Property Value

string

meetingInfo 

MeetingInfo meetingInfo

Property Value

MeetingInfo

participants 

Participant[] participants

Property Value

Participant[]

properties 

PropertyCollection properties

Property Value

PropertyCollection

speechRecognitionLanguage 

string speechRecognitionLanguage

Property Value

string

Method Details

addParticipantAsync(IParticipant, Callback, Callback)

Add Participant to Meeting.

function addParticipantAsync(participant: IParticipant, cb?: Callback, err?: Callback)

Parameters

participant
IParticipant
cb

Callback

err

Callback

createMeetingAsync(SpeechTranslationConfig, string, Callback, Callback)

Create a meeting

static function createMeetingAsync(speechConfig: SpeechTranslationConfig, meetingId: string, arg3?: Callback, arg4?: Callback): Meeting

Parameters

speechConfig
SpeechTranslationConfig
meetingId

string

arg3

Callback

arg4

Callback

Returns

Meeting

deleteMeetingAsync(Callback, Callback)

Delete a meeting. After this no one will be able to join the meeting.

function deleteMeetingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

endMeetingAsync(Callback, Callback)

End a meeting.

function endMeetingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

lockMeetingAsync(Callback, Callback)

Lock a meeting. This will prevent new participants from joining.

function lockMeetingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

muteAllParticipantsAsync(Callback, Callback)

Mute all other participants in the Meeting. After this no other participants will have their speech recognitions broadcast, nor be able to send text messages.

function muteAllParticipantsAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

muteParticipantAsync(string, Callback, Callback)

Mute a participant.

function muteParticipantAsync(userId: string, cb?: Callback, err?: Callback)

Parameters

userId

string

A user identifier

cb

Callback

err

Callback

removeParticipantAsync(string | IParticipant | IUser, Callback, Callback)

Remove a participant from a meeting using the user id, Participant or User object

function removeParticipantAsync(userId: string | IParticipant | IUser, cb?: Callback, err?: Callback)

Parameters

userId

string | IParticipant | IUser

A user identifier

cb

Callback

err

Callback

startMeetingAsync(Callback, Callback)

Start a meeting.

function startMeetingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

unlockMeetingAsync(Callback, Callback)

Unlocks a meeting.

function unlockMeetingAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

unmuteAllParticipantsAsync(Callback, Callback)

Unmute all other participants in the meeting.

function unmuteAllParticipantsAsync(cb?: Callback, err?: Callback)

Parameters

cb

Callback

err

Callback

unmuteParticipantAsync(string, Callback, Callback)

Unmute a participant.

function unmuteParticipantAsync(userId: string, cb?: Callback, err?: Callback)

Parameters

userId

string

A user identifier

cb

Callback

err

Callback