Module: WscSdk

Defined in:

lib/wsc_sdk/enums.rb,
lib/wsc_sdk.rb,
lib/wsc_sdk/model.rb,
lib/wsc_sdk/client.rb,
lib/wsc_sdk/errors.rb,
lib/wsc_sdk/schema.rb,
lib/wsc_sdk/version.rb,
lib/wsc_sdk/endpoint.rb,
lib/wsc_sdk/constants.rb,
lib/wsc_sdk/model_list.rb,
lib/wsc_sdk/pagination.rb,
lib/wsc_sdk/models/error.rb,
lib/wsc_sdk/configuration.rb,
lib/wsc_sdk/enums/encoder.rb,
lib/wsc_sdk/models/output.rb,
lib/wsc_sdk/enums/protocol.rb,
lib/wsc_sdk/model_template.rb,
lib/wsc_sdk/modules/loggable.rb,
lib/wsc_sdk/schema_attribute.rb,
lib/wsc_sdk/templates/output.rb,
lib/wsc_sdk/endpoints/outputs.rb,
lib/wsc_sdk/enums/buffer_size.rb,
lib/wsc_sdk/enums/player_type.rb,
lib/wsc_sdk/models/transcoder.rb,
lib/wsc_sdk/enums/billing_mode.rb,
lib/wsc_sdk/enums/idle_timeout.rb,
lib/wsc_sdk/models/live_stream.rb,
lib/wsc_sdk/enums/delivery_type.rb,
lib/wsc_sdk/enums/image_position.rb,
lib/wsc_sdk/enums/wowza_provider.rb,
lib/wsc_sdk/models/stream_target.rb,
lib/wsc_sdk/modules/api_response.rb,
lib/wsc_sdk/templates/transcoder.rb,
lib/wsc_sdk/endpoints/transcoders.rb,
lib/wsc_sdk/enums/custom_provider.rb,
lib/wsc_sdk/enums/delivery_method.rb,
lib/wsc_sdk/enums/transcoder_type.rb,
lib/wsc_sdk/templates/live_stream.rb,
lib/wsc_sdk/endpoints/live_streams.rb,
lib/wsc_sdk/models/transcoder_state.rb,
lib/wsc_sdk/models/transcoder_stats.rb,
lib/wsc_sdk/endpoints/stream_targets.rb,
lib/wsc_sdk/enums/broadcast_location.rb,
lib/wsc_sdk/models/live_stream_state.rb,
lib/wsc_sdk/models/live_stream_stats.rb,
lib/wsc_sdk/models/ull_stream_target.rb,
lib/wsc_sdk/enums/closed_caption_type.rb,
lib/wsc_sdk/models/wowza_stream_target.rb,
lib/wsc_sdk/models/custom_stream_target.rb,
lib/wsc_sdk/models/output_stream_target.rb,
lib/wsc_sdk/templates/ull_stream_target.rb,
lib/wsc_sdk/endpoints/ull_stream_targets.rb,
lib/wsc_sdk/models/transcoder_float_stat.rb,
lib/wsc_sdk/models/transcoder_string_stat.rb,
lib/wsc_sdk/templates/wowza_stream_target.rb,
lib/wsc_sdk/endpoints/wowza_stream_targets.rb,
lib/wsc_sdk/enums/target_delivery_protocol.rb,
lib/wsc_sdk/models/transcoder_boolean_stat.rb,
lib/wsc_sdk/models/transcoder_integer_stat.rb,
lib/wsc_sdk/templates/custom_stream_target.rb,
lib/wsc_sdk/endpoints/custom_stream_targets.rb,
lib/wsc_sdk/endpoints/output_stream_targets.rb,
lib/wsc_sdk/models/transcoder_thumbnail_url.rb,
lib/wsc_sdk/models/live_stream_thumbnail_url.rb,
lib/wsc_sdk/models/transcoder_connection_code.rb,
lib/wsc_sdk/modules/transcoder_shared_methods.rb,
lib/wsc_sdk/models/live_stream_connection_code.rb,
lib/wsc_sdk/models/transcoder_stream_target_state.rb

Overview

> 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.

Defined Under Namespace

Modules: ApiResponse, Endpoints, Enums, Errors, Loggable, Models, Templates, TranscoderSharedMethods Classes: Client, Configuration, Endpoint, Model, ModelList, ModelTemplate, Pagination, Schema, SchemaAttribute

Constant Summary

VERSION =

The current verison of the SDK.

"1.3.0.pre.beta14"

SDK_NAME =

The name of the SDK.

"Wowza Streaming Cloud SDK"

PATH_VERSION =

The default version to use when generating API requests.

"v" << VERSION.split(".")[0..1].join(".")

HOSTNAME =

The default hostname to use when generating API requests.

"https://api.cloud.wowza.com"

PRODUCTION_HOSTNAME =

The hostname of the Production server. This is an alias for WscSdk::HOSTNAME

HOSTNAME

SANDBOX_HOSTNAME =

The hostname of the Sandbox server.

"https://api-sandbox.cloud.wowza.com"

USER_AGENT =

The user agent to report when generating API requests.

"{\"name\": \"#{SDK_NAME}\", \"version\": \"#{WscSdk::VERSION}\", \"platform\": \"#{RUBY_PLATFORM}\", \"engine\": \"#{RUBY_ENGINE}\"}"

Class Attribute Summary

• .configuration ⇒ WscSdk::Configuration

  Get the SDK configuration object.

Class Method Summary

• .client ⇒ WscSdk::Client

  Returns an instance of the client configured using the SDK configuration.

• .configure {|configuration| ... } ⇒ Object

  Provides a mechanism to configure the SDK given a block.

Class Attribute Details

.configuration ⇒ WscSdk::Configuration

Get the SDK configuration object.

Returns:

• (WscSdk::Configuration) —

  The SDK configuration object.

# File 'lib/wsc_sdk.rb', line 56

def self.configuration
  @configuration ||= WscSdk::Configuration.new
end

Class Method Details

.client ⇒ WscSdk::Client

Returns an instance of the client configured using the SDK configuration

Returns:

• (WscSdk::Client) —

  An instance of the client object configured using the SDK configuration.

# File 'lib/wsc_sdk.rb', line 77

def self.client
  @client ||= WscSdk::Client.configured_instance
end

.configure {|configuration| ... } ⇒ Object

Provides a mechanism to configure the SDK given a block.

Yields:

• (configuration) —

  Gives a configuration object to the block so it can be setup properly.

Yield Parameters:

• configuration (WscSdk::Configuration) —

  The SDK configuration object.

# File 'lib/wsc_sdk.rb', line 68

def self.configure
  yield(configuration)
end