Module: ChimeSdk

Extended by:
ActiveSupport::Autoload
Defined in:
lib/amazon-chime-sdk-rails.rb,
lib/chime_sdk/config.rb,
lib/chime_sdk/version.rb,
lib/chime_sdk/controller/common.rb,
lib/chime_sdk/controller/meetings.rb,
lib/chime_sdk/meeting_coordinator.rb,
lib/chime_sdk/controller/attendees.rb,
lib/generators/chime_sdk/js_generator.rb,
lib/generators/chime_sdk/views_generator.rb,
lib/generators/chime_sdk/install_generator.rb,
lib/generators/chime_sdk/controllers_generator.rb

Overview

Top level namespace of amazon-chime-sdk-rails, server-side implementation of Amazon Chime SDK for Ruby on Rails application.

Defined Under Namespace

Modules: Controller, Generators, MeetingCoordinator Classes: Config

Constant Summary collapse

VERSION =

Gem version of amazon-chime-sdk-rails

"2.0.0"

Class Method Summary collapse

Class Method Details

.config ⇒ Object

Returns configuration object of ChimeSdk.



9
10
11
 
# File 'lib/amazon-chime-sdk-rails.rb', line 9

def self.config
  @config ||= ChimeSdk::Config.new
end

.configure {|config| ... } ⇒ Object

Sets global configuration options for ChimeSdk. Available options and their defaults are in the example below:

Examples:

Initializer for Rails

ChimeSdk.configure do |config|
  config.appication_name               = 'chime-sdk-rails'
  config.media_region                  = 'us-east-1'
  config.prefix                        = "#{config.application_name}-#{Rails.env}-"
  config.max_attendee_results          = 10
  config.create_meeting_with_attendee  = true
  config.create_attendee_from_meeting  = true
  config.create_meeting_by_get_request = false
end

Yields:



25
26
27
 
# File 'lib/amazon-chime-sdk-rails.rb', line 25

def self.configure
  yield(config) if block_given?
end