jitsi-meet-dev

While the moderator can mute a participant, they cannot unmute the participant due to privacy concerns. Enhancement is required to unmute the remote user. In this project, we will explain how we can add silence feature to the Jitsi-meet project. The repositories that have been modified in the Jitsi Meet project are listed below.

• 1. jicofo repository
• 2. jitsi-meet repository
  • 2.1 Create Unmute Button Component
  • 2.2 Create Unmute Button Dialog Component
  • 2.3 Controls of Unmute
• 3. lib-jitsi-meet repository
• 4. lib-jitsi-meet repository

1. jicofo repository

• You can clone the repository the change was made.

  apt install maven
  git clone --branch mute-unmute [email protected]:bayraktarulku/jicofo.git
  cd jicofo
  mvn package -DskipTests -Dassembly.skipAssembly=false
  mvn install
  unzip target/jicofo-1.1-SNAPSHOT-archive.zip
  cp jicofo-1.1-SNAPSHOT/jicofo.jar /usr/share/jicofo/
  /etc/init.d/jicofo restart && /etc/init.d/jitsi-videobridge2 restart && /etc/init.d/prosody restart
  cd ../
  

• if you want to do the processing steps yourself

  Conference focus is mandatory component of Jitsi Meet conferencing system next to the videobridge. To make changes to Jicofo, follow the steps below.

  • First of all, clone jicofo locally or fork it.

    apt install maven
    git clone https://github.com/jitsi/jicofo.git
    cd jicofo
    

  • Inside the cloned jicofo project, there are the following folders and files;

    • checkstyle.xml
    • debian
    • doc
    • lib
    • LICENSE
    • pom.xml
    • README.md
    • resources
    • script
    • SECURITY.md
    • src

  • To make changes to the JitsiMeetConferenceImpl.java file in the project, go to the location of the file and make the following changes.

  • Edit the following code block in file JitsiMeetConferenceImpl.java. Remove this condition or comment JitsiMeetConferenceImpl.java

    // do not allow unmuting other participants even for the moderator
    // if (!doMute && !fromJid.equals(toBeMutedJid))
    // {
    //    logger.warn("Blocking an unmute request (jid not the same).");
    //    return false;
    // }
    

  • Go to the directory where the pom.xml file is located and perform the mvn install process to create the new jar files.

    cd ~/jicofo
    mvn package -DskipTests -Dassembly.skipAssembly=false
    mvn install
    

  • A target folder will be created after mvn install. Inside this folder are zip file that we will use as compressed.

    • archive-tmp
    • checkstyle-checker.xml
    • classes
    • generated-test-sources
    • jicofo-1.1-SNAPSHOT.jar
    • maven-archiver
    • surefire-reports
    • checkstyle-cachefile
    • checkstyle-result.xml
    • generated-sources
    • jicofo-1.1-SNAPSHOT-archive.zip
    • jicofo-1.1-SNAPSHOT-jar-with-dependencies.jar
    • maven-status
    • test-classes

  • We need to replace our new jar file with the old jicofo.jar file.

    unzip target/jicofo-1.1-SNAPSHOT-archive.zip
    cp jicofo-1.1-SNAPSHOT/jicofo.jar /usr/share/jicofo/
    

  • To restart services after changes;

    /etc/init.d/jicofo restart && /etc/init.d/jitsi-videobridge2 restart && /etc/init.d/prosody restart

  • In order to monitor Jicofo logs;

    tail -f /var/log/jitsi/jicofo.log

2. jitsi-meet repository

• You can clone the repository the change was made.

  git clone --branch mute-unmute [email protected]:bayraktarulku/jitsi-meet.git
  

• For files and information updated in the repository or if you want to make changes yourself; You can follow the steps below.

2.1 Create Unmute Button Component

• First, the unmute feature has been added to the participant's options menu.

  • UnMuteButton && AbstractUnMuteButton classes created

    • UnMuteButton.js
    • AbstractUnMuteButton.js

  • Export UnMuteButton Component -> index.js

    export { default as UnMuteButton } from './UnMuteButton';
    export { default as UnMuteRemoteParticipantDialog }
    from './UnMuteRemoteParticipantDialog';
    

  • UnMuteButton Component added to remoteVideoOptionsMenu -> RemoteVideoMenuTriggerButton.js

    • UnMuteButton added import list

    import {
        GrantModeratorButton,
        MuteButton,
        UnMuteButton,
        MuteEveryoneElseButton,
        KickButton,
        PrivateMessageMenuButton,
        RemoteControlButton,
        RemoteVideoMenu,
        VolumeSlider
    } from './';
    

    • added UnMuteButton component to moderator (_renderRemoteVideoMenu() -> if(_isModerator))

    buttons.push(
        <UnMuteButton
            isAudioMuted = { _isAudioMuted }
            key = 'unmute'
            participantID = { participantID } />
    );
    

2.2 Create Unmute Button Dialog Component

• Create AbstractUnMuteRemoteParticipantDialog. Then include it in the UnMuteRemoteParticipantDialog class -> AbstractUnMuteRemoteParticipantDialog.js && UnMuteRemoteParticipantDialog.js

  class UnMuteRemoteParticipantDialog extends AbstractUnMuteRemoteParticipantDialog {
      /**
          * Implements React's {@link Component#render()}.
          *
          * @inheritdoc
          * @returns {ReactElement}
          */
      render() {
          return (
              <Dialog
                  okKey = 'dialog.unMuteParticipantButton'
                  onSubmit = { this._onSubmit }
                  titleKey = 'dialog.unMuteParticipantTitle'
                  width = 'small'>
                  <div>
                      { this.props.t('dialog.unMuteParticipantBody') }
                  </div>
              </Dialog>
          );
      }
  
      _onSubmit: () => boolean;
  }
  

2.3 Controls of Unmute

• Method created for unmute option unMuteRemoteParticipant imported -> actions.js

  import {
      unMuteRemoteParticipant
  } from '../base/participants';
  

  export function unMuteRemote(participantId: string) {
      return (dispatch: Dispatch<any>) => {
          sendAnalytics(createRemoteMuteConfirmedEvent(participantId));
          dispatch(unMuteRemoteParticipant(participantId));
      };
  }
  

• Added const variable -> UNMUTE_REMOTE_PARTICIPANT -> actionTypes.js

  export const UNMUTE_REMOTE_PARTICIPANT = 'UNMUTE_REMOTE_PARTICIPANT';
  

• This option import list added -> actions.js

  import {
      UNMUTE_REMOTE_PARTICIPANT,
  }
  

  export function unMuteRemoteParticipant(id) {
      return {
          type: UNMUTE_REMOTE_PARTICIPANT,
          id
      };
  }
  

• Created new case (UNMUTE_REMOTE_PARTICIPANT) -> middleware.js

  import {
      UNMUTE_REMOTE_PARTICIPANT,
  }
  

  case UNMUTE_REMOTE_PARTICIPANT: {
      const { conference } = store.getState()['features/base/conference'];
      conference.unMuteParticipant(action.id);
      break;
  }
  

3. lib-jitsi-meet repository

• You can clone the repository the change was made.

  git clone --branch mute-unmute [email protected]:bayraktarulku/lib-jitsi-meet
  

• For files and information updated in the repository or if you want to make changes yourself; You can follow the steps below.

• Added new event for AUDIO_UNMUTED_BY_FOCUS -> XMPPEvents.js

  AUDIO_UNMUTED_BY_FOCUS: 'xmpp.audio_unmuted_by_focus'
  

• Created event listener for AUDIO_UNMUTED_BY_FOCUS -> JitsiConferenceEventManager.js

  chatRoom.addListener(XMPPEvents.AUDIO_UNMUTED_BY_FOCUS,
      actor => {
          // TODO: Add a way to differentiate between commands which caused
          // us to mute and those that did not change our state (i.e. we were
          // already muted).
          Statistics.sendAnalytics(createRemotelyMutedEvent());
  
         // conference.mutedByFocusActor = actor;
  
          // set isMutedByFocus when setAudioMute Promise ends
          conference.rtc.setAudioMute(false).then(
              () => {
                  conference.isMutedByFocus = false;
                  conference.mutedByFocusActor = null;
              })
              .catch(
                  error => {
                      conference.mutedByFocusActor = null;
                      logger.warn(
                          'Error while audio unmuting due to focus request', error);
              });
      }
  );
  

• Added prototype for unMuteParticipant -> JitsiConference.js

  JitsiConference.prototype.unMuteParticipant = function(id) {
      const participant = this.getParticipantById(id);
  
      if (!participant) {
          return;
      }
      this.room.muteParticipant(participant.getJid(), false);
  };
  

• Added else if condition for unmute status -> ChatRoom.js

  onMute(iq) {
      const from = iq.getAttribute('from');
      if (from !== this.focusMucJid) {
          logger.warn('Ignored mute from non focus peer');
  
          return;
      }
      const mute = $(iq).find('mute');
      if (mute.length && mute.text() === 'true') {
          this.eventEmitter.emit(XMPPEvents.AUDIO_MUTED_BY_FOCUS, mute.attr('actor'));
      } else if (mute.length && mute.text() === 'false') { // added unmute condition
      this.eventEmitter.emit(XMPPEvents.AUDIO_UNMUTED_BY_FOCUS, mute.attr('actor'));
      } else {
              // XXX Why do we support anything but muting? Why do we encode the
              // value in the text of the element? Why do we use a separate XML
              // namespace?
              logger.warn('Ignoring a mute request which does not explicitly '
                  - 'specify a positive mute command.');
      }
  }
  

4. Changing variable values

As you can see, the moderator can now unmute the participant. In this case, you need to fix the alert that you cannot unmute the participant while muting. -> Main.json

"muteParticipantBody": "You can unmute the participant whenever you want.",
"muteParticipantButton": "Mute",
"muteParticipantDialog": "Are you sure you want to mute this participant?",
"muteParticipantTitle": "Mute this participant?",

"unMuteParticipantBody": "You can mute the participant whenever you want",
"unMuteParticipantButton": "Unmute",
"unMuteParticipantDialog": "Are you sure you want to unmute this participant?",
"unMuteParticipantTitle": "Unmute this participant?",

Old mute-participant-dialog	New mute-participant-dialog

The unmute button is in the options in the picture below.

Version information used in this repo

Contributors

• Seda Çağlar
• Kübra Yavuz
• Gülistan Dalbudak