Class: Bandwidth::Bxml::StartStream

Inherits:
NestableVerb show all
Defined in:
lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb

Instance Method Summary collapse

Methods inherited from NestableVerb

#generate_xml

Methods inherited from Verb

#generate_xml, #set_attributes, #to_bxml

Constructor Details

#initialize(stream_params = [], attributes = {}) ⇒ StartStream

Initializer

Parameters:

  • stream_params (Verb) (defaults to: []) —

    or [Array<Verb>] XML element children. Defaults to an empty array. Valid nested stream params are: StreamParam. You may specify up to 12 <StreamParam/> elements nested within a <StartStream> tag.

  • attributes (Hash) (defaults to: {}) —

    The attributes to add to the element. Defaults to an empty hash.



7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb', line 7

def initialize(stream_params = [], attributes = {})
  super('StartStream', nil, stream_params, attributes)
  
  @attribute_map = {
    name: 'name',                             # Optional [String]: A name to refer to this stream by. Used when sending <StopStream>. If not provided, it will default to the generated stream id as sent in the Media Stream Started webhook.
    tracks: 'tracks',                         # Optional [String]: The part of the call to send a stream from. inbound, outbound or both. Default is inbound.
    destination: 'destination',               # Optional [String]: A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio.
    stream_event_url: 'streamEventUrl',       # Optional [String]: URL to send the associated Webhook events to during this stream's lifetime. Does not accept BXML. May be a relative URL.
    stream_event_method: 'streamEventMethod', # Optional [String]: The HTTP method to use for the request to streamEventUrl. GET or POST. Default value is POST.
    username: 'username',                     # Optional [String]: The username to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
    password: 'password',                     # Optional [String]: The password to send in the HTTP request to streamEventUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
  }
end

Instance Method Details

#add_stream_params(stream_params) ⇒ Object

Add stream param or params to the nested verbs array

Parameters:

  • stream_params (StreamParam) —

    or [Array<StreamParam>] Verb or verbs to add to the array.



23
24
25
 
# File 'lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb', line 23

def add_stream_params(stream_params)
  @nested_verbs.push(*stream_params)
end