Meeting Class

  • Reference
Package:
com.microsoft.cognitiveservices.speech.transcription
Maven Artifact:
com.microsoft.cognitiveservices.speech:client-sdk:1.38.0
  • java.lang.Object
    • com.microsoft.cognitiveservices.speech.transcription.Meeting

Implements

java.lang.AutoCloseable

public final class Meeting
implements java.lang.AutoCloseable

Performs meeting management including add and remove participants. Note: close() must be called in order to release underlying resources held by the object.

Constructor Summary

Modifier Constructor Description
protected Meeting(long handleValue)

Protected constructor.

Method Summary

Modifier and Type Method and Description
java.util.concurrent.Future<Participant> addParticipantAsync(Participant participant)

Add a participant to a meeting using a participant object.
java.util.concurrent.Future<User> addParticipantAsync(User user)

Add a participant to a meeting using a user object.
java.util.concurrent.Future<Participant> addParticipantAsync(String userId)

Add a participant to a meeting using the user's id.
void close()

Dispose of associated resources.
static java.util.concurrent.Future<Meeting> createMeetingAsync(SpeechConfig speechConfig)

Initializes a new instance of Meeting.
static java.util.concurrent.Future<Meeting> createMeetingAsync(SpeechConfig speechConfig, String meetingId)

Initializes a new instance of Meeting.
java.util.concurrent.Future<java.lang.Void> deleteMeetingAsync()

Delete a meeting.
protected void dispose(boolean disposing)

PROTECTED
java.util.concurrent.Future<java.lang.Void> endMeetingAsync()

End a meeting.
java.lang.String getAuthorizationToken()

Gets the authorization token used to communicate with the service.
SafeHandle getImpl()

Returns the comversation implementation.
java.lang.String getMeetingId()

Gets the meeting Id.
PropertyCollection getProperties()

The collection of properties and their values defined for this meeting.
java.util.concurrent.Future<java.lang.Void> lockMeetingAsync()

Lock a meeting.
java.util.concurrent.Future<java.lang.Void> muteAllParticipantsAsync()

Mute all other participants in the meeting.
java.util.concurrent.Future<java.lang.Void> muteParticipantAsync(String userId)

Mute a participant.
java.util.concurrent.Future<java.lang.Void> removeParticipantAsync(Participant participant)

Remove a participant from a meeting using a participant object.
java.util.concurrent.Future<java.lang.Void> removeParticipantAsync(User user)

Remove a participant from a meeting using a user object.
java.util.concurrent.Future<java.lang.Void> removeParticipantAsync(String userId)

Remove a participant from a meeting using a user id.
void setAuthorizationToken(String token)

Sets the authorization token used to communicate with the service.
java.util.concurrent.Future<java.lang.Void> startMeetingAsync()

Start a meeting.
java.util.concurrent.Future<java.lang.Void> unlockMeetingAsync()

Unlocks a meeting.
java.util.concurrent.Future<java.lang.Void> unmuteAllParticipantsAsync()

Unmute all other participants in the meeting.
java.util.concurrent.Future<java.lang.Void> unmuteParticipantAsync(String userId)

Unmute a participant.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

Meeting

protected Meeting(long handleValue)

Protected constructor.

Parameters:

handleValue - Internal meeting implementation

Method Details

addParticipantAsync

public Future addParticipantAsync(Participant participant)

Add a participant to a meeting using a participant object.

Parameters:

participant - A participant object.

Returns:

A task representing the asynchronous operation of adding a participant.

addParticipantAsync

public Future addParticipantAsync(User user)

Add a participant to a meeting using a user object.

Parameters:

user - A user object.

Returns:

A task representing the asynchronous operation of adding a participant.

addParticipantAsync

public Future addParticipantAsync(String userId)

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

Parameters:

userId - The user id.

Returns:

A task representing the asynchronous operation of adding a participant.

close

public void close()

Dispose of associated resources. Note: close() must be called in order to release underlying resources held by the object.

createMeetingAsync

public static Future createMeetingAsync(SpeechConfig speechConfig)

Initializes a new instance of Meeting.

Parameters:

speechConfig - speech configuration.

Returns:

A task representing the asynchronous operation that creates a meeting.

createMeetingAsync

public static Future createMeetingAsync(SpeechConfig speechConfig, String meetingId)

Initializes a new instance of Meeting.

Parameters:

speechConfig - speech configuration.
meetingId - a unqiue identification of your meeting.

Returns:

A task representing the asynchronous operation that creates a meeting.

deleteMeetingAsync

public Future deleteMeetingAsync()

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

Returns:

An asynchronous operation representing deleting a meeting.

dispose

protected void dispose(boolean disposing)

PROTECTED

Parameters:

disposing - PROTECTED

endMeetingAsync

public Future endMeetingAsync()

End a meeting.

Returns:

An empty task representing the asynchronous operation that ending a meeting.

getAuthorizationToken

public String getAuthorizationToken()

Gets the authorization token used to communicate with the service.

Returns:

Authorization token.

getImpl

public SafeHandle getImpl()

Returns the comversation implementation.

Returns:

The implementation of the meeting.

getMeetingId

public String getMeetingId()

Gets the meeting Id.

Returns:

the meeting Id.

getProperties

public PropertyCollection getProperties()

The collection of properties and their values defined for this meeting.

Returns:

The collection of properties and their values defined for this meeting.

lockMeetingAsync

public Future lockMeetingAsync()

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

Returns:

An asynchronous operation representing locking a meeting.

muteAllParticipantsAsync

public Future muteAllParticipantsAsync()

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.

Returns:

An asynchronous operation representing muting all participants.

muteParticipantAsync

public Future muteParticipantAsync(String userId)

Mute a participant.

Parameters:

userId - A user identifier.

Returns:

An asynchronous operation representing muting a particular participant.

removeParticipantAsync

public Future removeParticipantAsync(Participant participant)

Remove a participant from a meeting using a participant object.

Parameters:

participant - A participant object.

Returns:

Am empty task representing the asynchronous operation of removing a participant.

removeParticipantAsync

public Future removeParticipantAsync(User user)

Remove a participant from a meeting using a user object.

Parameters:

user - A user object.

Returns:

Am empty task representing the asynchronous operation of removing a participant.

removeParticipantAsync

public Future removeParticipantAsync(String userId)

Remove a participant from a meeting using a user id.

Parameters:

userId - A user id.

Returns:

Am empty task representing the asynchronous operation of removing a participant.

setAuthorizationToken

public void setAuthorizationToken(String token)

Sets the authorization token used to communicate with 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. Otherwise, the recognizer will encounter errors during recognition.

Parameters:

token - Authorization token.

startMeetingAsync

public Future startMeetingAsync()

Start a meeting.

Returns:

An asynchronous operation representing starting a meeting.

unlockMeetingAsync

public Future unlockMeetingAsync()

Unlocks a meeting.

Returns:

An asynchronous operation representing unlocking a meeting.

unmuteAllParticipantsAsync

public Future unmuteAllParticipantsAsync()

Unmute all other participants in the meeting.

Returns:

An asynchronous operation representing un-muting all participants.

unmuteParticipantAsync

public Future unmuteParticipantAsync(String userId)

Unmute a participant.

Parameters:

userId - A user identifier.

Returns:

An asynchronous operation representing un-muting a particular participant.

Applies to