wsc_sdk 1.3.1

data/lib/wsc_sdk/model_list.rb

@@ -0,0 +1,42 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+module WscSdk
+
+  # A class to manage lists of models
+  #
+  class ModelList < Hash
+    include WscSdk::ApiResponse
+
+    # Add a model to the list
+    #
+    # @param model [WscSdk::Model]
+    #   The model to add to the list
+    #
+    def add(model)
+      self[model.primary_key] = model
+    end
+
+    # Assign pagination data to the list
+    #
+    # @param pagination [Hash,WscSdk::Pagination]
+    #   A hash of pagination options or an instance of WscSdk::Pagination
+    #
+    def pagination= pagination
+      if pagination.is_a?(Hash)
+        @pagination = WscSdk::Pagination.new(pagination)
+      elsif pagination.is_a?(WscSdk::Pagination)
+        @pagination = pagination
+      end
+    end
+
+    # Get pagination data for the list
+    #
+    # @return [Hash] A hash of pagination data
+    #
+    def pagination
+      @pagination ||= WscSdk::Pagination.new()
+    end
+  end
+
+end

data/lib/wsc_sdk/model_template.rb

@@ -0,0 +1,27 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+module WscSdk
+
+  # A module that contains the various templates
+  module Templates
+
+  end
+
+  # A base class for the model templates.
+  #
+  class ModelTemplate
+
+    # Modifies a hash with a hash of modifiers
+    #
+    # @param [Hash] data
+    #   The initial hash to be modified
+    #
+    # @param [Hash] modifiers
+    #   A hash of modifiers for the final template output.
+    #
+    def self.merge(data, modifiers)
+      data.deep_merge(modifiers)
+    end
+  end
+end

data/lib/wsc_sdk/models/custom_stream_target.rb

@@ -0,0 +1,34 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require 'wsc_sdk/model'
+require 'wsc_sdk/models/stream_target'
+
+module WscSdk
+  module Models
+
+    # A model to represent a Custom Stream Target in the Wowza Streaming Cloud API.
+    #
+    class CustomStreamTarget < WscSdk::Model
+
+      model_name_singular :stream_target_custom
+      model_name_plural   :stream_targets_custom
+
+      attribute :id,                :string,    access: :read
+      attribute :name,              :string,    required: true
+      attribute :type,              :string,    access: :read
+      attribute :provider,          :string
+      attribute :use_https,         :boolean
+      attribute :stream_name,       :string
+      attribute :username,          :string
+      attribute :password,          :string
+      attribute :primary_url,       :string
+      attribute :backup_url,        :string
+      attribute :hds_playback_url,  :string
+      attribute :hls_playback_url,  :string
+      attribute :rtmp_playback_url, :string
+      attribute :created_at,        :datetime,  access: :read
+      attribute :updated_at,        :datetime,  access: :read
+    end
+  end
+end

data/lib/wsc_sdk/models/error.rb

@@ -0,0 +1,53 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require 'wsc_sdk/model'
+
+module WscSdk
+  module Models
+
+    # A model to represent an error returned from the API.
+    #
+    class Error < WscSdk::Model
+
+      model_name_singular :meta
+      model_name_plural   :meta
+
+      #---------------------------------------------------------------------------
+      #  ___     _
+      # / __| __| |_  ___ _ __  __ _
+      # \__ \/ _| ' \/ -_) '  \/ _` |
+      # |___/\__|_||_\___|_|_|_\__,_|
+      #
+      #---------------------------------------------------------------------------
+
+      attribute :status,      :integer, access: :read
+      attribute :code,        :string,  access: :read
+      attribute :title,       :string,  access: :read
+      attribute :message,     :string,  access: :read
+      attribute :description, :string,  access: :read
+
+      #---------------------------------------------------------------------------
+      #  ___ _        _
+      # / __| |_ __ _| |_ ___
+      # \__ \  _/ _` |  _/ -_)
+      # |___/\__\__,_|\__\___|
+      #
+      #---------------------------------------------------------------------------
+
+      # Since this is an error response the success is always false.
+      #
+      # @return [Boolean] An indication of the status of the API call.
+      #
+      def success?
+        @success = false
+      end
+
+      # Generates a string with the details of the error.
+      #
+      def to_s
+        "#{code} | #{title} | #{message} | #{description}"
+      end
+    end
+  end
+end

data/lib/wsc_sdk/models/live_stream.rb

@@ -0,0 +1,130 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require 'wsc_sdk/model'
+
+module WscSdk
+  module Models
+
+    # A model to represent a Live Stream in the Wowza Streaming Cloud API.
+    #
+    class LiveStream < WscSdk::Model
+      include WscSdk::TranscoderSharedMethods
+
+      model_name_singular :live_stream
+      model_name_plural   :live_streams
+
+      #---------------------------------------------------------------------------
+      #  ___     _
+      # / __| __| |_  ___ _ __  __ _
+      # \__ \/ _| ' \/ -_) '  \/ _` |
+      # |___/\__|_||_\___|_|_|_\__,_|
+      #
+      #---------------------------------------------------------------------------
+
+      attribute :id,                                :string,    access: :read
+      attribute :name,                              :string,    required: true
+      attribute :transcoder_type,                   :string,    required: true,     validate: Enums::TranscoderType.values,     default: Enums::TranscoderType::TRANSCODED
+      attribute :billing_mode,                      :string,    required: true,     validate: Enums::BillingMode.values,        default: Enums::BillingMode::PAY_AS_YOU_GO
+      attribute :broadcast_location,                :string,    required: true,     validate: Enums::BroadcastLocation.values
+      # attribute :protocol,                          :string,    required: true,     validate: Enums::Protocol.values
+      attribute :encoder,                           :string,    required: true,     validate: Enums::Encoder.values
+      attribute :delivery_method,                   :string,    required: true,     validate: Enums::DeliveryMethod.values,     default: Enums::DeliveryMethod::PUSH
+      attribute :delivery_type,                     :string,    required: :delivery_type_is_required?,  validate: Enums::DeliveryType.values, default: Enums::DeliveryType::SINGLE_BITRATE
+      attribute :recording,                         :boolean
+      attribute :closed_caption_type,               :string,                        validate: Enums::ClosedCaptionType.values
+      attribute :target_delivery_protocol,          :string,                        default: Enums::TargetDeliveryProtocol::HLS_HTTPS
+      attribute :use_stream_source,                 :boolean
+      attribute :stream_source_id,                  :string,    access: :read
+      attribute :aspect_ratio_width,                :integer,   required: true
+      attribute :aspect_ratio_height,               :integer,   required: true
+      attribute :source_url,                        :string,    access: :write,     required: :source_url_is_required?,         default: :default_source_url
+      attribute :connection_code,                   :string,    access: :read
+      attribute :connection_code_expires_at,        :datetime,  access: :read
+      attribute :disable_authentication,            :boolean,   access: :write
+      attribute :username,                          :string,    access: :write
+      attribute :password,                          :string,    access: :write
+      attribute :delivery_protocols,                :array
+      attribute :source_connection_information,     :hash,      access: :read
+      attribute :direct_playback_urls,              :hash,      access: :read
+
+      attribute :player_id,                         :string,    access: :read
+      attribute :player_type,                       :string,                        validate: Enums::PlayerType.values
+      attribute :player_responsive,                 :boolean
+      attribute :player_width,                      :integer
+      attribute :player_video_poster_image_url,     :string,    access: :read
+      attribute :player_video_poster_image,         :string,    access: :write
+      attribute :remove_player_video_poster_image,  :boolean,   access: :write
+      attribute :player_countdown,                  :boolean
+      attribute :player_countdown_at,               :datetime
+      attribute :player_logo_image_url,             :string,    access: :read
+      attribute :player_logo_image,                 :string,    access: :write
+      attribute :remove_player_logo_image,          :boolean,   access: :write
+      attribute :player_logo_position,              :string,                        validate: Enums::ImagePosition.values
+      attribute :player_embed_code,                 :string,    access: :read
+      attribute :player_hds_playback_url,           :string,    access: :read
+      attribute :player_hls_playback_url,           :string,    access: :read
+
+      attribute :hosted_page,                       :boolean,   access: :hosted_page_access
+      attribute :hosted_page_title,                 :string
+      attribute :hosted_page_description,           :string
+      attribute :hosted_page_url,                   :string,    access: :read
+      attribute :hosted_page_logo_image_url,        :string,    access: :read
+      attribute :hosted_page_logo_image,            :string,    access: :write
+      attribute :remove_hosted_page_logo_image,     :boolean,   access: :write
+      attribute :hosted_page_sharing_icons,         :boolean
+
+
+      attribute :created_at,                        :datetime,  access: :read
+      attribute :updated_at,                        :datetime,  access: :read
+
+      # Determine if the source_url attribute is required
+      #
+      def source_url_is_required?
+        delivery_method == Enums::DeliveryMethod::PULL
+      end
+
+      # Determine if the delivery type opitons is required
+      #
+      def delivery_type_is_required?
+        encoder == Enums::Encoder::WOWZA_STREAMING_ENGINE
+      end
+
+      # Determine if the hosted page option can be set
+      #
+      def hosted_page_access
+        self.new_model? ? :read_write : :read
+      end
+
+      # Since the source_url is a write only attribute, when we update the
+      # live stream the value is no longer present, so we will default it to
+      # the value returned in the source_connection_information attribute, if it
+      # is present.
+      #
+      def default_source_url
+        sci = (self.attributes[:source_connection_information] || {})
+        return sci[:source_url] if sci.has_key?(:source_url)
+        return nil
+      end
+
+      #---------------------------------------------------------------------------
+      #    _      _   _
+      #   /_\  __| |_(_)___ _ _  ___
+      #  / _ \/ _|  _| / _ \ ' \(_-<
+      # /_/ \_\__|\__|_\___/_||_/__/
+      #
+      #---------------------------------------------------------------------------
+
+
+      # Regenerates the connection code for the transcoder.
+      #
+      # @return [WscSdk::Models::TranscoderConnectionCode]
+      #   The regenerated connection code information.
+      #
+      def regenerate_connection_code
+        return self.endpoint.regenerate_connection_code(self.id)
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/models/live_stream_connection_code.rb

@@ -0,0 +1,31 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require 'wsc_sdk/model'
+require 'wsc_sdk/models/transcoder_connection_code'
+
+module WscSdk
+  module Models
+
+    # A model to represent the connection code of a Live Stream in the Wowza Streaming
+    # Cloud API.
+    #
+    class LiveStreamConnectionCode < WscSdk::Model
+
+      model_name_singular :live_stream
+      model_name_plural   :live_streams
+
+
+      #---------------------------------------------------------------------------
+      #  ___     _
+      # / __| __| |_  ___ _ __  __ _
+      # \__ \/ _| ' \/ -_) '  \/ _` |
+      # |___/\__|_||_\___|_|_|_\__,_|
+      #
+      #---------------------------------------------------------------------------
+
+      attribute :connection_code,           :string, access: :read
+
+    end
+  end
+end

data/lib/wsc_sdk/models/live_stream_state.rb

@@ -0,0 +1,20 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require 'wsc_sdk/model'
+require 'wsc_sdk/models/transcoder_state'
+
+module WscSdk
+  module Models
+
+    # A model to represent the State of a Live Stream in the Wowza Streaming
+    # Cloud API.
+    #
+    class LiveStreamState < TranscoderState
+
+      model_name_singular :live_stream
+      model_name_plural   :live_streams
+
+    end
+  end
+end

data/lib/wsc_sdk/models/live_stream_stats.rb

@@ -0,0 +1,20 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require 'wsc_sdk/model'
+require 'wsc_sdk/models/transcoder_stats'
+
+module WscSdk
+  module Models
+
+    # A model to represent the Stats of a Live Stream in the Wowza Streaming
+    # Cloud API.
+    #
+    class LiveStreamStats < TranscoderStats
+
+      model_name_singular :live_stream
+      model_name_plural   :live_streams
+
+    end
+  end
+end

data/lib/wsc_sdk/models/live_stream_thumbnail_url.rb

@@ -0,0 +1,20 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+require 'wsc_sdk/model'
+require 'wsc_sdk/models/transcoder_thumbnail_url'
+
+module WscSdk
+  module Models
+
+    # A model to represent the Thumbnail URL of a Live Stream in the Wowza Streaming
+    # Cloud API.
+    #
+    class LiveStreamThumbnailUrl < TranscoderThumbnailUrl
+
+      model_name_singular :live_stream
+      model_name_plural   :live_streams
+
+    end
+  end
+end

data/lib/wsc_sdk/models/output.rb

@@ -0,0 +1,61 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+
+module WscSdk
+  module Models
+
+    # A model to repesent an Ouput in the Wowza Streaming Cloud API.
+    #
+    class Output < WscSdk::Model
+
+      model_name_singular :output
+      model_name_plural   :outputs
+
+
+      #---------------------------------------------------------------------------
+      #  ___     _
+      # / __| __| |_  ___ _ __  __ _
+      # \__ \/ _| ' \/ -_) '  \/ _` |
+      # |___/\__|_||_\___|_|_|_\__,_|
+      #
+      #---------------------------------------------------------------------------
+
+      attribute :id,                  :string,    access: :read
+      attribute :name,                :string,    access: :read
+      attribute :transcoder_id,       :string,    access: :read
+      attribute :stream_format,       :string
+      attribute :passthrough_video,   :boolean
+      attribute :passthrough_audio,   :boolean
+      attribute :aspect_ratio_height, :integer
+      attribute :aspect_ratio_width,  :integer
+      attribute :bitrate_audio,       :integer
+      attribute :bitrate_video,       :integer
+      attribute :h264_profile,        :string
+      attribute :framerate_reduction, :string
+      attribute :keyframes,           :string
+      attribute :created_at,          :datetime,  access: :read
+      attribute :updated_at,          :datetime,  access: :read
+
+      #---------------------------------------------------------------------------
+      #    _                   _      _   _
+      #   /_\   ______ ___  __(_)__ _| |_(_)___ _ _  ___
+      #  / _ \ (_-<_-</ _ \/ _| / _` |  _| / _ \ ' \(_-<
+      # /_/ \_\/__/__/\___/\__|_\__,_|\__|_\___/_||_/__/
+      #
+      #---------------------------------------------------------------------------
+
+
+      # Output Stream Targets endpoint for stream targets associated with the
+      # output.
+      #
+      # @return [WscSdk::Endpoints::OutputStreamTargets]
+      #   An instance of the OutputStreamTargets endpoint, with the results
+      #   limited to the outputs stream targets associted with this output.
+      #
+      def output_stream_targets
+        @output_stream_targets ||= WscSdk::Endpoints::OutputStreamTargets.new(endpoint.client, parent_path: endpoint.find_path(self.primary_key))
+      end
+
+    end
+  end
+end