Merge pull request #217 from opentok/v4.7.0-docs-edits

V4.7.0 docs edits

Author: SMadani

.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 commit = True
 tag = True
-current_version = 4.6.0
+current_version = 4.7.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?
 serialize = 
 	{major}.{minor}.{patch}

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 Vonage.
+Copyright (c) 2014-2022 Vonage.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -587,7 +587,7 @@ Reference documentation is available at
 ## Requirements
 
 You need an OpenTok API key and API secret, which you can obtain by logging into your
-[TokBox account](https://tokbox.com/account).
+[Vonage Video API account](https://tokbox.com/account).
 
 The OpenTok Java SDK requires JDK 8 or greater to compile. Runtime requires Java SE 8 or greater.
 This project is tested on both OpenJDK and Oracle implementations.

build.gradle

@@ -8,7 +8,7 @@ plugins {
 
 group = 'com.tokbox'
 archivesBaseName = 'opentok-server-sdk'
-version = '4.6.0'
+version = '4.7.0'
 
 sourceCompatibility = "1.8"
 targetCompatibility = "1.8"

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

@@ -8,27 +8,47 @@
 package com.opentok;
 
 /**
- * POJO for the 'hls' object node in the 'outputs' section of a Broadcast request's body.
+ * Represents HLS options for a live streaming broadcast. Pass this object
+ * into the {@link BroadcastProperties.Builder#hls()} method. It is returned by the
+ * {@link BroadcastProperties#hls()} method.
  */
 public class Hls {
 
 	private final boolean dvr;
 	private final boolean lowLatency;
 
+	/**
+	 * Used to create the Hls object.
+	 */
 	public static class Builder {
 		private boolean dvr = false;
 		private boolean lowLatency = false;
 
+		/**
+		 * Whether to enable
+		 * <a href="https://tokbox.com/developer/guides/broadcast/live-streaming/#dvr">DVR functionality</a> —
+		 * rewinding, pausing, and resuming — in players that support it (true), or not (false, the default).
+		 * With DVR enabled, the HLS URL will include a ?DVR query string appended to the end.
+		 */
 		public Builder dvr(boolean dvr) {
 			this.dvr = dvr;
 			return this;
 		}
 
+		/**
+		 * Whether to enable
+		 * <a href="https://tokbox.com/developer/guides/broadcast/live-streaming/#low-latency">low-latency mode</a>
+		 * for the HLSstream. Some HLS players do not support low-latency mode. This feature is incompatible
+		 * with DVR mode HLS broadcasts.
+		 */
 		public Builder lowLatency(boolean lowLatency) {
 			this.lowLatency = lowLatency;
 			return this;
 		}
 
+		/**
+		 * Builds the HLS object with the selected settings.
+		 */
 		public Hls build() {
 			return new Hls(this);
 		}
@@ -41,10 +61,20 @@ protected Hls(Builder builder) {
 		}
 	}
 
+	/**
+	 * Whether
+	 * <a href="https://tokbox.com/developer/guides/broadcast/live-streaming/#dvr">DVR functionality</a> —
+	 * rewinding, pausing, and resuming — is enabled in players that support it.
+	 */
 	public boolean dvr() {
 		return dvr;
 	}
 
+	/**
+	 * Whether
+	 * <a href="https://tokbox.com/developer/guides/broadcast/live-streaming/#low-latency">low-latency mode</a>
+	 * is enabled for the HLSstream. Some HLS players do not support low-latency mode.
+	 */
 	public boolean lowLatency() {
 		return lowLatency;
 	}

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

@@ -28,7 +28,7 @@
  * Contains methods for creating OpenTok sessions, generating tokens, and working with archives.
  * <p>
  * To create a new OpenTok object, call the OpenTok constructor with your OpenTok API key
- * and the API secret for your <a href="https://tokbox.com/account">TokBox account</a>. Do not publicly share
+ * and the API secret for your <a href="https://tokbox.com/account">Vonage Video API account</a>. Do not publicly share
  * your API secret. You will use it with the OpenTok constructor (only on your web
  * server) to create OpenTok sessions.
  * <p>
@@ -58,8 +58,8 @@ public class OpenTok {
     /**
      * Creates an OpenTok object.
      *
-     * @param apiKey Your OpenTok API key. (See your <a href="https://tokbox.com/account">TokBox account page</a>.)
-     * @param apiSecret Your OpenTok API secret. (See your <a href="https://tokbox.com/account">TokBox account page</a>.)
+     * @param apiKey Your OpenTok API key. (See your <a href="https://tokbox.com/account">Vonage Video API account page</a>.)
+     * @param apiSecret Your OpenTok API secret. (See your <a href="https://tokbox.com/account">Vonage Video API account page</a>.)
      */
     public OpenTok(int apiKey, String apiSecret) {
         this.apiKey = apiKey;
@@ -107,7 +107,7 @@ private OpenTok(int apiKey, String apiSecret, HttpClient httpClient) {
      * }
      * </pre>
      * <p>
-     * For testing, you can also generate tokens by logging in to your <a href="https://tokbox.com/account">TokBox account</a>.
+     * For testing, you can also generate tokens by logging in to your <a href="https://tokbox.com/account">Vonage Video API account</a>.
      *
      * @param sessionId The session ID corresponding to the session to which the user will connect.
      *
@@ -224,7 +224,7 @@ public String generateToken(String sessionId) throws OpenTokException {
      *
      * You can also create a session using the <a href="http://www.tokbox.com/opentok/api/#session_id_production">OpenTok
      * REST API</a> or or by logging in to your
-     * <a href="https://tokbox.com/account">TokBox account</a>.
+     * <a href="https://tokbox.com/account">Vonage Video API account</a>.
      *
      * @param properties This SessionProperties object defines options for the session.
      * These include the following:

src/main/java/com/opentok/constants/Version.java

@@ -8,5 +8,5 @@
 package com.opentok.constants;
 
 public class Version {
-    public static final String VERSION = "4.6.0";
+    public static final String VERSION = "4.7.0";
 }