wsc_sdk 1.3.1

data/examples/live_streams/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, if not ask for them.
+arguments       = ask_for_arguments(__FILE__, { pagination_page: 1, pagination_per_page: 25 })
+
+# Extract some data into convenience variables
+live_streams    = $client.live_streams
+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 live_streams using pagination
+list            = live_streams.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 live streams") unless list.success?
+
+# Output the list of live_streams
+# Defined in helpers.rb
+output_model_list(list, "Live Streams: #{list.keys.length}", true, :name)

data/examples/live_streams/regenerate_connection_code.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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Regenerate the connection code
+connection_code   = live_stream.regenerate_connection_code
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(connection_code, "There was an error regenerating the connection code") unless connection_code.success?
+
+# Output the live_stream connection code
+# Defined in the helpers.rb file.
+output_model_attributes(connection_code, "Live Stream Connection Code:")

data/examples/live_streams/reset.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.
+
+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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Get the result of resetting the live_stream
+#
+# NOTE: You can also reset and wait for the live_stream state to transition to
+# a reset state.  See the `reset_and_wait` example.
+state = live_stream.reset
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error resetting the live stream") unless state.success?
+
+# Output the final state of the live stream
+# Defined in the helpers.rb file.
+output_model_attributes(state, "Live Stream State:")

data/examples/live_streams/reset_and_wait.rb

@@ -0,0 +1,51 @@
+####> 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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Get the result of resetting the live_stream.  We add a code block, which
+# instructs the SDK to enter a wait loop and periodically polls the API
+# for the live_stream state until either the `started` state is returned or
+# the timeout period is reached.
+state = live_stream.reset do |wait_state, live_stream_state|
+
+  # This code will execute each time the state of the live_stream is polled
+  # during the wait loop. You can check the wait_state to determine what the
+  # outcomes of each request are.
+
+  if wait_state == :waiting
+    # We're still waiting for the started state to be returned
+    puts "Waiting..."
+  elsif wait_state == :complete
+    # We've successfully reset the live_stream, so output the state
+    # Defined in the helpers.rb file.
+    output_model_attributes(live_stream_state, "Completed Live Stream State:")
+  elsif wait_state == :timeout
+    # A timeout occurs if the reset state isn't reached within the timeout
+    # limit, which defaults to 30 seconds.
+
+    puts "TIMEOUT: Could not reset the live_stream within the timeout period."
+  end
+end
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error starting the live stream") unless state.success?
+
+# Output the final state of the live stream
+# Defined in the helpers.rb file.
+output_model_attributes(state, "Live Stream State:")

data/examples/live_streams/start.rb

@@ -0,0 +1,33 @@
+####> 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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Get the result of starting the live_stream
+#
+# NOTE: You can also start and wait for the live_stream state to transition to
+# a started state.  See the `start_and_wait` example.
+#
+state = live_stream.start
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error starting the live stream") unless state.success?
+
+# Output the live_stream state
+# Defined in helper.rb
+output_model_attributes(state, "Live Stream State:")

data/examples/live_streams/start_and_wait.rb

@@ -0,0 +1,51 @@
+####> 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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Get the result of starting the live_stream.  We add a code block, which
+# instructs the SDK to enter a wait loop, and periodically polls the API
+# for the live_stream state until either the `started` state is returned or
+# the timeout period is reached.
+state = live_stream.start do |wait_state, live_stream_state|
+
+  # This code will execute each time the state of the live_stream is polled
+  # during the wait loop.  You can check the wait_state to determine what the
+  # outcomes of each request are.
+
+  if wait_state == :waiting
+    # We're still waiting for the started state to be returned
+    puts "Waiting..."
+  elsif wait_state == :complete
+    # We've successfully started the live_stream, output the state
+    # Defined in the helpers.rb file.
+    output_model_attributes(live_stream_state, "Completed Live Stream State:")
+  elsif wait_state == :timeout
+    # A timeout occurs if the start state isn't reached within the timeout
+    # limit, which defaults to 30 seconds.
+
+    puts "TIMEOUT: Could not start the live stream within the timeout period."
+  end
+end
+
+# Handle an API error.  (In the helpers.rb file)
+handle_api_error(state, "There was an error starting the live stream") unless state.success?
+
+# Output the final state of the live stream.
+# Defined in the helpers.rb file.
+output_model_attributes(state, "Live Stream State:")

data/examples/live_streams/state.rb

@@ -0,0 +1,33 @@
+####> 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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Get the result of stopping the live_stream
+#
+# NOTE: You can also stop and wait for the live_stream state to transition to
+# a stopped state.  See the `stop_and_wait` example.
+#
+state = live_stream.state
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the live stream state") unless state.success?
+
+# Output the live_stream state
+# Defined in helpers.rb
+output_model_attributes(state, "Live Stream State:")

data/examples/live_streams/stats.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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Request the live_stream state
+state = live_stream.state
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the live stream state") unless state.success?
+
+# Ensure the live_stream is started
+if state.state != 'started'
+  # Start the live_stream and wait
+  result = live_stream.start do |wait_state, live_stream_state|
+    puts "Waiting for live_stream to start"
+  end
+end
+
+# Request the current statistics from the live_stream
+stats = live_stream.stats
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(stats, "There was an error getting the live stream stats") unless stats.success?
+
+# Output the current live_stream statistics
+# Defined in helper.rb
+output_model_attributes(stats, "Live Stream Stats:")

data/examples/live_streams/stop.rb

@@ -0,0 +1,33 @@
+####> 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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Get the result of stopping the live_stream
+#
+# NOTE: You can also stop and wait for the live_stream state to transition to
+# a stopped state.  See the `stop_and_wait` example.
+#
+state = live_stream.stop
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the live stream state") unless state.success?
+
+# Output the live_stream state
+# Defined in helpers.rb
+output_model_attributes(state, "Live Stream State:")

data/examples/live_streams/stop_and_wait.rb

@@ -0,0 +1,51 @@
+####> 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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Get the result of stopping the live_stream.  We add a code block, which
+# instructs the SDK to enter a wait loop and periodically polls the API
+# for the live_stream state until either the `stopped` state is returned or
+# the timeout period is reached.
+state = live_stream.stop do |wait_state, live_stream_state|
+
+  # This code will execute each time the state of the live_stream is polled
+  # during the wait loop.  You can check the wait_state to determine what the
+  # outcomes of each request are.
+
+  if wait_state == :waiting
+    # We're still waiting for the stopped state to be returned
+    puts "Waiting..."
+  elsif wait_state == :complete
+    # We've successfully stopped the live_stream
+    # Defined in helpers.rb
+    output_model_attributes(live_stream_state, "Completed Live Stream State:")
+  elsif wait_state == :timeout
+    # A timeout occurs if the stop state isn't reached within the timeout
+    # limit, which defaults to 30 seconds.
+
+    puts "TIMEOUT: Could not stop the live stream within the timeout period."
+  end
+end
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error stopping the live stream") unless state.success?
+
+# Output the final live_stream state
+# Defined in helpers.rb
+output_model_attributes(state, "Final Live Stream State:")

data/examples/live_streams/thumbnail_url.rb

@@ -0,0 +1,46 @@
+####> 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__, live_stream_id: nil)
+
+# Extract some data into convenience variables
+live_streams     = $client.live_streams
+live_stream_id   = arguments[0]
+
+# Request the live_stream object
+live_stream      = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Request the live_stream state
+state           = live_stream.state
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error getting the live stream state") unless state.success?
+
+# Ensure the live_stream is started
+if state.state != 'started'
+  # Start the live_stream and wait
+  state = live_stream.start do |wait_state, live_stream_state|
+    puts "Waiting for live_stream to start"
+  end
+
+  # Handle an API error (in the helpers.rb file)
+  handle_api_error(state, "There was an error starting the live stream") unless state.success?
+end
+
+# Request the thumbnail url
+thumbnail       = live_stream.thumbnail_url
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(thumbnail, "There was an error getting the live stream thumbnail url") unless thumbnail.success?
+
+# Output the thumbnail URL
+# Defined in helpers.rb
+output_model_attributes(thumbnail, "Live Stream Thumbnail:")

data/examples/live_streams/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__, live_stream_id: nil, new_live_stream_name: nil)
+
+# Extract some data into convenience variables
+live_streams     = $client.live_streams
+live_stream_id   = arguments[0]
+live_stream_name = arguments[1]
+
+# Request the live_stream object
+live_stream      = live_streams.find(live_stream_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+
+# Update the live_stream
+live_stream.name   = live_stream_name
+
+# If the live_stream is invalid, output the messages and exit
+unless (live_stream.valid?)
+  puts "Live Stream is invalid:"
+
+  live_stream.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved = live_stream.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error saving the live stream") unless saved.success?
+
+# Output the live_stream details
+# Defined in helpers.rb
+output_model_attributes(live_stream, "Live Stream: #{live_stream.name}")