Merge pull request #207 from opentok/feature/sip-video-flag

[WIP DEVX-5641, 5660] add video flag to sip properties

Author: pardel

src/main/java/com/opentok/SipProperties.java

@@ -20,6 +20,8 @@ public class SipProperties {
     private String password = null;
     private String headersJsonStartingWithXDash = null;
     private Boolean secure = false;
+    private Boolean video = false;
+    private Boolean observeForceMute = false;
 
     private SipProperties(Builder builder) {
         this.sipUri = builder.sipUri;
@@ -28,6 +30,8 @@ private SipProperties(Builder builder) {
         this.password = builder.password;
         this.headersJsonStartingWithXDash = builder.headersJsonStartingWithXDash;
         this.secure = builder.secure;
+        this.video = builder.video;
+        this.observeForceMute = builder.observeForceMute;
     }
 
     /**
@@ -42,6 +46,8 @@ public static class Builder {
         private String password = null;
         private String headersJsonStartingWithXDash = null;
         private boolean secure = false;
+        private boolean video = false;
+        private boolean observeForceMute = false;
 
 
         /**
@@ -60,6 +66,7 @@ public Builder sipUri(String sipUri) {
             this.sipUri = sipUri;
             return this;
         }
+
         /**
          * Call this method to set the SIP <code>from</code> field (optional).
          *
@@ -76,6 +83,7 @@ public Builder from(String from) {
             this.from = from;
             return this;
         }
+
         /**
          * Call this method to set the username for the SIP gateway provider (optional).
          *
@@ -99,6 +107,7 @@ public Builder password(String password) {
             this.password = password;
             return this;
         }
+
         /**
          * Call this method to define custom headers to be added to the SIP ​INVITE​
          * initiated from OpenTok to the your SIP platform.
@@ -114,6 +123,7 @@ public Builder headersJsonStartingWithXDash(String headersJsonStartingWithXDash)
             this.headersJsonStartingWithXDash = headersJsonStartingWithXDash;
             return this;
         }
+
         /**
          * Call this method and pass in <code>true</code> to indicate that the media
          * must be transmitted encrypted. Pass in <code>false​</code>, the default, if encryption
@@ -128,6 +138,34 @@ public Builder secure(boolean secure) {
             this.secure = secure;
             return this;
         }
+
+        /**
+         * Call this method and pass in <code>true</code> to enable video in the SIP call.
+         * The default is <code>false</code>.
+         *
+         * @param video Whether video should be enabled in the SIP call.
+         *
+         * @return The SipProperties.Builder object with the SIP video setting.
+         */
+        public Builder video(boolean video) {
+            this.video = video;
+            return this;
+        }
+
+        /**
+         * Call this method and pass in <code>true</code> to have the SIP end point observe
+         * <a href="https://tokbox.com/developer/guides/moderation/#force_mute">force mute moderation</a>.
+         * The default is <code>false</code>.
+         *
+         * @param observeForceMute Whether to observe force mute moderation.
+         *
+         * @return The SipProperties.Builder object with the observeForceMute setting.
+         */
+        public Builder observeForceMute(boolean observeForceMute) {
+            this.observeForceMute = observeForceMute;
+            return this;
+        }
+
         /**
          * Builds the SipProperties object.
          *
@@ -137,18 +175,21 @@ public SipProperties build() {
             return new SipProperties(this);
         }
     }
+
     /**
      * Returns the SIP URI.
      */
     public String sipUri() {
         return sipUri;
     }
+
     /**
      * Returns the from value.
      */
     public String from() {
         return from;
     }
+
     /**
      * Returns the user name.
      */
@@ -169,10 +210,21 @@ public String password() {
     public String headersJsonStartingWithXDash() {
         return headersJsonStartingWithXDash;
     }
+
     /**
      *  Returns the secure value (<code>true</code> or <code>false</code>).
      */
     public boolean secure() {
         return secure;
     }
+
+    /**
+     * Return the video value (<code>true</code> or <code>false</code>).
+     */
+    public boolean video() { return video; }
+
+    /**
+     * Returns the observeForceMute value (<code>true</code> or <code>false</code>).
+     */
+    public boolean observeForceMute() { return observeForceMute; }
 }

src/main/java/com/opentok/util/HttpClient.java

@@ -737,6 +737,12 @@ public String sipDial(String sessionId, String token, SipProperties props) throw
             jGenerator.writeFieldName("secure");
             jGenerator.writeBoolean(props.secure());
 
+            jGenerator.writeFieldName("video");
+            jGenerator.writeBoolean(props.video());
+
+            jGenerator.writeFieldName("observeForceMute");
+            jGenerator.writeBoolean(props.observeForceMute());
+
             jGenerator.writeEndObject();      // end sip
             jGenerator.writeEndObject();      // end main object
             jGenerator.close();