wsc_sdk 1.3.1

data/examples/outputs/delete.rb

@@ -0,0 +1,39 @@
+####> 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"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil, output_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+output_id         = arguments[1]
+
+# Request the specific transcoder
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error retrieving the transcoder") unless transcoder.success?
+
+# Request the specific output
+output            = transcoder.outputs.find(output_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(output, "There was an error retrieving the output") unless output.success?
+
+# Delete the output
+result            = output.delete
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(result, "There was an error deleting the output") unless result.success?
+
+# If we've successfully deleted the output, then output some output about the
+# output. Note that the data for the output still exists locally in the
+# SDK, however the ID has been removed since it no longer references a
+# valid record in the API.
+# Defined in helpers.rb
+output_model_attributes(output, "Output: #{output.name}")

data/examples/outputs/find.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"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil, output_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+output_id         = arguments[1]
+
+# Request the specific transcoder
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error retrieving the transcoder") unless transcoder.success?
+
+# Request the specific output
+output            = transcoder.outputs.find(output_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(output, "There was an error retrieving the output") unless output.success?
+
+# If we've successfully found the output then output some output about the
+# output.
+# Defined in helpers.rb
+output_model_attributes(output, "Output: #{output.name}")

data/examples/outputs/list.rb

@@ -0,0 +1,29 @@
+####> 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"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the specific transcoder
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error retrieving the transcoder") unless transcoder.success?
+
+# Request the outputs list
+list              = transcoder.outputs.list
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(list, "There was an error retrieving the outputs list") unless list.success?
+
+# Output the list of outputs
+# Defined in helpers.rb
+output_model_list(list, "Outputs for transcoder '#{transcoder.name}':", false, :name)

data/examples/outputs/update.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.
+
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil, output_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+output_id         = arguments[1]
+
+# Request the specific transcoder
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error retrieving the transcoder") unless transcoder.success?
+
+# Request the specific output
+output            = transcoder.outputs.find(output_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(output, "There was an error retrieving the output")  unless output.success?
+
+# Modify the output
+output.bitrate_audio = 256
+output.bitrate_video = 8000
+
+# Make sure the output is valid
+unless output.valid?
+  puts "Invalid Output:"
+  output.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the results of saving the output
+saved             = output.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error updating the output")  unless saved.success?
+
+# If we've successfully found the output then output some output about the
+# output
+# Defined in helpers.rb
+output_model_attributes(output, "Output: #{output.name}")

data/examples/stream_targets/custom/create.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.
+
+require "wsc_sdk"
+require_relative "../../client"  # Include our client configuration
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present.
+arguments                 = ask_for_arguments(__FILE__, stream_target_name: nil, primary_url: nil, stream_name: nil)
+
+# Extract some data into convenience variables
+custom_stream_targets     = $client.stream_targets.custom
+
+# Build a RTMP/pull custom_stream_target using a predefined template, and modify a
+# few values
+name                      = arguments[0]
+primary_url               = arguments[1]
+stream_name               = arguments[2]
+custom_stream_target_data = WscSdk::Templates::CustomStreamTarget.akamai_hls(name, primary_url, stream_name)
+
+# Build the custom_stream_target object
+custom_stream_target      = custom_stream_targets.build(custom_stream_target_data)
+
+# If the custom_stream_target is invalid, output the messages and exit
+unless (custom_stream_target.valid?)
+  puts "Custom Stream Target is invalid:"
+
+  custom_stream_target.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved = custom_stream_target.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error creating the custom stream target") unless saved.success?
+
+# Output the custom stream target
+# Defined in helpers.rb
+output_model_attributes(custom_stream_target, "Custom Stream Target: #{custom_stream_target.name}")

data/examples/stream_targets/custom/delete.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"
+require_relative "../../client"  # Get our client
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments                 = ask_for_arguments(__FILE__, custom_stream_target_id: nil)
+
+# Extract some data into convenience variables
+custom_stream_targets     = $client.stream_targets.custom
+custom_stream_target_id   = arguments[0]
+
+# Request the custom_stream_target object
+custom_stream_target      = custom_stream_targets.find(custom_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(custom_stream_target, "There was an error finding the custom stream target") unless custom_stream_target.success?
+
+# Get the result of deleting the object from the API
+deleted                   = custom_stream_target.delete
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(deleted, "There was an error deleting the custom stream target") unless deleted.success?
+
+# If we've successfully deleted the custom_stream_target, then output the details.
+# Note that the data for the output still exists locally in the SDK, however the
+# ID has been removed since it no longer references a valid record in the API
+# Defined in helpers.rb
+output_model_attributes(custom_stream_target, "Custom Stream Target: #{custom_stream_target.name}")

data/examples/stream_targets/custom/find.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.
+
+require "wsc_sdk"
+require_relative "../../client"  # Get our client
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments                 = ask_for_arguments(__FILE__, custom_stream_target_id: nil)
+
+# Extract some data into convenience variables
+custom_stream_targets     = $client.stream_targets.custom
+custom_stream_target_id   = arguments[0]
+
+# Request the transcoder object
+custom_stream_target      = custom_stream_targets.find(custom_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(custom_stream_target, "There was an error finding the Custom stream target") unless custom_stream_target.success?
+
+# Output the custom stream target
+# Defined in helpers.rb
+output_model_attributes(custom_stream_target, "Custom Stream Target: #{custom_stream_target.name}")

data/examples/stream_targets/custom/list.rb

@@ -0,0 +1,24 @@
+####> 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"
+require_relative "../../client"  # Get our client
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments               = ask_for_arguments(__FILE__, pagination_page: 1, pagination_per_page: 25)
+
+# Extract some data into convenience variables
+stream_targets_custom   = $client.stream_targets.custom
+page                    = arguments[0]    # First argument is the page number (default: 1)
+per_page                = arguments[1]   # Second argument is the items per page (default: 25, max: 1000)
+
+# Request the list of custom stream targets using pagination parameters passed into the example.
+list                    = stream_targets_custom.list(pagination: { page: page.to_i, per_page: per_page.to_i })
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(list, "There was an error retrieving the list of the Custom stream targets") unless list.success?
+
+# Output the list of stream_targets_custom
+# Defined in helpers.rb
+output_model_list(list, "Custom Stream Targets: #{list.keys.length}", true, :name)

data/examples/stream_targets/custom/update.rb

@@ -0,0 +1,43 @@
+####> 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"
+require_relative "../../client"  # Get our client
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments                 = ask_for_arguments(__FILE__, custom_stream_target_id: nil, new_stream_target_name: nil)
+
+# Extract some data into convenience variables
+custom_stream_targets     = $client.stream_targets.custom
+custom_stream_target_id   = arguments[0]
+name                      = arguments[1]
+
+# Request the custom_stream_target object
+custom_stream_target      = custom_stream_targets.find(custom_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(custom_stream_target, "There was an error finding the custom stream target") unless custom_stream_target.success?
+
+# Update the custom_stream_target
+custom_stream_target.name = "My updated SDK custom_stream_target"
+
+# If the custom_stream_target is invalid, output the messages and exit
+unless (custom_stream_target.valid?)
+  puts "Custom Stream Target is invalid:"
+
+  custom_stream_target.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved = custom_stream_target.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error saving the custom stream target") unless saved.success?
+
+# Output the custom_stream_target details
+# Defined in helpers.rb
+output_model_attributes(custom_stream_target, "Custom Stream Target: #{custom_stream_target.name}")

data/examples/stream_targets/list.rb

@@ -0,0 +1,24 @@
+####> 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"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments               = ask_for_arguments(__FILE__, pagination_page: 1, pagination_per_page: 25)
+
+# Extract some data into convenience variables
+stream_targets  = $client.stream_targets
+page                    = arguments[0]    # First argument is the page number (default: 1)
+per_page                = arguments[1]   # Second argument is the items per page (default: 25, max: 1000)
+
+# Request the list of stream_targets using pagination
+list                    = stream_targets.list(pagination: { page: page.to_i, per_page: per_page.to_i })
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(list, "There was an error retrieving the list of stream targets") unless list.success?
+
+# Output the list of stream_targets
+# Defined in helpers.rb
+output_model_list(list, "Stream Targets: #{list.keys.length}", true, :name)

data/examples/stream_targets/ull/create.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.
+
+require "wsc_sdk"
+require_relative "../../client"  # Include our client configuration
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present.
+arguments                 = ask_for_arguments(__FILE__, stream_target_name: nil, source_url: nil)
+
+# Extract some data into convenience variables
+ull_stream_targets        = $client.stream_targets.ull
+
+# Build a RTMP/pull ull_stream_target using a predefined template, and modify a
+# few values
+name                      = arguments[0]
+source_url                = arguments[1]
+ull_stream_target_data    = WscSdk::Templates::UllStreamTarget.pull(name, source_url)
+
+# Build the ull_stream_target object
+ull_stream_target         = ull_stream_targets.build(ull_stream_target_data)
+
+# If the ull_stream_target is invalid, output the messages and exit
+unless (ull_stream_target.valid?)
+  puts "ULL Stream Target is invalid:"
+
+  ull_stream_target.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved = ull_stream_target.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error creating the ull stream target") unless saved.success?
+
+# Output the ULL stream target
+# Defined in helpers.rb
+output_model_attributes(ull_stream_target, "ULL Stream Target: #{ull_stream_target.name}")

data/examples/stream_targets/ull/delete.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"
+require_relative "../../client"  # Get our client
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments               = ask_for_arguments(__FILE__, ull_stream_target_id: nil)
+
+# Extract some data into convenience variables
+ull_stream_targets      = $client.stream_targets.ull
+ull_stream_target_id    = arguments[0]
+
+# Request the ull_stream_target object
+ull_stream_target       = ull_stream_targets.find(ull_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(ull_stream_target, "There was an error finding the ull stream target") unless ull_stream_target.success?
+
+# Get the result of deleting the object from the API
+deleted = ull_stream_target.delete
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(deleted, "There was an error deleting the ull stream target") unless deleted.success?
+
+# If we've successfully deleted the ull_stream_target, then output the details.
+# Note that the data for the output still exists locally in the SDK, however the
+# ID has been removed since it no longer references a valid record in the API.
+# Defined in helpers.rb
+output_model_attributes(ull_stream_target, "Ull Stream Target: #{ull_stream_target.name}")

data/examples/stream_targets/ull/find.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.
+
+require "wsc_sdk"
+require_relative "../../client"  # Get our client
+require_relative "../../helpers" # Include some helpers to make the code more direct
+
+# Ensure the args passed in are present
+arguments             = ask_for_arguments(__FILE__, ull_stream_target_id: nil)
+
+# Extract some data into convenience variables
+ull_stream_targets    = $client.stream_targets.ull
+ull_stream_target_id  = arguments[0]
+
+# Request the ull stream target object
+ull_stream_target     = ull_stream_targets.find(ull_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(ull_stream_target, "There was an error finding the Wowza stream target") unless ull_stream_target.success?
+
+# Output the ULL stream target
+# Defined in helpers.rb
+output_model_attributes(ull_stream_target, "Ull Stream Target: #{ull_stream_target.name}")