Share via

class Transcription::Meeting

  • Article
class Transcription::Meeting
  : public std::enable_shared_from_this< Meeting >

Class for meeting.

Members

Properties

Syntax: public PropertyCollection & Properties;

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

Meeting

Syntax: public inline explicit Meeting ( SPXMEETINGHANDLE hmeeting );

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

Parameters

  • hmeeting Recognizer handle.

~Meeting

Syntax: public inline ~Meeting ( );

Destructor.

operator SPXMEETINGHANDLE

Syntax: public inline explicit operator SPXMEETINGHANDLE ( ) const;

Internal operator used to get underlying handle value.

Returns

A handle.

GetMeetingId

Syntax: public inline std::string GetMeetingId ( );

Get the meeting id.

Returns

Meeting id.

AddParticipantAsync

Syntax: public inline std::future< std::shared_ptr< Participant > > AddParticipantAsync ( const std::string & userId );

Add a participant to a meeting using the user's id.

Note: The returned participant can be used to remove. If the client changes the participant's attributes, the changed attributes are passed on to the service only when the participant is added again.

Parameters

  • userId A user id.

Returns

a shared smart pointer of the participant.

AddParticipantAsync

Syntax: public inline std::future< std::shared_ptr< User > > AddParticipantAsync ( const std::shared_ptr< User > & user );

Add a participant to a meeting using the User object.

Parameters

  • user A shared smart pointer to a User object.

Returns

The passed in User object.

AddParticipantAsync

Syntax: public inline std::future< std::shared_ptr< Participant > > AddParticipantAsync ( const std::shared_ptr< Participant > & participant );

Add a participant to a meeting using the participant object.

Parameters

  • participant A shared smart pointer to a participant object.

Returns

The passed in participant object.

RemoveParticipantAsync

Syntax: public inline std::future< void > RemoveParticipantAsync ( const std::shared_ptr< Participant > & participant );

Remove a participant from a meeting using the participant object.

Parameters

  • participant A shared smart pointer of a participant object.

Returns

An empty future.

RemoveParticipantAsync

Syntax: public inline std::future< void > RemoveParticipantAsync ( const std::shared_ptr< User > & user );

Remove a participant from a meeting using the User object.

Parameters

  • user A smart pointer of a User.

Returns

An empty future.

RemoveParticipantAsync

Syntax: public inline std::future< void > RemoveParticipantAsync ( const std::string & userId );

Remove a participant from a meeting using a user id string.

Parameters

  • userId A user id.

Returns

An empty future.

EndMeetingAsync

Syntax: public inline std::future< void > EndMeetingAsync ( );

Ends the current meeting.

Returns

An empty future.

SetAuthorizationToken

Syntax: public inline void SetAuthorizationToken ( const std::string & token );

Sets the authorization token that will be used for connecting the server.

Parameters

  • token The authorization token.

GetAuthorizationToken

Syntax: public inline std::string GetAuthorizationToken ( );

Gets the authorization token.

Returns

Authorization token

StartMeetingAsync

Syntax: public inline std::future< void > StartMeetingAsync ( );

Start the meeting.

Returns

An empty future.

DeleteMeetingAsync

Syntax: public inline std::future< void > DeleteMeetingAsync ( );

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

Returns

An empty future.

LockMeetingAsync

Syntax: public inline std::future< void > LockMeetingAsync ( );

Locks the meeting. After this no new participants will be able to join.

Returns

An empty future.

UnlockMeetingAsync

Syntax: public inline std::future< void > UnlockMeetingAsync ( );

Unlocks the meeting.

Returns

An empty future.

MuteAllParticipantsAsync

Syntax: public inline std::future< void > MuteAllParticipantsAsync ( );

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

Returns

An empty future.

UnmuteAllParticipantsAsync

Syntax: public inline std::future< void > UnmuteAllParticipantsAsync ( );

Allows other participants to generate transcriptions, or send text messages.

Returns

An empty future.

MuteParticipantAsync

Syntax: public inline std::future< void > MuteParticipantAsync ( const std::string & participantId );

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

Parameters

  • participantId The identifier for the participant.

Returns

An empty future.

UnmuteParticipantAsync

Syntax: public inline std::future< void > UnmuteParticipantAsync ( const std::string & participantId );

Unmutes a particular participant.

Parameters

  • participantId The identifier for the participant.

Returns

An empty future.

CreateMeetingAsync

Syntax: public inline static std::future< std::shared_ptr< Meeting > > CreateMeetingAsync ( std::shared_ptr< SpeechConfig > speechConfig , const std::string & meetingId );

Create a meeting using a speech config and a meeting id.

Parameters

  • speechConfig A shared smart pointer of a speech config object.

  • meetingId meeting Id.

Returns

A shared smart pointer of the created meeting object.