Meeting Class

An object that performs meeting management related operations.

Inheritance

builtins.object

Meeting

Constructor

Meeting(speech_config: SpeechConfig, meeting_id: str)

Parameters

Name	Description
speech_config Required	The speech configuration.
meeting_id Required	The meeting identifier.

Methods

add_participant_async	Asynchronously adds a participant to a meeting using the participant object or user id.+ Note The caller needs to ensure that this asynchronous call is completed before starting the meeting. This can be done by calling the get function of the returned future.
delete_meeting_async	Asynchronously deletes meeting. Any participants that are still part of the meeting will be ejected after this call.
end_meeting_async	Asynchronously ends the current meeting.
lock_meeting_async	Asynchronously locks meeting. After this no new participants will be able to join.
mute_all_participants_async	Asynchronously mutes all participants except for the host. This prevents others from generating transcriptions, or sending text messages.
mute_participant_async	Asynchronously mutes a particular participant. This will prevent them generating new transcriptions, or sending text messages.
remove_participant_async	Asynchronously removes a participant from a meeting using the participant object or user id.
start_meeting_async	Asynchronously starts meeting.
unlock_meeting_async	Asynchronously unlocks meeting.
unmute_all_participants_async	Asynchronously unmutes all participants, which allows participants to generate transcriptions, or send text messages.
unmute_participant_async	Asynchronously unmutes a particular participant. This will allow generating new transcriptions, or sending text messages.

add_participant_async

Asynchronously adds a participant to a meeting using the participant object or user id.+

Note

The caller needs to ensure that this asynchronous call is completed before starting the meeting.

This can be done by calling the get function of the returned future.

add_participant_async(participant: Participant | None = None, user_id: str | None = None) -> ResultFuture

Parameters

Name	Description
participant	the participant object Default value: None
user_id	the user identification string Default value: None

Returns

Type	Description
	A future containing the added participant object.

delete_meeting_async

Asynchronously deletes meeting. Any participants that are still part of the meeting will be ejected after this call.

delete_meeting_async() -> ResultFuture

Returns

Type	Description
	A future that is fulfilled once meeting has been deleted.

end_meeting_async

Asynchronously ends the current meeting.

end_meeting_async() -> ResultFuture

Returns

Type	Description
	A future that is fulfilled once meeting has been ended.

lock_meeting_async

Asynchronously locks meeting. After this no new participants will be able to join.

lock_meeting_async() -> ResultFuture

Returns

Type	Description
	A future that is fulfilled once meeting has been locked.

mute_all_participants_async

Asynchronously mutes all participants except for the host. This prevents others from generating transcriptions, or sending text messages.

mute_all_participants_async() -> ResultFuture

Returns

Type	Description
	A future that is fulfilled once participants have been muted.

mute_participant_async

Asynchronously mutes a particular participant. This will prevent them generating new transcriptions, or sending text messages.

mute_participant_async(participant_id: str) -> ResultFuture

Parameters

Name	Description
participant_id Required	the participant idnetifier.

Returns

Type	Description
	A future that is fulfilled once participant has been muted.

remove_participant_async

Asynchronously removes a participant from a meeting using the participant object or user id.

remove_participant_async(participant: Participant | None = None, user_id: str | None = None) -> ResultFuture

Parameters

Name	Description
participant	the participant object Default value: None
user_id	the user identification string Default value: None

Returns

Type	Description
	An empty future.

start_meeting_async

Asynchronously starts meeting.

start_meeting_async() -> ResultFuture

Returns

Type	Description
	A future that is fulfilled once meeting has been started.

unlock_meeting_async

Asynchronously unlocks meeting.

unlock_meeting_async() -> ResultFuture

Returns

Type	Description
	A future that is fulfilled once meeting has been unlocked.

unmute_all_participants_async

Asynchronously unmutes all participants, which allows participants to generate transcriptions, or send text messages.

unmute_all_participants_async() -> ResultFuture

Returns

Type	Description
	A future that is fulfilled once participants have been unmuted.

unmute_participant_async

Asynchronously unmutes a particular participant. This will allow generating new transcriptions, or sending text messages.

unmute_participant_async(participant_id: str) -> ResultFuture

Parameters

Name	Description
participant_id Required	the participant idnetifier.

Returns

Type	Description
	A future that is fulfilled once participant has been muted.

Attributes

authorization_token

The authorization token that will be used for connecting to the service.

Note

The caller needs to ensure that the authorization token is valid. Before the

authorization token expires, the caller needs to refresh it by calling this setter with a

new valid token. As configuration values are copied when creating a new recognizer, the

new token value will not apply to recognizers that have already been created. For

recognizers that have been created before, you need to set authorization token of the

corresponding recognizer to refresh the token. Otherwise, the recognizers will encounter

errors during transcription.

meeting_id

Get the meeting id.

properties

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