feat: Add bidirectional flag to video (#597)

Author: dragonmantank

CHANGELOG.md

@@ -2,6 +2,9 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+# [9.4.0] - 2025-08-22
+- Added `bidirectional` flag for websockets to support the new Bi-Directional Audio Connector
+
 # [9.3.1] - 2025-05-08
 - Fixed `CustomClient` return type validation (normalise to `Void` if unknown)
 - Deprecated Verify v1, SIM Swap and Number Verification APIs

CONTRIBUTORS.md

@@ -36,4 +36,5 @@ documentation, or tests are eligible to be added to this list.
 - Ilya Golovin ([@ilgo0413](https://github.com/ilgo0413))
 - Joakim Waltersson ([@jwalter](https://github.com/jwalter))
 - Mofi Rahman ([@moficodes](https://github.com/moficodes))
-- Sina Madani ([@SMadani](https://github.com/SMadani))
+- Sina Madani ([@SMadani](https://github.com/SMadani))
+- Chris Tankersley ([#dragonmantank](https://github.com/dragonmantank))

src/main/java/com/vonage/client/video/ConnectRequest.java

@@ -62,6 +62,18 @@ public static final class Builder extends AbstractSessionTokenRequest.Builder<Co
         Collection<String> streams;
         Map<String, String> headers;
         Websocket.AudioRate audioRate;
+        Boolean bidirectional;
+        /**
+         * (OPTIONAL)
+         * Whether the websocket is bidirectional.
+         *
+         * @param bidirectional True for bidirectional, false for unidirectional.
+         * @return This builder.
+         */
+        public Builder bidirectional(Boolean bidirectional) {
+            this.bidirectional = bidirectional;
+            return this;
+        }
 
         private Builder() {
         }

src/main/java/com/vonage/client/video/Websocket.java

@@ -32,6 +32,7 @@ public final class Websocket extends JsonableBaseObject {
     private Collection<String> streams;
     private Map<String, String> headers;
     private AudioRate audioRate;
+    private Boolean bidirectional;
 
     Websocket() {}
 
@@ -48,6 +49,7 @@ public final class Websocket extends JsonableBaseObject {
         }
         headers = builder.headers;
         audioRate = builder.audioRate;
+        bidirectional = builder.bidirectional;
     }
 
     /**
@@ -60,6 +62,16 @@ public URI getUri() {
         return uri;
     }
 
+    /**
+     * Whether the websocket is bidirectional (optional).
+     *
+     * @return True if bidirectional, false if not, or null if not set.
+     */
+    @JsonProperty("bidirectional")
+    public Boolean getBidirectional() {
+        return bidirectional;
+    }
+
     /**
      * Stream IDs for the Vonage Video streams you want to include in the WebSocket audio.
      * If you omitted, all streams in the session will be included.

src/test/java/com/vonage/client/video/ConnectRequestTest.java

@@ -29,35 +29,39 @@ public class ConnectRequestTest {
 
 	@Test
 	public void testSerializeAllParams() {
-		var request = ConnectRequest.builder()
+		ConnectRequest request = ConnectRequest.builder()
 				.token(token).uri(uri).sessionId(sessionId)
 				.streams(Collections.singleton(VideoClientTest.randomId))
 				.audioRate(AudioRate.L16_16K)
-				.headers(Map.of("k1", "v1")).build();
+				.headers(Map.of("k1", "v1"))
+				.bidirectional(true)
+				.build();
 
-		var expectedJson = "{\"sessionId\":\""+sessionId+"\",\"token\":\""+token+"\",\"websocket\":{\"uri\":\"" +
-				uri+"\",\"streams\":[\""+randomId+"\"],\"headers\":{\"k1\":\"v1\"},\"audioRate\":16000}}";
+		String expectedJson = "{\"sessionId\":\""+sessionId+"\",\"token\":\""+token+"\",\"websocket\":{\"uri\":\"" +
+				uri+"\",\"streams\":[\""+randomId+"\"],\"headers\":{\"k1\":\"v1\"},\"audioRate\":16000,\"bidirectional\":true}}";
 
 		assertEquals(expectedJson, request.toJson());
 		testJsonableBaseObject(request);
+		assertEquals(Boolean.TRUE, request.getWebsocket().getBidirectional());
 	}
 
 	@Test
 	public void testSerializeRequiredParams() {
-		var request = ConnectRequest.builder().token(token).sessionId(sessionId).uri(uri).build();
-		var expectedJson = "{\"sessionId\":\""+sessionId+"\",\"token\":\""+token +
+		ConnectRequest request = ConnectRequest.builder().token(token).sessionId(sessionId).uri(uri).build();
+		String expectedJson = "{\"sessionId\":\""+sessionId+"\",\"token\":\""+token +
 				"\",\"websocket\":{\"uri\":\""+uri+"\"}}";
 
 		assertEquals(expectedJson, request.toJson());
+		assertNull(request.getWebsocket().getBidirectional());
 	}
 
 	@Test
 	public void testEmptyStreamsAndHeaders() {
-		var request = ConnectRequest.builder()
+		ConnectRequest request = ConnectRequest.builder()
 				.token(token).uri(uri).sessionId(sessionId)
 				.streams().headers(Map.of()).build();
 
-		var expectedJson = "{\"sessionId\":\""+sessionId+"\",\"token\":\""+token +
+		String expectedJson = "{\"sessionId\":\""+sessionId+"\",\"token\":\""+token +
 				"\",\"websocket\":{\"uri\":\""+uri+"\",\"streams\":[],\"headers\":{}}}";
 
 		assertEquals(expectedJson, request.toJson());
@@ -66,7 +70,7 @@ public void testEmptyStreamsAndHeaders() {
 
 	@Test
 	public void testUriProtocol() {
-		var builder = ConnectRequest.builder().sessionId(sessionId).token(token);
+		ConnectRequest.Builder builder = ConnectRequest.builder().sessionId(sessionId).token(token);
 		assertEquals(URI.create(uri), builder.uri(uri).build().getWebsocket().getUri());
 		assertThrows(IllegalArgumentException.class, () -> builder.uri("https://example.com/ws-endpoint").build());
 		assertNotNull(builder.uri("ws://example.com/ws-endpoint").build().getWebsocket().getUri());

src/test/java/com/vonage/client/video/VideoClientTest.java

@@ -1966,20 +1966,24 @@ protected ConnectRequest sampleRequest() {
 						.sessionId(sessionId).token(token)
 						.uri(wssUri).streams(streamId)
 						.audioRate(Websocket.AudioRate.L16_8K)
-						.headers(headers).build();
+						.headers(headers)
+						.bidirectional(true)
+						.build();
 			}
 
 			@Override
 			protected String sampleRequestBodyString() {
 				return "{\"sessionId\":\""+sessionId+"\",\"token\":\""+token+"\",\"websocket\":{" +
 						"\"uri\":\""+wssUri+"\",\"streams\":[\""+streamId+"\"]," +
-						"\"headers\":"+mapToJson(headers)+",\"audioRate\":8000}}";
+						"\"headers\":"+mapToJson(headers)+",\"audioRate\":8000,\"bidirectional\":true}}";
 			}
 
 			@Override
 			public void runTests() throws Exception {
 				super.runTests();
-				testJsonableBaseObject(sampleRequest());
+				ConnectRequest req = sampleRequest();
+				testJsonableBaseObject(req);
+				assertEquals(Boolean.TRUE, req.getWebsocket().getBidirectional());
 			}
 		}
 		.runTests();