opentok 4.14.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70820e3fc205e74907214c25466b8a10b31ba550ab5386cfe728588e714802ba
-  data.tar.gz: 4afbf5e3276d0d055f0ce502408b36c7c79165ae67bfbb45f8bb0409ff466d0c
+  metadata.gz: dba16e262ee1efcd3e87c99d60c84559a2fe31b0f0040266f292665130231dfd
+  data.tar.gz: d5ead947680c53381169f9bfc229bf761f0fe8834952cb1ccc5280023f0011dd
 SHA512:
-  metadata.gz: 6943fac926e9635617f9e0331766772e4e6404eb06fc663052ef0f0b8837ae6ac7d0e70727443d081bcad844a2a6cf997ebef46b5bd47be71c3e87aa4117e0d7
-  data.tar.gz: 7895a15eb0797a26629e24391303a10c0e1298f9515396384a8232381ed28d253090050a29a311911d5dc0aa1c28aa5e327414e4f23d410bfe5cb1b15ca88fc0
+  metadata.gz: b79caecbdafc5b0ea92fabf23e5bcff06e1ccd457e8c07cddae0989041c4844bf49599f6d9e8b7298440233d019b20e1ba82b2fae645f43b1803f4872096800d
+  data.tar.gz: 3a5f7ab3e37791c2c182a892e914f208b9fdb167e47407f2e26a238c6bddace7feb59d3bda9d71e7baa4fe0bef525879ab2731d51f813f9f36b6c32a9b9d069d

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 4.15.0
+
+* Adds support for transcription settings when starting an archive recording. See [#298](https://github.com/opentok/OpenTok-Ruby-SDK/pull/298)
+* Ensures support for setting `audio_transport` configuration in a `WebSocket` connection. See [#297](https://github.com/opentok/OpenTok-Ruby-SDK/pull/297)
+
 # 4.14.0
 
 * Implements functionality to allow the use of Vonage Video endpoints and credentials.

data/lib/opentok/archives.rb

@@ -83,11 +83,15 @@ module OpenTok
     #   value is 100,000 and the maximum is 6,000,000. This option is only valid for composed archives. Set the maximum video bitrate
     #   to control the size of the composed archive. This maximum bitrate applies to the video bitrate only. If the output archive has
     #   audio, those bits will be excluded from the limit.
-    #
     # @option options [Integer] :quantization_parameter (Optional) The quantization parameter (QP) is an optional video encoding value allowed for composed archiving,
     #   smaller values generate higher quality and larger archives, larger values generate lower quality and smaller archives, QP uses variable bitrate (VBR). The minimum
     #   value is 15 and the maximum is 40.
     #   This parameter is mutually exclusive with the max_bitrate parameter.
+    # @option options [Boolean] :has_transcription (Optional) Whether the archive will have a transcription of the audio of the session (true) or not (false, the default).
+    # @option options [Hash] :transcription_properties (Optional) A hash of specific transcription settings.
+    # @option options[:transcription_properties] [String] 'primaryLanguageCode' (Optional) The primary language spoken in the archive to be transcribed, in BCP-47 format, e.g. en-US, es-ES or pt-BR.
+    #   @see https://developer.vonage.com/en/api/video#post-v2-project-application_id-archive for a full list of supported languages.
+    # @option options[:transcription_properties] [Boolean] 'hasSummary' (Optional) Whether the transcription should include a summary of the session (true) or not (false, the default).
     #
     # @return [Archive] The Archive object, which includes properties defining the archive,
     #   including the archive ID.
@@ -116,7 +120,9 @@ module OpenTok
         :multi_archive_tag,
         :stream_mode,
         :max_bitrate,
-        :quantization_parameter
+        :quantization_parameter,
+        :has_transcription,
+        :transcription_properties
       ]
       opts = options.inject({}) do |m,(k,v)|
         if valid_opts.include? k.to_sym

data/lib/opentok/version.rb

@@ -1,4 +1,4 @@
 module OpenTok
   # @private
-  VERSION = '4.14.0'
+  VERSION = '4.15.0'
 end

data/lib/opentok/websocket.rb

@@ -29,6 +29,12 @@ module OpenTok
     # @option opts [Boolean] :bidirectional (optional) Whether the WebSocket connection should be bidirectional.
     # @option opts [Integer] :audio_rate (optional) A number representing the audio sampling rate in Hz for the WebSocket stream.
     #   - Must be one of: 8000, 16000, 24000
+    # @option opts [Hash] :audio_transport (optional) A hash that configures how audio is serialized on the WebSocket wire. By default, audio is sent as raw binary PCM 16-bit frames.
+    # @option opts[:audio_transport] [String] :transport (optional) The transport type for the audio data. Must be one of: "json", "binary".
+    # @option opts[:audio_transport] [String] :encoding (optional) The encoding type for the audio data. Required when transport is "json". Must be one of: "base64".
+    # @option opts[:audio_transport] [String] :audio_field (optional) The JSON key for the outbound audio data. The default value is "audio".
+    # @option opts[:audio_transport] [String] :receive_audio_field (optional) The JSON key for inbound audio data (when bidirectional is enabled). Defaults to the same value as `audio_field`.
+    # @option opts[:audio_transport] [Hash] :static_fields (optional) An optional hash of extra key-value pairs included in every outbound JSON audio message.
     def connect(session_id, token, websocket_uri, opts  = {})
       response = @client.connect_websocket(session_id, token, websocket_uri, opts)
     end

data/spec/cassettes/OpenTok_Archives/should_create_an_archive_with_transcription_enabled_and_transcription_settings_specified.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.opentok.com/v2/project/123456/archive
+    body:
+      encoding: UTF-8
+      string: '{"sessionId":"SESSIONID","hasTranscription":true,"transcriptionProperties":{"primaryLanguageCode":"en-US","hasSummary":true}}'
+    headers:
+      User-Agent:
+      - OpenTok-Ruby-SDK/<%= version %>
+      X-Opentok-Auth:
+      - eyJpc3QiOiJwcm9qZWN0IiwiYWxnIjoiSFMyNTYifQ.eyJpc3MiOiIxMjM0NTYiLCJpYXQiOjE0OTI1MTA2NjAsImV4cCI6MTQ5MjUxMDk2MH0.BplMVhJWx4ld7KLKXqEmow6MjNPPFw9W8IHCMfeb120
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 18 Aug 2026 15:46:06 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "createdAt" : 1395183243556,
+          "duration" : 0,
+          "id" : "30b3ebf1-ba36-4f5b-8def-6f70d9986fe9",
+          "name" : "",
+          "partnerId" : 123456,
+          "reason" : "",
+          "sessionId" : "SESSIONID",
+          "size" : 0,
+          "status" : "started",
+          "url" : null,
+          "hasTranscription": true,
+          "transcriptionProperties": {
+            "primaryLanguageCode": "en-US",
+            "hasSummary": true
+          }
+        }
+  recorded_at: Tue, 18 Aug 2026 15:46:06 GMT
+recorded_with: VCR 6.3.1

data/spec/cassettes/OpenTok_WebSocket/receives_a_valid_response_with_opts.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api.opentok.com/v2/project/123456/connect
     body:
       encoding: UTF-8
-      string: '{"sessionId":"SESSIONID","token":"TOKENID","websocket":{"uri":"ws://service.com/wsendpoint","streams":["123456"],"headers":{"foo":"bar"},"bidirectional":true}}'
+      string: '{"sessionId":"SESSIONID","token":"TOKENID","websocket":{"uri":"ws://service.com/wsendpoint","streams":["123456"],"headers":{"foo":"bar"},"bidirectional":true,"audioTransport":{"transport":"json","encoding":"base64","audio_field":"audio","receive_audio_field":"audio","static_fields":{"foo":"bar"}}}}'
     headers:
       User-Agent:
       - OpenTok-Ruby-SDK/<%= version %>

data/spec/opentok/archives_spec.rb

@@ -119,6 +119,16 @@ describe OpenTok::Archives do
     expect(archive.session_id).to eq session_id
   end
 
+  it "should create an archive with transcription enabled and transcription settings specified", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
+    transcription_properties = {
+      'primaryLanguageCode' => 'en-US',
+      'hasSummary' => true
+    }
+    archive = archives.create session_id, :has_transcription => true, :transcription_properties => transcription_properties
+    expect(archive).to be_an_instance_of OpenTok::Archive
+    expect(archive.session_id).to eq session_id
+  end
+
   it "should stop archives", :vcr => { :erb => { :version => OpenTok::VERSION + "-Ruby-Version-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}" } } do
     archive = archives.stop_by_id started_archive_id
     expect(archive).to be_an_instance_of OpenTok::Archive

data/spec/opentok/websocket_spec.rb

@@ -28,7 +28,16 @@ describe OpenTok::WebSocket do
     opts = {
       "streams" => ["123456"],
       "headers" => {"foo" => "bar"},
-      "bidirectional" => true
+      "bidirectional" => true,
+      "audio_transport" => {
+        "transport" => "json",
+        "encoding" => "base64",
+        "audio_field" => "audio",
+        "receive_audio_field" => "audio",
+        "static_fields" => {
+          "foo" => "bar"
+        }
+      }
     }
 
     response = websocket.connect(session_id, expiring_token, websocket_uri, opts)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentok
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.15.0
 platform: ruby
 authors:
 - Stijn Mathysen
@@ -11,7 +11,7 @@ authors:
 - Ankur Oberoi
 bindir: bin
 cert_chain: []
-date: 2026-07-02 00:00:00.000000000 Z
+date: 2026-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -250,6 +250,7 @@ files:
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_multi_archive_tag_value_of_nil_when_multiArchiveTag_not_specified.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_quantizationParameter_set_to_specified_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_streamMode_set_to_specified_stream_mode_value.yml
+- spec/cassettes/OpenTok_Archives/should_create_an_archive_with_transcription_enabled_and_transcription_settings_specified.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archives_with_a_specified_multiArchiveTag.yml
 - spec/cassettes/OpenTok_Archives/should_create_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_audio_only_archives.yml
@@ -376,6 +377,7 @@ test_files:
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_multi_archive_tag_value_of_nil_when_multiArchiveTag_not_specified.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_quantizationParameter_set_to_specified_value.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archive_with_streamMode_set_to_specified_stream_mode_value.yml
+- spec/cassettes/OpenTok_Archives/should_create_an_archive_with_transcription_enabled_and_transcription_settings_specified.yml
 - spec/cassettes/OpenTok_Archives/should_create_an_archives_with_a_specified_multiArchiveTag.yml
 - spec/cassettes/OpenTok_Archives/should_create_archives.yml
 - spec/cassettes/OpenTok_Archives/should_create_audio_only_archives.yml