opentok 4.7.1 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b0b3d6e3be3dd4a73ec63d8f2be58973c2db372bd1fe56257c6a990b66b544
-  data.tar.gz: 7a468b0466b4aa3dce26a543667e1491add67df02fe0a78de4fb437ebd0d5b0b
+  metadata.gz: c5299537135033f2ae95169f0a47017542fc51ac3bcf24e469219d3f00db5cda
+  data.tar.gz: 655c9293034b05b48f39f5f15809d0550f4774c5a097fb49bcf2aa46611e2c44
 SHA512:
-  metadata.gz: 5e5ecc34657bb50eaf4da9951a205b12c23fd4379c6c3e2fc484fab2f2911c622ff85221412dd2aa774605bdda737966d561d6ada4b49816fbb21e687abfb22b
-  data.tar.gz: 5888fdc7ab677937f3e17e7c5cb293fdccaff970f75099a7900ef4b75bc12916bd843460247f2426e2345122537b23f8bb5c3955e567f1ad94d0f4dc3a757f8c
+  metadata.gz: 8b83473744134b0754c092d2a98e6d28af5a80c6ee373c48c8569af75cf84fc0106321c6a7b8e72ec253379bc4a4e431069a3c62fdcf45f7fba172ebf61e700f
+  data.tar.gz: b6946da6f229d0030fde0a09a9e969c7906f7da54151ed1f749b6af9bcd0ea0e1787521a73a98c23cebbaa60df4b8e79bddd39acd2d8367b721909488f65bc26

data/CHANGES.md

@@ -1,3 +1,11 @@
+# 4.8.1
+
+* Fixes a bug with the `Archives#create` method. See [#269](https://github.com/opentok/OpenTok-Ruby-SDK/pull/269) and [#270](https://github.com/opentok/OpenTok-Ruby-SDK/pull/270)
+
+# 4.8.0
+
+* Add support for Captions API [#267](https://github.com/opentok/OpenTok-Ruby-SDK/pull/267)
+
 # 4.7.1
 
 * Updates docs comments for `Broadcasts` and `Sip` [#266](https://github.com/opentok/OpenTok-Ruby-SDK/pull/266)

data/lib/opentok/archive.rb

@@ -72,13 +72,14 @@ module OpenTok
     #   set to null. The download URL is obfuscated, and the file is only available from the URL for
     #   10 minutes. To generate a new URL, call the Archive.listArchives() or OpenTok.getArchive() method.
   class Archive
-    attr_reader :multi_archive_tag
+    attr_reader :multi_archive_tag, :stream_mode
     # @private
     def initialize(interface, json)
       @interface = interface
       # TODO: validate json fits schema
       @json = json
       @multi_archive_tag = @json['multiArchiveTag']
+      @stream_mode = @json['streamMode']
     end
 
     # A JSON-encoded string representation of the archive.

data/lib/opentok/archives.rb

@@ -39,11 +39,11 @@ module OpenTok
     #   (a video track is included). If you set both  <code>has_audio</code> and
     #   <code>has_video</code> to <code>false</code>, the call to the <code>create()</code>
     #   method results in an error.
-    # @option options [String] :multiArchiveTag (Optional) Set this to support recording multiple archives for the same session simultaneously. 
+    # @option options [String] :multi_archive_tag (Optional) Set this to support recording multiple archives for the same session simultaneously. 
     #    Set this to a unique string for each simultaneous archive of an ongoing session. You must also set this option when manually starting an archive 
     #    that is {https://tokbox.com/developer/guides/archiving/#automatic automatically archived}. Note that the `multiArchiveTag` value is not included
     #    in the response for the methods to {https://tokbox.com/developer/rest/#listing_archives list archives} and 
-    #    {https://tokbox.com/developer/rest/#retrieve_archive_info retrieve archive information}. If you do not specify a unique `multiArchiveTag`, 
+    #    {https://tokbox.com/developer/rest/#retrieve_archive_info retrieve archive information}. If you do not specify a unique `multi_archive_tag`, 
     #    you can only record one archive at a time for a given session. 
     #    {https://tokbox.com/developer/guides/archiving/#simultaneous-archives See Simultaneous archives}.
     # @option options [String] :output_mode Whether all streams in the archive are recorded
@@ -56,7 +56,7 @@ module OpenTok
     #  (HD portrait), or "1080x1920" (FHD portrait). This property only applies to composed archives. If you set
     #  this property and set the outputMode property to "individual", a call to the method
     #  results in an error.
-    # @option options [String] :streamMode (Optional) Whether streams included in the archive are selected
+    # @option options [String] :stream_mode (Optional) Whether streams included in the archive are selected
     #   automatically ("auto", the default) or manually ("manual"). When streams are selected automatically ("auto"),
     #   all streams in the session can be included in the archive. When streams are selected manually ("manual"),
     #   you specify streams to be included based on calls to the {Archives#add_stream} method. You can specify whether a
@@ -97,7 +97,16 @@ module OpenTok
         "Resolution cannot be supplied for individual output mode" if options.key?(:resolution) and options[:output_mode] == :individual
 
       # normalize opts so all keys are symbols and only include valid_opts
-      valid_opts = [ :name, :has_audio, :has_video, :output_mode, :resolution, :layout ]
+      valid_opts = [
+        :name,
+        :has_audio,
+        :has_video,
+        :output_mode,
+        :resolution,
+        :layout,
+        :multi_archive_tag,
+        :stream_mode
+      ]
       opts = options.inject({}) do |m,(k,v)|
         if valid_opts.include? k.to_sym
           m[k.to_sym] = v

data/lib/opentok/captions.rb

@@ -0,0 +1,61 @@
+module OpenTok
+  #  A class for working with OpenTok captions.
+  class Captions
+    # @private
+    def initialize(client)
+      @client = client
+    end
+
+    # Starts live captions for the specified OpenTok session.
+    # See the {https://tokbox.com/developer/guides/live-captions/ OpenTok Live Captions developer guide}.
+    #
+    # @example
+    #    opts = { "language_code" => "en-GB",
+    #             "max_duration" => 5000,
+    #             "partial_captions" => false,
+    #             "status_callback_url" => status_callback_url
+    #           }
+    #    response = opentok.captions.start(session_id, token, opts)
+    #
+    # @param [String] session_id The session ID corresponding to the session for which captions will start.
+    # @param [String] token The token for the session ID with which the SIP user will use to connect.
+    # @param [Hash] options A hash defining options for the captions. For example:
+    # @option options [String] :language_code The BCP-47 code for a spoken language used on this call.
+    #   The default value is "en-US". The following language codes are supported:
+    #     - "en-AU" (English, Australia)
+    #     - "en-GB" (Englsh, UK)
+    #     - "es-US" (English, US)
+    #     - "zh-CN” (Chinese, Simplified)
+    #     - "fr-FR" (French)
+    #     - "fr-CA" (French, Canadian)
+    #     - "de-DE" (German)
+    #     - "hi-IN" (Hindi, Indian)
+    #     - "it-IT" (Italian)
+    #     - "ja-JP" (Japanese)
+    #     - "ko-KR" (Korean)
+    #     - "pt-BR" (Portuguese, Brazilian)
+    #     - "th-TH" (Thai)
+    # @option options [Integer] :max_duration The maximum duration for the audio captioning, in seconds.
+    #   The default value is 14,400 seconds (4 hours), the maximum duration allowed.
+    # @option options [Boolean] :partial_captions Whether to enable this to faster captioning at the cost of some
+    #   degree of inaccuracies. The default value is `true`.
+    # @option options [String] :status_callback_url A publicly reachable URL controlled by the customer and capable
+    #   of generating the content to be rendered without user intervention. The minimum length of the URL is 15
+    #   characters and the maximum length is 2048 characters.
+    #   For more information, see {https://tokbox.com/developer/guides/live-captions/#live-caption-status-updates Live Caption status updates}.
+    def start(session_id, token, options = {})
+      @client.start_live_captions(session_id, token, options)
+    end
+
+    # Starts live captions for the specified OpenTok session.
+    # See the {https://tokbox.com/developer/guides/live-captions/ OpenTok Live Captions developer guide}.
+    #
+    # @example
+    #    response = opentok.captions.stop(captions_id)
+    #
+    # @param [String] captions_id The ID for the captions to be stopped (returned from the `start` request).
+    def stop(captions_id)
+      @client.stop_live_captions(captions_id)
+    end
+  end
+end