wsc_sdk 1.3.1

data/lib/wsc_sdk/templates/custom_stream_target.rb

@@ -0,0 +1,154 @@
+####> 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/enums/custom_provider'
+
+module WscSdk
+  module Templates
+
+    # Templates for generating Custom Stream Targets
+    #
+    class CustomStreamTarget < ModelTemplate
+
+      # A template to build an Akamai HLS custom stream target
+      #
+      # @param [String] name
+      #   The name of the transcoder
+      #
+      # @param [String] primary_url
+      #   The primary URL of the stream target.
+      #
+      # @param [String] stream_name
+      #   The name of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.akamai_hd(name, primary_url, stream_name, modifiers={})
+        self.merge({
+          name:                         name,
+          provider:                     WscSdk::Enums::CustomProvider::AKAMAI_HD,
+          primary_url:                  primary_url,
+          stream_name:                  stream_name
+        }, modifiers)
+      end
+
+      # A template to build an Akamai HD custom stream target
+      #
+      # @param [String] name
+      #   The name of the transcoder
+      #
+      # @param [String] primary_url
+      #   The primary URL of the stream target.
+      #
+      # @param [String] stream_name
+      #   The name of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.akamai_hls(name, primary_url, stream_name, modifiers={})
+        self.merge({
+          name:                         name,
+          provider:                     WscSdk::Enums::CustomProvider::AKAMAI_HLS,
+          primary_url:                  primary_url,
+          stream_name:                  stream_name
+        }, modifiers)
+      end
+
+      # A template to build an Akamai RTMP custom stream target
+      #
+      # @param [String] name
+      #   The name of the transcoder
+      #
+      # @param [String] primary_url
+      #   The primary URL of the stream target.
+      #
+      # @param [String] stream_name
+      #   The name of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.akamai_rtmp(name, primary_url, stream_name, modifiers={})
+        self.merge({
+          name:                         name,
+          provider:                     WscSdk::Enums::CustomProvider::AKAMAI_RTMP,
+          primary_url:                  primary_url,
+          stream_name:                  stream_name
+        }, modifiers)
+      end
+
+
+      # A template to build a Limelight custom stream target
+      #
+      # @param [String] name
+      #   The name of the transcoder
+      #
+      # @param [String] primary_url
+      #   The primary URL of the stream target.
+      #
+      # @param [String] stream_name
+      #   The name of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.limelight(name, primary_url, stream_name, modifiers={})
+        self.merge({
+          name:                         name,
+          provider:                     WscSdk::Enums::CustomProvider::LIMELIGHT,
+          primary_url:                  primary_url,
+          stream_name:                  stream_name
+        }, modifiers)
+      end
+
+      # A template to build an RTMP custom stream target
+      #
+      # @param [String] name
+      #   The name of the transcoder
+      #
+      # @param [String] primary_url
+      #   The primary URL of the stream target.
+      #
+      # @param [String] stream_name
+      #   The name of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.rtmp(name, primary_url, stream_name, modifiers={})
+        self.merge({
+          name:                         name,
+          provider:                     WscSdk::Enums::CustomProvider::RTMP,
+          primary_url:                  primary_url,
+          stream_name:                  stream_name
+        }, modifiers)
+      end
+
+      # A template to build an UStream custom stream target
+      #
+      # @param [String] name
+      #   The name of the transcoder
+      #
+      # @param [String] primary_url
+      #   The primary URL of the stream target.
+      #
+      # @param [String] stream_name
+      #   The name of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.ustream(name, primary_url, stream_name, modifiers={})
+        self.merge({
+          name:                         name,
+          provider:                     WscSdk::Enums::CustomProvider::USTREAM,
+          primary_url:                  primary_url,
+          stream_name:                  stream_name
+        }, modifiers)
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/templates/live_stream.rb

@@ -0,0 +1,234 @@
+####> 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 Templates
+
+    # Templates for generating Live Streams
+    #
+    class LiveStream < ModelTemplate
+
+      # A template to build a Wowza Streaming Engine Live Stream with
+      # single-bitrate delivery
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.wse_single_bitrate(name, width, height, modifiers={})
+        self.merge({
+          name:                   name,
+          encoder:                WscSdk::Enums::Encoder::WOWZA_STREAMING_ENGINE,
+          broadcast_location:     WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:     width,
+          aspect_ratio_height:    height,
+          delivery_type:          WscSdk::Enums::DeliveryType::SINGLE_BITRATE,
+          delivery_method:        WscSdk::Enums::DeliveryMethod::PUSH
+        }, modifiers)
+      end
+
+      # A template to build a Wowza Streaming Engine Live Stream with
+      # single-bitrate delivery
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.wse_multi_bitrate(name, width, height, modifiers={})
+        self.merge({
+          name:                       name,
+          encoder:                    WscSdk::Enums::Encoder::WOWZA_STREAMING_ENGINE,
+          broadcast_location:         WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:         width,
+          aspect_ratio_height:        height,
+          delivery_type:              WscSdk::Enums::DeliveryType::MULTI_BITRATE,
+          delivery_method:            WscSdk::Enums::DeliveryMethod::PUSH
+        }, modifiers)
+      end
+
+      # A template to build a Wowza GoCoder Live Stream with
+      # multi-bitrate delivery
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.gocoder(name, width, height, modifiers={})
+        self.merge({
+          name:                       name,
+          encoder:                    WscSdk::Enums::Encoder::WOWZA_GOCODER,
+          broadcast_location:         WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:         width,
+          aspect_ratio_height:        height,
+          delivery_method:            WscSdk::Enums::DeliveryMethod::PUSH
+        }, modifiers)
+      end
+
+
+      # A template to build an IP Camera Live Stream with with RTSP/PULL
+      # delivery.
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [String] source_url
+      #   The source url of the IP camera.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.ip_camera(name, width, height, source_url, modifiers={})
+        self.merge({
+          name:                       name,
+          encoder:                    WscSdk::Enums::Encoder::IP_CAMERA,
+          broadcast_location:         WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:         width,
+          aspect_ratio_height:        height,
+          source_url:                 source_url,
+          delivery_method:            WscSdk::Enums::DeliveryMethod::PULL
+        }, modifiers)
+      end
+
+      # A template to build an Other RTMP/PUSH Live Stream
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.rtmp_push(name, width, height, modifiers={})
+        self.merge({
+          name:                       name,
+          encoder:                    WscSdk::Enums::Encoder::OTHER_RTMP,
+          delivery_method:            WscSdk::Enums::DeliveryMethod::PUSH,
+          broadcast_location:         WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:         width,
+          aspect_ratio_height:        height
+        }, modifiers)
+      end
+
+      # A template to build an Other RTMP/PULL Live Stream
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [String] source_url
+      #   The source url of the IP camera.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.rtmp_pull(name, width, height, source_url, modifiers={})
+        self.merge({
+          name:                       name,
+          encoder:                    WscSdk::Enums::Encoder::OTHER_RTMP,
+          protocol:                   WscSdk::Enums::Protocol::RTMP,
+          delivery_method:            WscSdk::Enums::DeliveryMethod::PULL,
+          broadcast_location:         WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:         width,
+          aspect_ratio_height:        height,
+          source_url:                 source_url
+        }, modifiers)
+      end
+
+
+      # A template to build an Other RTSP/PUSH Live Stream
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.rtsp_push(name, width, height, modifiers={})
+        self.merge({
+          name:                       name,
+          encoder:                    WscSdk::Enums::Encoder::OTHER_RTSP,
+          delivery_method:            WscSdk::Enums::DeliveryMethod::PUSH,
+          broadcast_location:         WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:         width,
+          aspect_ratio_height:        height
+        }, modifiers)
+      end
+
+      # A template to build an Other RTSP/PULL Live Stream
+      #
+      # @param [String] name
+      #   The name of the live stream.
+      #
+      # @param [Integer] width
+      #   The width of the largest rendition of the stream.
+      #
+      # @param [Integer] height
+      #   The height of the largest rendition of the stream.
+      #
+      # @param [String] source_url
+      #   The source url of the IP camera.
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.rtsp_pull(name, width, height, source_url, modifiers={})
+        self.merge({
+          name:                       name,
+          encoder:                    WscSdk::Enums::Encoder::OTHER_RTSP,
+          delivery_method:            WscSdk::Enums::DeliveryMethod::PULL,
+          broadcast_location:         WscSdk::Enums::BroadcastLocation::US_WEST_CALIFORNIA,
+          aspect_ratio_width:         width,
+          aspect_ratio_height:        height,
+          source_url:                 source_url
+        }, modifiers)
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/templates/output.rb

@@ -0,0 +1,133 @@
+####> 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 Templates
+
+    # Templates for generating Outputs
+    #
+    class Output < ModelTemplate
+
+      # Generate a Full HD output (1920x1080).
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.full_hd(modifiers={})
+        self.merge({
+          stream_format:        "audiovideo",
+          passthrough_video:    false,
+          passthrough_audio:    false,
+          aspect_ratio_height:  1080,
+          aspect_ratio_width:   1920,
+          bitrate_audio:        128,
+          bitrate_video:        4000,
+          h264_profile:         "high",
+          framerate_reduction:  "0",
+          keyframes:            "follow_source"
+        }, modifiers)
+      end
+
+      # Generate an HD output (1280x720)
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.hd(modifiers={})
+        self.merge({
+          stream_format:        "audiovideo",
+          passthrough_video:    false,
+          passthrough_audio:    false,
+          aspect_ratio_height:  720,
+          aspect_ratio_width:   1280,
+          bitrate_audio:        128,
+          bitrate_video:        2600,
+          h264_profile:         "high",
+          framerate_reduction:  "0",
+          keyframes:            "follow_source",
+        }, modifiers)
+      end
+
+
+      # Generate an SD wide screen output (854x480)
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.sd_wide(modifiers={})
+        self.merge({
+          stream_format:        "audiovideo",
+          passthrough_video:    false,
+          passthrough_audio:    false,
+          aspect_ratio_height:  480,
+          aspect_ratio_width:   854,
+          bitrate_audio:        128,
+          bitrate_video:        1600,
+          h264_profile:         "main",
+          framerate_reduction:  "0",
+          keyframes:            "follow_source",
+        }, modifiers)
+      end
+
+      # Generate a larger sized low res output (640x360)
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.low_res_large(modifiers={})
+        self.merge({
+          stream_format:        "audiovideo",
+          passthrough_video:    false,
+          passthrough_audio:    false,
+          aspect_ratio_height:  360,
+          aspect_ratio_width:   640,
+          bitrate_audio:        128,
+          bitrate_video:        1024,
+          h264_profile:         "main",
+          framerate_reduction:  "0",
+          keyframes:            "follow_source",
+        }, modifiers)
+      end
+
+      # Generate a medium sized low res output (512x288)
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.low_res_medium(modifiers={})
+        self.merge({
+          stream_format:        "audiovideo",
+          passthrough_video:    false,
+          passthrough_audio:    false,
+          aspect_ratio_height:  288,
+          aspect_ratio_width:   512,
+          bitrate_audio:        128,
+          bitrate_video:        512,
+          h264_profile:         "baseline",
+          framerate_reduction:  "0",
+          keyframes:            "follow_source",
+        }, modifiers)
+      end
+
+      # Generate a smaller sized low res output (320x180)
+      #
+      # @param [Hash] modifiers
+      #   A hash of key/value modifiers to change data in the template.
+      #
+      def self.low_res_small(modifiers={})
+        self.merge({
+          stream_format:        "audiovideo",
+          passthrough_video:    false,
+          passthrough_audio:    false,
+          aspect_ratio_height:  180,
+          aspect_ratio_width:   320,
+          bitrate_audio:        128,
+          bitrate_video:        320,
+          h264_profile:         "baseline",
+          framerate_reduction:  "0",
+          keyframes:            "follow_source",
+        }, modifiers)
+      end
+    end
+  end
+end