Class: GetStream::Generated::Models::RTMPBroadcastRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb

Overview

RTMPBroadcastRequest is the payload for starting an RTMP broadcast.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ RTMPBroadcastRequest

Initialize with attributes



29
30
31
32
33
34
35
36
 
# File 'lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb', line 29

def initialize(attributes = {})
  super(attributes)
  @name = attributes[:name] || attributes['name']
  @stream_url = attributes[:stream_url] || attributes['stream_url']
  @quality = attributes[:quality] || attributes['quality'] || nil
  @stream_key = attributes[:stream_key] || attributes['stream_key'] || nil
  @layout = attributes[:layout] || attributes['layout'] || nil
end

Instance Attribute Details

#layout ⇒ LayoutSettingsRequest

Returns:



26
27
28
 
# File 'lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb', line 26

def layout
  @layout
end

#name ⇒ String

Returns Name identifier for RTMP broadcast, must be unique in call.

Returns:

  • (String) —

    Name identifier for RTMP broadcast, must be unique in call



14
15
16
 
# File 'lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb', line 14

def name
  @name
end

#quality ⇒ String

Returns If provided, will override the call’s RTMP settings quality.

Returns:

  • (String) —

    If provided, will override the call’s RTMP settings quality



20
21
22
 
# File 'lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb', line 20

def quality
  @quality
end

#stream_key ⇒ String

Returns If provided, will be appended at the end of stream_url.

Returns:

  • (String) —

    If provided, will be appended at the end of stream_url



23
24
25
 
# File 'lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb', line 23

def stream_key
  @stream_key
end

#stream_url ⇒ String

Returns URL for the RTMP server to send the call to.

Returns:

  • (String) —

    URL for the RTMP server to send the call to



17
18
19
 
# File 'lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb', line 17

def stream_url
  @stream_url
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



39
40
41
42
43
44
45
46
47
 
# File 'lib/getstream_ruby/generated/models/rtmp_broadcast_request.rb', line 39

def self.json_field_mappings
  {
    name: 'name',
    stream_url: 'stream_url',
    quality: 'quality',
    stream_key: 'stream_key',
    layout: 'layout'
  }
end