Merge pull request #214 from opentok/hls-dvr

Added HLS parameter to Broadcast request

Author: Mofizur Rahman

src/main/java/com/opentok/Broadcast.java

@@ -85,7 +85,6 @@ public String getSessionId() {
         return sessionId;
     }
 
-
     /**
      * The OpenTok API key associated with the broadcast.
      */
@@ -99,12 +98,14 @@ public int getProjectId() {
     public long getCreatedAt() {
         return createdAt;
     }
+
     /**
      * The time at which the broadcast was updated, in milliseconds since the Unix epoch.
      */
     public long getUpdatedAt() {
         return updatedAt;
     }
+
     /**
      * The broadcast resolution.
      */
@@ -118,6 +119,7 @@ public String getResolution() {
     public String getStatus() {
         return status;
     }
+
     /**
      * Details on the HLS and RTMP broadcast streams. For an HLS stream, the URL is provided.
      * See the <a href="https://tokbox.com/developer/guides/broadcast/live-streaming/">OpenTok
@@ -140,18 +142,21 @@ private void unpack(Map<String,Object> broadcastUrls) {
             this.rtmpList.add(rtmp);
         }
     }
+
     /**
      * The HLS URL (if there is one) of the broadcast.
      */
     public String getHls() {
         return hls;
     }
+
     /**
     * A list of RTMP URLs (if there are any) of the broadcast.
      */
     public List<Rtmp> getRtmpList() {
         return rtmpList;
     }
+
     @Override
     public String toString() {
         try {

src/main/java/com/opentok/BroadcastProperties.java

@@ -24,14 +24,15 @@ public class BroadcastProperties {
     private int maxDuration;
     private boolean hasHls;
     private List<RtmpProperties> rtmpList;
-    private String resolution = null;
+    private String resolution;
     private StreamMode streamMode;
-
+    private Hls hls;
 
     private BroadcastProperties(Builder builder) {
         this.layout = builder.layout;
         this.maxDuration = builder.maxDuration;
         this.hasHls = builder.hasHls;
+        this.hls = builder.hls;
         this.rtmpList = builder.rtmpList;
         this.resolution = builder.resolution;
         this.streamMode = builder.streamMode;
@@ -46,6 +47,8 @@ public static class Builder {
         private BroadcastLayout layout = new BroadcastLayout(BroadcastLayout.Type.BESTFIT);
         private int maxDuration = 7200;
         private boolean hasHls = false;
+
+        private Hls hls;
         private List<RtmpProperties> rtmpList = new ArrayList<>();
         private String resolution = "640x480";
         private StreamMode streamMode = StreamMode.AUTO;
@@ -72,7 +75,7 @@ public Builder layout(BroadcastLayout layout){
          * @return The BroadcastProperties.Builder object with the maxDuration setting.
          */
         public Builder maxDuration(int maxDuration)  throws InvalidArgumentException {
-            if(maxDuration < 60 || maxDuration > 36000) {
+            if (maxDuration < 60 || maxDuration > 36000) {
                 throw new InvalidArgumentException("maxDuration value must be between 60 and 36000 (inclusive).");
             }
             this.maxDuration = maxDuration;
@@ -90,6 +93,18 @@ public Builder hasHls(boolean hasHls) {
             this.hasHls = hasHls;
             return this;
         }
+
+        /**
+         * Call this method to include HLS options. This will set <code>hasHls</code> to <code>true</code>.
+         *
+         * @param hls The HLS object.
+         *
+         * @return The BroadcastProperties.Builder object with HLS populated.
+         */
+        public Builder hls(Hls hls) {
+            return hasHls((this.hls = hls) != null);
+        }
+
         /**
          * Call this method to set a list of RTMP broadcast streams. There is a limit of
          * 5 RTMP streams.
@@ -109,7 +124,8 @@ public Builder addRtmpProperties (RtmpProperties rtmpProps) throws InvalidArgume
         /**
          * Sets the resolution of the broadcast stream.
          *
-         * @param resolution The resolution of the broadcast, either "640x480" (SD, the default) or "1280x720" (HD).
+         * @param resolution The resolution of the broadcast, either "640x480" (SD, the default),
+         *                  "1280x720" (HD) or "1920x1080" (FHD).
          *
          * @return The BroadcastProperties.Builder object with the resolution setting.
          */
@@ -158,6 +174,7 @@ public BroadcastProperties build() {
     public BroadcastLayout layout() {
         return layout;
     }
+
     /**
      * The maximum duration in seconds of the broadcast.
      */
@@ -172,10 +189,17 @@ public boolean hasHls() {
         return hasHls;
     }
 
+    /**
+     * The HLS configuration object, or <code>null</code> if {@link BroadcastProperties#hasHls} is false.
+     */
+    public Hls hls() {
+        return hls;
+    }
+
     /**
      * Returns the RtmpProperties list.
      */
-    public List<RtmpProperties> getRtmpList() {
+    public List<RtmpProperties> rtmpList() {
         return rtmpList;
     }
     /**

src/main/java/com/opentok/Hls.java

@@ -0,0 +1,51 @@
+/**
+ * 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;
+
+/**
+ * POJO for the 'hls' object node in the 'outputs' section of a Broadcast request's body.
+ */
+public class Hls {
+
+	private final boolean dvr;
+	private final boolean lowLatency;
+
+	public static class Builder {
+		private boolean dvr = false;
+		private boolean lowLatency = false;
+
+		public Builder dvr(boolean dvr) {
+			this.dvr = dvr;
+			return this;
+		}
+
+		public Builder lowLatency(boolean lowLatency) {
+			this.lowLatency = lowLatency;
+			return this;
+		}
+
+		public Hls build() {
+			return new Hls(this);
+		}
+	}
+
+	protected Hls(Builder builder) {
+		// Non-short-circuiting for setter
+		if ((this.dvr = builder.dvr) & (this.lowLatency = builder.lowLatency)) {
+			throw new IllegalArgumentException("Cannot set both dvr and lowLatency on HLS");
+		}
+	}
+
+	public boolean dvr() {
+		return dvr;
+	}
+
+	public boolean lowLatency() {
+		return lowLatency;
+	}
+}

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

@@ -123,8 +123,8 @@ private OpenTok(int apiKey, String apiSecret, HttpClient httpClient) {
      * @return The token string.
      */
     public String generateToken(String sessionId, TokenOptions tokenOptions) throws OpenTokException {
-        List<String> sessionIdParts = null;
-        if (sessionId == null || sessionId == "") {
+        List<String> sessionIdParts;
+        if (sessionId == null || sessionId.isEmpty()) {
             throw new InvalidArgumentException("Session not valid");
         }
 
@@ -582,14 +582,13 @@ public void setArchiveLayout(String archiveId, ArchiveProperties properties) thr
      * including the broadcast ID.
      */
     public Broadcast startBroadcast(String sessionId, BroadcastProperties properties) throws OpenTokException {
-        if (StringUtils.isEmpty(sessionId) || (properties == null)) {
+        if (StringUtils.isEmpty(sessionId) || properties == null) {
             throw new InvalidArgumentException("Session not valid or broadcast properties is null");
         }
 
         String broadcast = client.startBroadcast(sessionId, properties);
         try {
-            return broadcastReader.readValue(
-                    broadcast);
+            return broadcastReader.readValue(broadcast);
         } catch (Exception e) {
             throw new RequestException("Exception mapping json: " + e.getMessage());
         }

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

@@ -526,7 +526,7 @@ public String startBroadcast(String sessionId, BroadcastProperties properties)
         ObjectNode requestJson = nodeFactory.objectNode();
         requestJson.put("sessionId", sessionId);
         requestJson.put("streamMode", properties.streamMode().toString());
-        if(properties.layout() != null) {
+        if (properties.layout() != null) {
             ObjectNode layout = requestJson.putObject("layout");
             screenshareType = properties.layout().getScreenshareType();
             String type = properties.layout().getType().toString();
@@ -549,10 +549,16 @@ public String startBroadcast(String sessionId, BroadcastProperties properties)
         }
         ObjectNode outputs = requestJson.putObject("outputs");
         if (properties.hasHls()) {
-            outputs.set("hls", nodeFactory.objectNode());
+            ObjectNode hlsNode = nodeFactory.objectNode();
+            outputs.set("hls", hlsNode);
+            Hls hlsPojo = properties.hls();
+            if (hlsPojo != null) {
+                hlsNode.put("dvr", hlsPojo.dvr());
+                hlsNode.put("lowLatency", hlsPojo.lowLatency());
+            }
         }
         ArrayNode rtmp = outputs.putArray("rtmp");
-        for (RtmpProperties prop : properties.getRtmpList()) {
+        for (RtmpProperties prop : properties.rtmpList()) {
             ObjectNode rtmpProps = nodeFactory.objectNode();
             rtmpProps.put("id", prop.id());
             rtmpProps.put("serverUrl", prop.serverUrl());