wsc_sdk 1.3.1

data/lib/wsc_sdk/endpoints/custom_stream_targets.rb

@@ -0,0 +1,44 @@
+####> 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 Endpoints
+
+    # An endpoint to manage Custom Stream Targets
+    #
+    class CustomStreamTargets < WscSdk::Endpoint
+
+      model_class WscSdk::Models::CustomStreamTarget
+
+      #---------------------------------------------------------------------------
+      #  ___      _   _
+      # | _ \__ _| |_| |_  ___
+      # |  _/ _` |  _| ' \(_-<
+      # |_| \__,_|\__|_||_/__/
+      #
+      #---------------------------------------------------------------------------
+
+      # Get the path for the list of models
+      #
+      # @return [String]
+      #   The list path.
+      #
+      def list_path
+        [ parent_path, "custom" ].compact.join("/")
+      end
+
+      # Get the path for an individual model.
+      #
+      # @param id [Any]
+      #   The unique id of the model.
+      #
+      # @return [String]
+      #   The model path.
+      #
+      def model_path(id)
+        [ parent_path, "custom", id ].compact.join("/")
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/endpoints/live_streams.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.
+
+module WscSdk
+  module Endpoints
+
+    # An endpoint to manage Live Streams
+    #
+    # @example Usage: Listing Live Streams
+    #
+    #   !!!ruby
+    #   # View the WscSdk::Client documentation for how to establish a client instance.
+    #   list = client.live_streams
+    #
+    #   list.each do |id, live_stream|
+    #     puts "#{id}: #{live_stream.name}"
+    #   ends
+    #
+    class LiveStreams < WscSdk::Endpoint
+
+      model_class WscSdk::Models::LiveStream
+
+      model_action :start,          :put, WscSdk::Models::LiveStreamState
+      model_action :stop,           :put, WscSdk::Models::LiveStreamState
+      model_action :reset,          :put, WscSdk::Models::LiveStreamState
+      model_action :state,          :get, WscSdk::Models::LiveStreamState
+      model_action :thumbnail_url,  :get, WscSdk::Models::LiveStreamThumbnailUrl
+      model_action :stats,          :get, WscSdk::Models::LiveStreamStats
+      model_action :regenerate_connection_code,
+                                    :put, WscSdk::Models::LiveStreamConnectionCode
+
+    end
+  end
+end

data/lib/wsc_sdk/endpoints/output_stream_targets.rb

@@ -0,0 +1,17 @@
+####> 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/models/output'
+
+module WscSdk
+  module Endpoints
+
+    # An endpoint to manage Output Stream Targets.
+    #
+    class OutputStreamTargets < WscSdk::Endpoint
+
+      model_class WscSdk::Models::OutputStreamTarget
+
+    end
+  end
+end

data/lib/wsc_sdk/endpoints/outputs.rb

@@ -0,0 +1,17 @@
+####> 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/models/output'
+
+module WscSdk
+  module Endpoints
+
+    # An endpoint to manage Outputs.
+    #
+    class Outputs < WscSdk::Endpoint
+
+      model_class WscSdk::Models::Output
+
+    end
+  end
+end

data/lib/wsc_sdk/endpoints/stream_targets.rb

@@ -0,0 +1,45 @@
+####> 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 Endpoints
+
+    # An endpoint to manage Stream Targets
+    #
+    class StreamTargets < WscSdk::Endpoint
+
+      model_class WscSdk::Models::StreamTarget
+
+      # Only allow the list action to be enabled.
+      actions include: :list
+
+      # Access the /stream_targets/wowza endpoints
+      #
+      # @return [Wsc::Endpoints::WowzaStreamTargets]
+      #   An instance of the WowzaStreamTargets endpoint class.
+      #
+      def wowza
+        WscSdk::Endpoints::WowzaStreamTargets.new(self.client, parent_path: self.list_path)
+      end
+
+      # Access the /stream_targets/custom endpoints
+      #
+      # @return [Wsc::Endpoints::CustomStreamTargets]
+      #   An instance of the CustomStreamTargets endpoint class.
+      #
+      def custom
+        WscSdk::Endpoints::CustomStreamTargets.new(self.client, parent_path: self.list_path)
+      end
+
+      # Access the /stream_targets/ull endpoints
+      #
+      # @return [Wsc::Endpoints::UllStreamTargets]
+      #   An instance of the UllStreamTargets endpoint class.
+      #
+      def ull
+        WscSdk::Endpoints::UllStreamTargets.new(self.client, parent_path: self.list_path)
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/endpoints/transcoders.rb

@@ -0,0 +1,38 @@
+####> 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 Endpoints
+
+    # An endpoint to manage Transcoders
+    #
+    # @example Usage: Listing Transcoders
+    #
+    #   !!!ruby
+    #   # View the WscSdk::Client documentation for how to establish a client instance.
+    #   list = client.transcoders
+    #
+    #   list.each do |id, transcoder|
+    #     puts "#{id}: #{transcoder.name}"
+    #   ends
+    #
+    class Transcoders < WscSdk::Endpoint
+
+      model_class WscSdk::Models::Transcoder
+
+      model_action :start,          :put, WscSdk::Models::TranscoderState
+      model_action :stop,           :put, WscSdk::Models::TranscoderState
+      model_action :reset,          :put, WscSdk::Models::TranscoderState
+      model_action :state,          :get, WscSdk::Models::TranscoderState
+      model_action :thumbnail_url,  :get, WscSdk::Models::TranscoderThumbnailUrl
+      model_action :stats,          :get, WscSdk::Models::TranscoderStats
+
+      model_action :enable_all_stream_targets,
+                                    :put, WscSdk::Models::TranscoderStreamTargetState
+
+      model_action :disable_all_stream_targets,
+                                    :put, WscSdk::Models::TranscoderStreamTargetState
+
+    end
+  end
+end

data/lib/wsc_sdk/endpoints/ull_stream_targets.rb

@@ -0,0 +1,44 @@
+####> 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 Endpoints
+
+    # An endpoint to manage Ultra Low Latency Stream Targets
+    #
+    class UllStreamTargets < WscSdk::Endpoint
+
+      model_class WscSdk::Models::UllStreamTarget
+
+      #---------------------------------------------------------------------------
+      #  ___      _   _
+      # | _ \__ _| |_| |_  ___
+      # |  _/ _` |  _| ' \(_-<
+      # |_| \__,_|\__|_||_/__/
+      #
+      #---------------------------------------------------------------------------
+
+      # Get the path for the list of models
+      #
+      # @return [String]
+      #   The list path.
+      #
+      def list_path
+        [ parent_path, "ull" ].compact.join("/")
+      end
+
+      # Get the path for an individual model.
+      #
+      # @param id [Any]
+      #   The unique id of the model.
+      #
+      # @return [String]
+      #   The model path.
+      #
+      def model_path(id)
+        [ parent_path, "ull", id ].compact.join("/")
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/endpoints/wowza_stream_targets.rb

@@ -0,0 +1,44 @@
+####> 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 Endpoints
+
+    # An endpoint to manage Wowza Stream Targets
+    #
+    class WowzaStreamTargets < WscSdk::Endpoint
+
+      model_class WscSdk::Models::WowzaStreamTarget
+
+      #---------------------------------------------------------------------------
+      #  ___      _   _
+      # | _ \__ _| |_| |_  ___
+      # |  _/ _` |  _| ' \(_-<
+      # |_| \__,_|\__|_||_/__/
+      #
+      #---------------------------------------------------------------------------
+
+      # Get the path for the list of models
+      #
+      # @return [String]
+      #   The list path.
+      #
+      def list_path
+        [ parent_path, "wowza" ].compact.join("/")
+      end
+
+      # Get the path for an individual model.
+      #
+      # @param id [Any]
+      #   The unique id of the model.
+      #
+      # @return [String]
+      #   The model path.
+      #
+      def model_path(id)
+        [ parent_path, "wowza", id ].compact.join("/")
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/enums.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.
+
+module WscSdk
+
+  # A module for defining sets of enumerators and their behaviors.
+  #
+  module Enums
+
+    # Get a list of values from constants defined in the enum.
+    #
+    # @return [Array<Any>]
+    #   The values defined by the enumerator.
+    #
+    def values
+      _values = []
+      self.constants(false).each { |constant| _values << self.const_get(constant) }
+      _values
+    end
+
+
+    # Convert a string or symbol into the appropriate constant, and generate
+    # an exception otherwise.
+    #
+    def to_constant(name)
+      constant_name = name.to_s.upcase.to_sym
+      raise "Model type '#{name.to_s}' doesn't exist" unless self.constants.include?(constant_name)
+      return self.const_get("#{self.name}::#{constant_name}")
+    end
+  end
+end

data/lib/wsc_sdk/enums/billing_mode.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.
+
+module WscSdk
+  module Enums
+
+    # Enumerates the billing modes for a Transcoder or Live Stream.
+    #
+    module BillingMode
+      extend WscSdk::Enums
+
+      # Define a Pay-as-you-go transcoder
+      PAY_AS_YOU_GO     = "pay_as_you_go"
+
+      # Define a 24x7 transcoder
+      TWENTY_FOUR_SEVEN = "twentyfour_seven"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/broadcast_location.rb

@@ -0,0 +1,58 @@
+####> 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 Enums
+
+    # Enumerate the valid user regions for a Trasncoder or Live Stream.
+    #
+    module BroadcastLocation
+      extend WscSdk::Enums
+
+      # Asia Pacific: Australia
+      ASIA_PACIFIC_AUSTRALIA  = "asia_pacific_australia"
+
+      # Asia Pacific: India
+      ASIA_PACIFIC_INDIA      = "asia_pacific_india"
+
+      # Asia Pacific: Japan
+      ASIA_PACIFIC_JAPAN      = "asia_pacific_japan"
+
+      # Asia Pacific: Singapore
+      ASIA_PACIFIC_SINGAPORE  = "asia_pacific_singapore"
+
+      # Asia Pacific: South Korea
+      ASIA_PACIFIC_S_KOREA    = "asia_pacific_s_korea"
+
+      # Asia Pacific: Taiwan
+      ASIA_PACIFIC_TAIWAN     = "asia_pacific_taiwan"
+
+      # Europe: Belgium
+      EU_BELGIUM              = "eu_belgium"
+
+      # Europe: Germany
+      EU_GERMANY              = "eu_germany"
+
+      # Europe: Ireland
+      EU_IRELAND              = "eu_ireland"
+
+      # South America: Brazil
+      SOUTH_AMERICA_BRAZIL    = "south_america_brazil"
+
+      # USA: Iowa
+      US_CENTRAL_IOWA         = "us_central_iowa"
+
+      # USA: South Carolina
+      US_EAST_S_CAROLINA      = "us_east_s_carolina"
+
+      # USA: Virginia
+      US_EAST_VIRGINIA        = "us_east_virginia"
+
+      # USA: California
+      US_WEST_CALIFORNIA      = "us_west_california"
+
+      # USA: Oregon
+      US_WEST_OREGON          = "us_west_oregon"
+    end
+  end
+end

data/lib/wsc_sdk/enums/buffer_size.rb

@@ -0,0 +1,41 @@
+####> 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 Enums
+
+    # Enumerate common buffer sizes within the appropriate range for a Transcoder.
+    #
+    module BufferSize
+      extend WscSdk::Enums
+
+      # Define no buffer.
+      NONE              = 0
+
+      # Define a 1 second buffer
+      ONE_SECOND        = 1000
+
+      # Define a 2 second buffer
+      TWO_SECONDS       = 2000
+
+      # Define a 3 second buffer
+      THREE_SECONDS     = 3000
+
+      # Define a 4 second buffer
+      FOUR_SECONDS      = 4000
+
+      # Define a 5 second buffer
+      FIVE_SECONDS      = 5000
+
+      # Define a 6 second buffer
+      SIX_SECONDS       = 6000
+
+      # Define a 7 second buffer
+      SEVEN_SECONDS     = 7000
+
+      # Define a 8 second buffer
+      EIGHT_SECONDS     = 8000
+
+    end
+  end
+end