opentok 3.0.3 → 4.1.1

data/lib/opentok/archive.rb

@@ -54,8 +54,8 @@ module OpenTok
     #   * "started" -- The archive started and is in the process of being recorded.
     #   * "stopped" -- The archive stopped recording.
     #   * "uploaded" -- The archive is available for download from the the upload target
-    #     Amazon S3 bucket or Windows Azure container you set at the OpenTok dashboard
-    #     (https://dashboard.tokbox.com).
+    #     Amazon S3 bucket or Windows Azure container you set for your
+    #     {https://tokbox.com/account OpenTok project}.
     #
     # @attr [string] url
     #   The download URL of the available MP4 file. This is only set for an archive with the status set to
@@ -71,14 +71,14 @@ module OpenTok
       @json = json
     end
 
-    # A JSON encoded string representation of the archive
+    # A JSON-encoded string representation of the archive.
     def to_json
       @json.to_json
     end
 
     # Stops an OpenTok archive that is being recorded.
     #
-    # Archives automatically stop recording after 90 minutes or when all clients have disconnected
+    # Archives automatically stop recording after 120 minutes or when all clients have disconnected
     # from the session being archived.
     def stop
       # TODO: validate returned json fits schema
@@ -95,6 +95,47 @@ module OpenTok
       @json = @interface.delete_by_id @json['id']
     end
 
+    # Sets the layout type for a composed archive. For a description of layout types, see
+    # {https://tokbox.com/developer/guides/archiving/layout-control.html Customizing
+    # the video layout for composed archives}.
+    #
+    # @option options [String] :type 
+    #   The layout type. Set this to "bestFit", "pip", "verticalPresentation",
+    #   "horizontalPresentation", "focus", or "custom".
+    #
+    # @option options [String] :stylesheet
+    #   The stylesheet for a custom layout. Set this parameter
+    #   if you set <code>type</code> to <code>"custom"</code>. Otherwise, leave it undefined.
+    #
+    # @raise [ArgumentError] The archive_id or options parameter is empty. Or the "custom"
+    #   type was specified without a stylesheet option. Or a stylesheet was passed in for a
+    #   type other than custom. Or an invalid type was passed in.
+    #
+    # @raise [OpenTokAuthenticationError]
+    #   Authentication failed.
+    #
+    # @raise [ArgumentError]
+    #   The archive_id or options parameter is empty.
+    #
+    # @raise [ArgumentError]
+    #   The "custom" type was specified without a stylesheet option.
+    #
+    # @raise [ArgumentError]
+    #   A stylesheet was passed in for a type other than custom. Or an invalid type was passed in.
+    #
+    # @raise [ArgumentError]
+    #   An invalid layout type was passed in.
+    #
+    # @raise [OpenTokError]
+    #   OpenTok server error.
+    #
+    # @raise [OpenTokArchiveError]
+    #   Setting the layout failed.
+    def layout(opts= {})
+      # TODO: validate returned json fits schema
+      @json = @interface.layout(@json['id'], opts)
+    end
+
     # @private ignore
     def method_missing(method, *args, &block)
       camelized_method = method.to_s.camelize(:lower)

data/lib/opentok/archives.rb

@@ -24,8 +24,8 @@ module OpenTok
     # {https://tokbox.com/opentok/tutorials/archiving OpenTok archiving} programming guide.
     #
     # @param [String] session_id The session ID of the OpenTok session to archive.
-    # @param [Hash] options  A hash with the key 'name', 'has_audio', and 'has_video' (or
-    # :name.
+    # @param [Hash] options  A hash with the keys 'name', 'has_audio', 'has_video',
+    #   and 'output_mode'.
     # @option options [String] :name This is the name of the archive. You can use this name
     #   to identify the archive. It is a property of the Archive object, and it is a property
     #   of archive-related events in the OpenTok client SDKs.
@@ -44,6 +44,21 @@ module OpenTok
     #     (<code>:individual</code>). For more information on archiving and the archive file
     #     formats, see the {https://tokbox.com/opentok/tutorials/archiving OpenTok archiving}
     #     programming guide.
+    # @option options [String] :resolution The resolution of the archive, either "640x480" (SD, the
+    #   default) or "1280x720" (HD). This property only applies to composed archives. If you set
+    #   this property and set the outputMode property to "individual", the call the method
+    #   results in an error.
+    # @option options [Hash] :layout Specify this to assign the initial layout type for
+    #   the archive. This applies only to composed archives. This is a hash containing two keys:
+    #   <code>:type</code> and <code>:stylesheet<code>. Valid values for <code>:type</code> are
+    #   "bestFit" (best fit), "custom" (custom), "horizontalPresentation" (horizontal presentation),
+    #   "pip" (picture-in-picture), and "verticalPresentation" (vertical presentation)).
+    #   If you specify a "custom" layout type, set the <code>:stylesheet</code> key to the
+    #   stylesheet (CSS). (For other layout types, do not set the <code>:stylesheet</code> key.)
+    #   If you do not specify an initial layout type, the archive uses the best fit
+    #   layout type. For more information, see
+    #   {https://tokbox.com/developer/guides/archiving/layout-control.html Customizing
+    #   the video layout for composed archives}.
     #
     # @return [Archive] The Archive object, which includes properties defining the archive,
     #   including the archive ID.
@@ -58,9 +73,11 @@ module OpenTok
     # @raise [OpenTokArchiveError] The archive could not be started.
     def create(session_id, options = {})
       raise ArgumentError, "session_id not provided" if session_id.to_s.empty?
+      raise ArgumentError,
+        "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 ]
+      valid_opts = [ :name, :has_audio, :has_video, :output_mode, :resolution, :layout ]
       opts = options.inject({}) do |m,(k,v)|
         if valid_opts.include? k.to_sym
           m[k.to_sym] = v
@@ -97,7 +114,7 @@ module OpenTok
     # @option options [integer] :count Optional. The number of archives to be returned. The maximum
     #   number of archives returned is 1000.
     # @option options [String] :session_id Optional. The session ID that archives belong to. This is
-    #   useful when listing multiple archives for an {https://tokbox.com/developer/guides/archiving/#automatic-archives automatically archived session}
+    #   useful when listing multiple archives for an {https://tokbox.com/developer/guides/archiving/#automatic-archives automatically archived session}.
     #
     # @return [ArchiveList] An ArchiveList object, which is an array of Archive objects.
     def all(options = {})
@@ -108,7 +125,7 @@ module OpenTok
 
     # Stops an OpenTok archive that is being recorded.
     #
-    # Archives automatically stop recording after 90 minutes or when all clients have disconnected
+    # Archives automatically stop recording after 120 minutes or when all clients have disconnected
     # from the session being archived.
     #
     # @param [String] archive_id The archive ID of the archive you want to stop recording.
@@ -146,5 +163,56 @@ module OpenTok
       (200..300).include? response.code
     end
 
+    # Sets the layout type for a composed archive. For a description of layout types, see
+    # {https://tokbox.com/developer/guides/archiving/layout-control.html Customizing
+    # the video layout for composed archives}.
+    #
+    # @param [String] archive_id 
+    #   The archive ID.
+    #
+    # @option options [String] :type 
+    #   The layout type. Set this to "bestFit", "pip", "verticalPresentation",
+    #   "horizontalPresentation", "focus", or "custom".
+    #
+    # @option options [String] :stylesheet
+    #   The stylesheet for a custom layout. Set this parameter
+    #   if you set <code>type</code> to <code>"custom"</code>. Otherwise, leave it undefined.
+    #
+    # @raise [ArgumentError]
+    #   The archive_id or options parameter is empty. Or the "custom"
+    #   type was specified without a stylesheet option. Or a stylesheet was passed in for a
+    #   type other than custom. Or an invalid type was passed in.
+    #
+    # @raise [OpenTokAuthenticationError]
+    #   Authentication failed.
+    #
+    # @raise [ArgumentError]
+    #   The archive_id or options parameter is empty.
+    #
+    # @raise [ArgumentError]
+    #   The "custom" type was specified without a stylesheet option.
+    #
+    # @raise [ArgumentError]
+    #   A stylesheet was passed in for a type other than custom. Or an invalid type was passed in.
+    #
+    # @raise [ArgumentError]
+    #   An invalid layout type was passed in.
+    #
+    # @raise [OpenTokError]
+    #   OpenTok server error.
+    #
+    # @raise [OpenTokArchiveError]
+    #   Setting the layout failed.
+    def layout(archive_id, options = {})
+      raise ArgumentError, "option parameter is empty" if options.empty?
+      raise ArgumentError, "archive_id not provided" if archive_id.to_s.empty?
+      type = options[:type]
+      raise ArgumentError, "custom type must have a stylesheet" if (type.eql? "custom") && (!options.key? :stylesheet)
+      valid_non_custom_type = ["bestFit","horizontalPresentation","pip", "verticalPresentation", ""].include? type
+      raise ArgumentError, "type is not valid or stylesheet not needed" if !valid_non_custom_type
+      raise ArgumentError, "type is not valid or stylesheet not needed" if valid_non_custom_type and options.key? :stylesheet
+      response = @client.layout_archive(archive_id, options)
+      (200..300).include? response.code
+    end
   end
 end

data/lib/opentok/broadcast.rb

@@ -0,0 +1,118 @@
+require "active_support/inflector"
+
+module OpenTok
+  # Represents a live streaming broadcast of an OpenTok session.
+  # See {https://tokbox.com/developer/guides/broadcast/live-streaming/ Live streaming broadcasts}.
+  #
+  # @attr [string] id
+  #   The broadcast ID.
+  #
+  # @attr [string] session_id
+  #   The session ID of the OpenTok session associated with this broadcast.
+  #
+  # @attr [string] project_id
+  #   The API key associated with the broadcast.
+  #
+  # @attr [int] created_at
+  #   The time at which the broadcast was created, in milliseconds since the UNIX epoch.
+  #
+  # @attr [int] updated_at
+  #   For this start method, this timestamp matches the createdAt timestamp.
+  #
+  # @attr [string] resolution
+  #   The resolution of the broadcast: either "640x480" (SD, the default) or "1280x720" (HD). This property is optional.
+  #
+  # @attr [Hash] broadcastUrls is defined as follows:
+  #   This object defines the types of broadcast streams you want to start (both HLS and RTMP).
+  #   You can include HLS, RTMP, or both as broadcast streams. If you include RTMP streaming,
+  #   you can specify up to five target RTMP streams (or just one).
+  #   The (<code>:hls</code>)  property is set  to an empty [Hash] object. The HLS URL is returned in the response.
+  #   The (<code>:rtmp</code>)  property is set  to an [Array] of Rtmp [Hash] properties.
+  #   For each RTMP stream, specify (<code>:serverUrl</code>) for the RTMP server URL,
+  #   (<code>:streamName</code>) such as the YouTube Live stream name or the Facebook stream key),
+  #   and (optionally) (<code>:id</code>), a unique ID for the stream.
+  #
+  # @attr [string] status The status of the RTMP stream.
+  #     * "connecting" --  The OpenTok platform is in the process of connecting to the remote RTMP server.
+  #                        This is the initial state, and it is the status if you start when there are no streams published in the session.
+  #                        It changes to "live" when there are streams (or it changes to one of the other states).
+  #     * "live --         The OpenTok platform has successfully connected to the remote RTMP server, and the media is streaming.
+  #     * "offline" --     The OpenTok platform could not connect to the remote RTMP server. This is due to an unreachable server or an error in the RTMP handshake. Causes include rejected RTMP connections, non-existing RTMP applications, rejected stream names, authentication errors, etc. Check that the server is online, and that you have provided the correct server URL and stream name.
+  #     * "error" --       There is an error in the OpenTok platform.
+  class Broadcast
+
+    # @private
+    def initialize(interface, json)
+      @interface = interface
+      # TODO: validate json fits schema
+      @json = json
+    end
+
+    # A JSON-encoded string representation of the broadcast.
+    def to_json
+      @json.to_json
+    end
+
+    # Stops the OpenTok broadcast.
+    def stop
+      # TODO: validate returned json fits schema
+      @json = @interface.stop @json['id']
+    end
+
+    # Sets the layout of the OpenTok broadcast.
+    #
+    # You can dynamically change the layout type of a broadcast while it is being broadcast.
+    # For more information, see
+    # {https://tokbox.com/developer/guides/broadcast/live-streaming/#configuring-video-layout-for-opentok-live-streaming-broadcasts Configuring video layout for OpenTok live streaming broadcasts}.
+    #
+    # @option options [String] :type 
+    #   The layout type. Set this to "bestFit", "pip", "verticalPresentation",
+    #   "horizontalPresentation", "focus", or "custom".
+    #
+    # @option options [String] :stylesheet
+    #   The stylesheet for a custom layout. Set this parameter
+    #   if you set <code>type</code> to <code>"custom"</code>. Otherwise, leave it undefined.
+    #
+    # @raise [OpenTokBroadcastError]
+    #   The broadcast layout could not be updated.
+    #
+    # @raise [OpenTokAuthenticationError]
+    #   Authentication failed. Invalid API key or secret.
+    #
+    # @raise [OpenTokError]
+    #   OpenTok server error.
+    #
+    # @raise [ArgumentError]
+    #   The broadcast_id or options parameter is empty.
+    #
+    # @raise [ArgumentError]
+    #   The "custom" type was specified without a stylesheet option.
+    #
+    # @raise [ArgumentError]
+    #   A stylesheet was passed in for a type other than custom. Or an invalid type was passed in.
+    #
+    # @raise [ArgumentError]
+    #   An invalid layout type was passed in.
+    # Refer to {https://tokbox.com/developer/rest/#change_composed_archive_layout}
+
+    def layout(opts = {})
+      # TODO: validate returned json fits schema
+      @json = @interface.layout(@json['id'], opts)
+    end
+
+    # @private ignore
+    def method_missing(method, *args, &block)
+      camelized_method = method.to_s.camelize(:lower)
+      if @json.has_key? camelized_method and args.empty?
+        # TODO: convert create_time method call to a Time object
+        if camelized_method == 'outputMode'
+          @json[camelized_method].to_sym
+        else
+          @json[camelized_method]
+        end
+      else
+        super method, *args, &block
+      end
+    end
+  end
+end

data/lib/opentok/broadcasts.rb

@@ -0,0 +1,149 @@
+require "opentok/client"
+require "opentok/broadcast"
+
+
+module OpenTok
+  # A class for working with OpenTok live streaming broadcasts.
+  # See {https://tokbox.com/developer/guides/broadcast/live-streaming/ Live streaming broadcasts}.
+  class Broadcasts
+
+    # @private
+    def initialize(client)
+      @client = client
+    end
+
+    # Starts a live streaming broadcast of an OpenTok session.
+    #
+    # Clients must be actively connected to the OpenTok session for you to successfully start
+    # a broadcast.
+    #
+    # This broadcasts the session to an HLS (HTTP live streaming) or to RTMP streams.
+    #
+    # @param [String] session_id The session ID of the OpenTok session to broadcast.
+    #
+    # @param [Hash] options A hash defining options for the broadcast.
+    # @option options [Hash] :layout Specify this to assign the initial layout  for the broadcast.
+    #   Valid values for the layout (<code>:type</code>) property are "bestFit" (best fit), "custom" (custom),
+    #   "horizontalPresentation" (horizontal presentation), "pip" (picture-in-picture), and
+    #   "verticalPresentation" (vertical presentation)).
+    #   If you specify a (<code>:custom</code>) layout type, set the (<code>:stylesheet</code>) property of the layout object
+    #   to the stylesheet. (For other layout types, do not set a stylesheet property.)
+    #   If you do not specify an initial layout type, the broadcast stream uses the Best Fit layout type.
+    #
+    # @option options [int] maxDuration
+    #   The maximum duration for the broadcast, in seconds. The broadcast will automatically stop when
+    #   the maximum duration is reached. You can set the maximum duration to a value from 60 (60 seconds) to 36000 (10 hours).
+    #   The default maximum duration is 2 hours (7200 seconds).
+    #
+    # @option options [Hash] outputs
+    #   This object defines the types of broadcast streams you want to start (both HLS and RTMP).
+    #   You can include HLS, RTMP, or both as broadcast streams. If you include RTMP streaming,
+    #   you can specify up to five target RTMP streams (or just one).
+    #   The (<code>:hls</code>) property is set  to an empty [Hash] object. The HLS URL is returned in the response.
+    #   The (<code>:rtmp</code>)  property is set  to an [Array] of Rtmp [Hash] properties.
+    #   For each RTMP , specify (<code>:serverUrl</code>) for the RTMP server URL,
+    #   (<code>:streamName</code>) such as the YouTube Live stream name or the Facebook stream key),
+    #   and (optionally) (<code>:id</code>), a unique ID for the stream.
+    #
+    # @option options [string] resolution
+    #   The resolution of the broadcast: either "640x480" (SD, the default) or "1280x720" (HD).
+    #
+    # @return [Broadcast] The broadcast object, which includes properties defining the broadcast,
+    #   including the broadcast ID.
+    #
+    # @raise [OpenTokBroadcastError] The broadcast could not be started. The request was invalid or broadcast already started
+    # @raise [OpenTokAuthenticationError] Authentication failed while starting an archive.
+    #   Invalid API key.
+    # @raise [OpenTokError] OpenTok server error.
+    def create(session_id, options = {})
+      raise ArgumentError, "session_id not provided" if session_id.to_s.empty?
+      raise ArgumentError, "options cannot be empty" if options.empty?
+      broadcast_json = @client.start_broadcast(session_id, options)
+      Broadcast.new self, broadcast_json
+    end
+
+    # Gets a Broadcast object for the given broadcast ID.
+    #
+    # @param [String] broadcast_id The broadcast ID.
+    #
+    # @return [Broadcast] The broadcast object, which includes properties defining the broadcast.
+    #
+    # @raise [OpenTokBroadcastError] No matching broadcast found.
+    # @raise [OpenTokAuthenticationError] Authentication failed.
+    #   Invalid API key.
+    # @raise [OpenTokError] OpenTok server error.
+    def find(broadcast_id)
+      raise ArgumentError, "broadcast_id not provided" if broadcast_id.to_s.empty?
+      broadcast_json = @client.get_broadcast(broadcast_id.to_s)
+      Broadcast.new self, broadcast_json
+    end
+
+
+    # Stops an OpenTok broadcast
+    #
+    # Note that broadcasts automatically stop after 120 minute
+    #
+    # @param [String] broadcast_id The broadcast ID.
+    #
+    # @return [Broadcast] The broadcast object, which includes properties defining the broadcast.
+    #
+    # @raise [OpenTokBroadcastError] The broadcast could not be stopped. The request was invalid.
+    # @raise [OpenTokAuthenticationError] Authentication failed.
+    #   Invalid API key.
+    # @raise [OpenTokError] OpenTok server error.
+    def stop(broadcast_id)
+      raise ArgumentError, "broadcast_id not provided" if broadcast_id.to_s.empty?
+      broadcast_json = @client.stop_broadcast(broadcast_id)
+      Broadcast.new self, broadcast_json
+    end
+
+    # Dynamically alters the layout an OpenTok broadcast. For more information, see
+    # For more information, see
+    # {https://tokbox.com/developer/guides/broadcast/live-streaming/#configuring-video-layout-for-opentok-live-streaming-broadcasts Configuring video layout for OpenTok live streaming broadcasts}.
+    #
+    # @param [String] broadcast_id
+    #   The broadcast ID.
+    #
+    # @option options [String] :type 
+    #   The layout type. Set this to "bestFit", "pip", "verticalPresentation",
+    #   "horizontalPresentation", "focus", or "custom".
+    #
+    # @option options [String] :stylesheet
+    #   The stylesheet for a custom layout. Set this parameter
+    #   if you set <code>type</code> to <code>"custom"</code>. Otherwise, leave it undefined.
+    #
+    # @raise [OpenTokBroadcastError]
+    #   The broadcast layout could not be updated.
+    #
+    # @raise [OpenTokAuthenticationError]
+    #   Authentication failed. Invalid API key or secret.
+    #
+    # @raise [OpenTokError]
+    #   OpenTok server error.
+    #
+    # @raise [ArgumentError]
+    #   The broadcast_id or options parameter is empty.
+    #
+    # @raise [ArgumentError]
+    #   The "custom" type was specified without a stylesheet option.
+    #
+    # @raise [ArgumentError]
+    #   A stylesheet was passed in for a type other than custom. Or an invalid type was passed in.
+    #
+    # @raise [ArgumentError]
+    #   An invalid layout type was passed in.
+    def layout(broadcast_id, options = {})
+      raise ArgumentError, "option parameter is empty" if options.empty?
+      raise ArgumentError, "broadcast_id not provided" if broadcast_id.to_s.empty?
+      type = options[:type]
+      raise ArgumentError, "custom type must have a stylesheet" if (type.eql? "custom") && (!options.key? :stylesheet)
+      valid_non_custom_type = ["bestFit","horizontalPresentation","pip", "verticalPresentation", ""].include? type
+      raise ArgumentError, "type is not valid" if !valid_non_custom_type
+      raise ArgumentError, "stylesheet not needed" if valid_non_custom_type and options.key? :stylesheet
+      response = @client.layout_broadcast(broadcast_id, options)
+      (200..300).include? response.code
+    end
+
+
+  end
+end