wsc_sdk 1.3.1

data/lib/wsc_sdk/enums/closed_caption_type.rb

@@ -0,0 +1,26 @@
+####> 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 types of closed caption interpretation for a Transcoder.
+    #
+    module ClosedCaptionType
+      extend WscSdk::Enums
+
+      # No closed captioning.
+      NONE    = "none"
+
+      # Generate CEA closed captioning.
+      CEA     = "cea"
+
+      # Generate On Text closed captioning.
+      ON_TEXT = "on_text"
+
+      # Generate both types of closed captioning.
+      BOTH    = "both"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/custom_provider.rb

@@ -0,0 +1,32 @@
+####> 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 valid transcoder types.
+    #
+    module CustomProvider
+      extend WscSdk::Enums
+
+      # Akamai Custom Provider
+      AKAMAI_HD     = "akamai"
+
+      # Akamai Cupertino Custom Provider
+      AKAMAI_HLS    = "akamai_cupertino"
+
+      # Akamai RTMP Custom Provider
+      AKAMAI_RTMP    = "akamai_rtmp"
+
+      # Limelight Custom Provider
+      LIMELIGHT     = "limelight"
+
+      # RTMP Custom Provider
+      RTMP          = "rtmp"
+
+      # UStream Custom Provider
+      USTREAM       = "ustream"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/delivery_method.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
+
+    # Enumerate the delivery methods for a Transcoder or Live Stream
+    #
+    module DeliveryMethod
+      extend WscSdk::Enums
+
+      # Push content to the Transcoder or Live Stream.
+      PUSH    = "push"
+
+      # Pull content into the Transcoder or Live Stream.
+      PULL    = "pull"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/delivery_type.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
+
+    # Enumerate the delivery methods for a Transcoder or Live Stream
+    #
+    module DeliveryType
+      extend WscSdk::Enums
+
+      # Deliver a single-bitrate stream from WSE to the live stream/transcoder
+      SINGLE_BITRATE  = "single-bitrate"
+
+      # Deliver a multi-bitrate stream from WSE to the live stream/transcoder
+      MULTI_BITRATE   = "multi-bitrate"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/encoder.rb

@@ -0,0 +1,71 @@
+####> 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 delivery methods for a Transcoder or Live Stream
+    #
+    module Encoder
+      extend WscSdk::Enums
+
+      # WSE Encoder
+      WOWZA_STREAMING_ENGINE = "wowza_streaming_engine"
+
+      # Wowza GoCoder Encoder
+      WOWZA_GOCODER          = "wowza_gocoder"
+
+      # Media DS Encoder
+      MEDIA_DS               = "media_ds"
+
+      # Axis Encoder
+      AXIS                   = "axis"
+
+      # Epiphan Encoder
+      EPIPHAN                = "epiphan"
+
+      # Hauppauge Encoder
+      HAUPPAUGE              = "hauppauge"
+
+      # JVC Encoder
+      JVC                    = "jvc"
+
+      # Live-U Encoder
+      LIVE_U                 = "live_u"
+
+      # Matrox Encoder
+      MATROX                 = "matrox"
+
+      # NewTek Tricaster Encoder
+      NEWTEK_TRICASTER       = "newtek_tricaster"
+
+      # Osprey Encoder
+      OSPREY                 = "osprey"
+
+      # Sony Encoder
+      SONY                   = "sony"
+
+      # Telestream Wirecast Encoder
+      TELESTREAM_WIRECAST    = "telestream_wirecast"
+
+      # Teradek Cube Encoder
+      TERADEK_CUBE           = "teradek_cube"
+
+      # VMix Encoder
+      VMIX                   = "vmix"
+
+      # X Split Encoder
+      X_SPLIT                = "x_split"
+
+      # IP Camera Encoder
+      IP_CAMERA              = "ipcamera"
+
+      # Other RTMP Encoder
+      OTHER_RTMP             = "other_rtmp"
+
+      # Other RTSP Encoder
+      OTHER_RTSP             = "other_rtsp"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/idle_timeout.rb

@@ -0,0 +1,50 @@
+####> 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 valid idle timeouts for a Transcoder.
+    #
+    module IdleTimeout
+      extend WscSdk::Enums
+
+      # No idle timeout.  The transcoder will run without stopping automatically
+      NONE            = 0
+
+      # Timeout after 1 minute of inactivity from the source.
+      ONE_MINUTE      = 1
+
+      # Timeout after 10 minutes of inactivity from the source.
+      TEN_MINUTES     = 600
+
+      # Timeout after 20 minutes of inactivity from the source.
+      TWENTY_MINUTES  = 1200
+
+      # Timeout after 30 minutes of inactivity from the source.
+      THIRTY_MINUTES  = 1800
+
+      # Timeout after 1 hour of inactivity from the source.
+      ONE_HOUR        = 3600
+
+      # Timeout after 6 hours of inactivity from the source.
+      SIX_HOURS       = 21600
+
+      # Timeout after 12 hours of inactivity from the source.
+      TWELVE_HOURS    = 43200
+
+      # Timeout after 1 day of inactivity from the source.
+      ONE_DAY         = 86400
+
+      # Timeout after 2 days of inactivity from the source.
+      TWO_DAYS        = 172800
+
+      # Return the valid range of values for the idle timeout.
+      #
+      def self.values
+        (NONE..TWO_DAYS)
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/image_position.rb

@@ -0,0 +1,26 @@
+####> 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 valid transcoder types.
+    #
+    module ImagePosition
+      extend WscSdk::Enums
+
+      # Position watermark in the top left corner of the stream
+      TOP_LEFT      = "top-left"
+
+      # Position watermark in the top right corner of the stream
+      TOP_RIGHT     = "top-right"
+
+      # Position watermark in the bottom left corner of the stream
+      BOTTOM_LEFT   = "bottom-left"
+
+      # Position watermark in the bottom left corner of the stream
+      BOTTOM_RIGHT  = "bottom-right"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/player_type.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
+
+    # Enumerate the delivery methods for a Transcoder or Live Stream
+    #
+    module PlayerType
+      extend WscSdk::Enums
+
+      # Original HTML5 Player
+      ORIGINAL_HTML5  = "original_html5"
+
+      # Wowza Player
+      WOWZA           = "wowza_player"
+      
+    end
+  end
+end

data/lib/wsc_sdk/enums/protocol.rb

@@ -0,0 +1,23 @@
+####> 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 valid protocols for a Transcoder or Live Stream.
+    #
+    module Protocol
+      extend WscSdk::Enums
+
+      # The RTMP protocol.
+      RTMP    = "rtmp"
+
+      # The RTSP protocol.
+      RTSP    = "rtsp"
+
+      # The Wowza protocol (used for ULL)
+      WOWZ    = "wowz"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/target_delivery_protocol.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
+
+    # Enumerate the delivery methods for a Transcoder or Live Stream
+    #
+    module TargetDeliveryProtocol
+      extend WscSdk::Enums
+
+      # Push content to the Transcoder or Live Stream.
+      HLS_HTTPS           = "hls-https"
+
+      # Pull content into the Transcoder or Live Stream.
+      HLS_HDS             = "hls-hds"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/transcoder_type.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
+
+    # Enumerate valid transcoder types.
+    #
+    module TranscoderType
+      extend WscSdk::Enums
+
+      # A transcoded stream type
+      TRANSCODED    = "transcoded"
+
+      # A passthrough stream type
+      PASSTHROUGH   = "passthrough"
+
+    end
+  end
+end

data/lib/wsc_sdk/enums/wowza_provider.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
+
+    # Enumerate valid transcoder types.
+    #
+    module WowzaProvider
+      extend WscSdk::Enums
+
+      # Akamai Wowza Provider
+      AKAMAI            = "akamai"
+
+      # Akamai Cupertino Wowza Provider
+      AKAMAI_CUPERTINO  = "akamai_cupertino"
+
+    end
+  end
+end

data/lib/wsc_sdk/errors.rb

@@ -0,0 +1,115 @@
+####> 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
+  # Enumerate the errors that can be generated by the SDK
+  #
+  module Errors
+    # Error returned when the model does not validate.
+    #
+    INVALID_ATTRIBUTES    = {
+      meta: {
+        status:       422,
+        code:         "ERR-422-InvalidAttributes",
+        title:        "Invalid Attributes",
+        message:      "The model has invalid attribute values assigned to it.  Check the `WscSdk::Model#errors` property for more details.",
+        description:  ""
+      }
+    }
+
+    # Error returned if the data returned from the API is not valid JSON.
+    #
+    INVALID_PAYLOAD  = {
+      meta: {
+        status:       422,
+        code:         "ERR-422-PayloadInvalid",
+        title:        "Payload Invalid",
+        message:      "The API request received an invalid payload.",
+        description:  "Turn on logging in DEBUG mode for more details about the issue."
+      }
+    }
+
+    # Error returned when the model is attempting an update, but it doesn't
+    # have a primary key.
+    #
+    MODEL_DOES_NOT_EXIST  = {
+      meta: {
+        status:       422,
+        code:         "ERR-422-ModelDoesNotExist",
+        title:        "Model Does Not Exist",
+        message:      "You are attempting to access or update a record that does not exist yet. Try creating it first.",
+        description:  ""
+      }
+    }
+
+    # Error returned when the model is attempting to create, but it already
+    # has a primary key.
+    #
+    MODEL_EXISTS  = {
+      meta: {
+        status:       422,
+        code:         "ERR-422-ModelExists",
+        title:        "Model Exists",
+        message:      "You are attempting to create a record that already exists. Try updating the it.",
+        description:  ""
+      }
+    }
+
+    # Build an INVALID_ATTRIBUTES error model object.
+    #
+    # @param endpoint [WscSdk::Endpoint]
+    #   The endpoint that is building the error.
+    #
+    # @return [WscSdk::Models::Error]
+    #   The newly built error object.
+    #
+    def self.invalid_attributes(endpoint)
+      error = WscSdk::Models::Error.new(endpoint)
+      error.ingest_attributes(INVALID_ATTRIBUTES, write_to_read_only: true, mark_clean: true)
+      error
+    end
+
+    # Build an INVALID_PAYLOAD error model object.
+    #
+    # @param endpoint [WscSdk::Endpoint]
+    #   The endpoint that is building the error.
+    #
+    # @return [WscSdk::Models::Error]
+    #   The newly built error object.
+    #
+    def self.invalid_payload(endpoint)
+      error = WscSdk::Models::Error.new(endpoint)
+      error.ingest_attributes(INVALID_PAYLOAD, write_to_read_only: true, mark_clean: true)
+      error
+    end
+
+    # Build an RECORD_DOES_NOT_EXIST error model object.
+    #
+    # @param endpoint [WscSdk::Endpoint]
+    #   The endpoint that is building the error.
+    #
+    # @return [WscSdk::Models::Error]
+    #   The newly built error object.
+    #
+    def self.model_does_not_exist(endpoint)
+      error = WscSdk::Models::Error.new(endpoint)
+      error.ingest_attributes(MODEL_DOES_NOT_EXIST, write_to_read_only: true, mark_clean: true)
+      error
+    end
+
+    # Build an RECORD_EXISTS error model object.
+    #
+    # @param endpoint [WscSdk::Endpoint]
+    #   The endpoint that is building the error.
+    #
+    # @return [WscSdk::Models::Error]
+    #   The newly built error object.
+    #
+    def self.model_exists(endpoint)
+      error = WscSdk::Models::Error.new(endpoint)
+      error.ingest_attributes(MODEL_EXISTS, write_to_read_only: true, mark_clean: true)
+      error
+    end
+
+  end
+end