DEVX-5442 Add forceMuteStream and forceMuteAll (#205)

* add muteall feature and unit test

* add license for MuteAllProperties

* add javadoc for MuteAllProperties

* Docs edits

* update muteall streamid

* Update src/main/java/com/opentok/MuteAllProperties.java

Co-authored-by: Jeff Swartz <jeff.swartz@vonage.com>

* Update src/main/java/com/opentok/OpenTok.java

Co-authored-by: Jeff Swartz <jeff.swartz@vonage.com>

* add active in MuteAllProperties

* remove active flag

add active = false in forceMuteAll
add active = true in disableForceMute

* Docs edits for fore mute API

* update license year

* optimize imports

Co-authored-by: Paul Ardeleanu <paul.ardeleanu@vonage.com>
Co-authored-by: Jeff Swartz <jeff.swartz@vonage.com>

Author: 3 people

README.md

@@ -5,16 +5,17 @@
 
 <img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />
 
-The OpenTok Java SDK lets you generate
-[sessions](https://tokbox.com/developer/guides/create-session/) and
-[tokens](https://tokbox.com/developer/guides/create-token/) for
-[OpenTok](http://www.tokbox.com/) applications that run on the JVM. It also includes methods for
-working with OpenTok [archives](https://tokbox.com/developer/guides/archiving),
-working with OpenTok [live streaming
-broadcasts](https://tokbox.com/developer/guides/broadcast/live-streaming/),
-working with OpenTok [SIP interconnect](https://tokbox.com/developer/guides/sip),
-[signaling OpenTok sessions from the server](https://tokbox.com/developer/guides/signaling/),
-and [disconnecting clients from sessions](https://tokbox.com/developer/guides/moderation/rest/).
+The OpenTok Java SDK provides methods for:
+
+* Generating [sessions](https://tokbox.com/developer/guides/create-session/) and
+  [tokens](https://tokbox.com/developer/guides/create-token/) for
+  [OpenTok](https://www.vonage.com/communications-apis/video/) applications
+* Working with OpenTok [archives](https://tokbox.com/developer/guides/archiving)
+* Working with OpenTok [live streaming broadcasts](https://tokbox.com/developer/guides/broadcast/live-streaming/)
+* Working with OpenTok [SIP interconnect](https://tokbox.com/developer/guides/sip)
+* [Sending signals to clients connected to a session](https://tokbox.com/developer/guides/signaling/)
+* [Disconnecting clients from sessions](https://tokbox.com/developer/guides/moderation/rest/)
+* [Forcing clients in a session to disconnect or mute published audio](https://tokbox.com/developer/guides/moderation/)
 
 ## Installation
 
@@ -366,6 +367,19 @@ The `connectionId` parameter is used to specify the connection ID of a client co
 
 For more information on the force disconnect functionality and exception codes, please see the [REST API documentation](https://tokbox.com/developer/rest/#forceDisconnect).
 
+### Forcing clients in a session to mute published audio
+
+You can force the publisher of a specific stream to stop publishing audio using the 
+`Opentok.forceMuteStream(String sessionId, String streamId)`method.
+
+You can force the publisher of all streams in a session (except for an optional list of streams)
+to stop publishing audio using the `Opentok.forceMuteAll(String sessionId, MuteAllProperties properties)`
+method. You can then disable the mute state of the session by calling the
+`Opentok.disableForceMute(String sessionId)` method.
+
+For more information, see
+[Muting the audio of streams in a session](https://tokbox.com/developer/guides/moderation/#force_mute).
+
 ### Signaling
 
 You can send signals to all the connections in a session or to a specific connection:

src/main/java/com/opentok/MuteAllProperties.java

@@ -0,0 +1,67 @@
+/**
+ * OpenTok Java SDK
+ * Copyright (C) 2022 Vonage.
+ * http://www.tokbox.com
+ *
+ * Licensed under The MIT License (MIT). See LICENSE file for more information.
+ */
+package com.opentok;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+/**
+ * Defines values for the <code>properties</code> parameter of the
+ * {@link OpenTok#forceMuteAll(String, MuteAllProperties)} method.
+ *
+ * @see OpenTok#forceMuteAll(String, MuteAllProperties)
+ */
+public class MuteAllProperties {
+    private List<String> excludedStreamIds;
+
+    private MuteAllProperties(MuteAllProperties.Builder builder) {
+        this.excludedStreamIds = builder.excludedStreamIds;
+    }
+
+    /**
+     * Use this class to create a MuteAllProperties object.
+     *
+     * @see MuteAllProperties
+     */
+    public static class Builder {
+        private List<String> excludedStreamIds = new ArrayList<>();
+
+        /**
+         * Call this method to add a List of stream IDs for streams to be excluded
+         * from the force mute action.
+         *
+         * @param ids The List of stream IDs.
+         *
+         * @return The MuteAllProperties.Builder object with excludedStreamIds list.
+         */
+        public MuteAllProperties.Builder excludedStreamIds(List<String> ids) {
+            this.excludedStreamIds.addAll(ids);
+            return this;
+        }
+
+        /**
+         * Builds the MuteAllProperties object.
+         *
+         * @return The MuteAllProperties object.
+         */
+        public MuteAllProperties build() {
+            return new MuteAllProperties(this);
+        }
+    }
+
+    /**
+     * Returns the excludedStreams list. This is a list of stream IDs for
+     * streams to be excluded from the force mute action.
+     *
+     * @return The list of stream IDs.
+     */
+    public List<String> getExcludedStreamIds() {
+        return this.excludedStreamIds;
+    }
+}