Class Meeting

  • All Implemented Interfaces:
    AutoCloseable

    public final class Meeting
    extends Object
    implements 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 Detail

      • Meeting

        protected Meeting​(long handleValue)
        Protected constructor.
        Parameters:
        handleValue - Internal meeting implementation
    • Method Detail

      • createMeetingAsync

        public static Future<Meeting> 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<Meeting> 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.
      • close

        public void close()
        Dispose of associated resources. Note: close() must be called in order to release underlying resources held by the object.
        Specified by:
        close in interface AutoCloseable
      • getMeetingId

        public String getMeetingId()
        Gets the meeting Id.
        Returns:
        the meeting Id.
      • 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.
      • getAuthorizationToken

        public String getAuthorizationToken()
        Gets the authorization token used to communicate with the service.
        Returns:
        Authorization token.
      • 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.
      • addParticipantAsync

        public Future<Participant> 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<Participant> 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.
      • addParticipantAsync

        public Future<User> 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.
      • removeParticipantAsync

        public Future<Void> 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<Void> 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<Void> 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.
      • endMeetingAsync

        public Future<Void> endMeetingAsync()
        End a meeting.
        Returns:
        An empty task representing the asynchronous operation that ending a meeting.
      • startMeetingAsync

        public Future<Void> startMeetingAsync()
        Start a meeting.
        Returns:
        An asynchronous operation representing starting a meeting.
      • deleteMeetingAsync

        public Future<Void> deleteMeetingAsync()
        Delete a meeting. After this no one will be able to join the meeting.
        Returns:
        An asynchronous operation representing deleting a meeting.
      • lockMeetingAsync

        public Future<Void> lockMeetingAsync()
        Lock a meeting. This will prevent new participants from joining.
        Returns:
        An asynchronous operation representing locking a meeting.
      • unlockMeetingAsync

        public Future<Void> unlockMeetingAsync()
        Unlocks a meeting.
        Returns:
        An asynchronous operation representing unlocking a meeting.
      • muteAllParticipantsAsync

        public Future<Void> 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.
      • unmuteAllParticipantsAsync

        public Future<Void> unmuteAllParticipantsAsync()
        Unmute all other participants in the meeting.
        Returns:
        An asynchronous operation representing un-muting all participants.
      • muteParticipantAsync

        public Future<Void> muteParticipantAsync​(String userId)
        Mute a participant.
        Parameters:
        userId - A user identifier.
        Returns:
        An asynchronous operation representing muting a particular participant.
      • unmuteParticipantAsync

        public Future<Void> unmuteParticipantAsync​(String userId)
        Unmute a participant.
        Parameters:
        userId - A user identifier.
        Returns:
        An asynchronous operation representing un-muting a particular participant.
      • getImpl

        public SafeHandle getImpl()
        Returns the comversation implementation.
        Returns:
        The implementation of the meeting.
      • dispose

        protected void dispose​(boolean disposing)
        PROTECTED
        Parameters:
        disposing - PROTECTED