Class: Daily::DailyLiveStreamingOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/daily-ruby/models/daily_live_streaming_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DailyLiveStreamingOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::DailyLiveStreamingOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Daily::DailyLiveStreamingOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'width')
    self.width = attributes[:'width']
  end

  if attributes.key?(:'height')
    self.height = attributes[:'height']
  end

  if attributes.key?(:'fps')
    self.fps = attributes[:'fps']
  end

  if attributes.key?(:'video_bitrate')
    self.video_bitrate = attributes[:'video_bitrate']
  end

  if attributes.key?(:'audio_bitrate')
    self.audio_bitrate = attributes[:'audio_bitrate']
  end

  if attributes.key?(:'min_idle_time_out')
    self.min_idle_time_out = attributes[:'min_idle_time_out']
  end

  if attributes.key?(:'max_duration')
    self.max_duration = attributes[:'max_duration']
  end

  if attributes.key?(:'background_color')
    self.background_color = attributes[:'background_color']
  end

  if attributes.key?(:'instance_id')
    self.instance_id = attributes[:'instance_id']
  end

  if attributes.key?(:'layout')
    self.layout = attributes[:'layout']
  end

  if attributes.key?(:'rtmp_url')
    self.rtmp_url = attributes[:'rtmp_url']
  end

  if attributes.key?(:'endpoints')
    if (value = attributes[:'endpoints']).is_a?(Array)
      self.endpoints = value
    end
  end
end

Instance Attribute Details

#audio_bitrate ⇒ Object

Property that specifies the audio bitrate for the output audio in kilobits per second (kbps).



31
32
33
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 31

def audio_bitrate
  @audio_bitrate
end

#background_color ⇒ Object

Specifies the background color of the stream, formatted as \#rrggbb or \#aarrggbb string.



40
41
42
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 40

def background_color
  @background_color
end

#endpoints ⇒ Object

Returns the value of attribute endpoints.



49
50
51
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 49

def endpoints
  @endpoints
end

#fps ⇒ Object

Property that specifies the video frame rate per second.



25
26
27
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 25

def fps
  @fps
end

#height ⇒ Object

Property that specifies the output height of the given stream.



22
23
24
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 22

def height
  @height
end

#instance_id ⇒ Object

UUID for a streaming or recording session. Used when multiple streaming or recording sessions are running for single room.



43
44
45
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 43

def instance_id
  @instance_id
end

#layout ⇒ Object

Returns the value of attribute layout.



45
46
47
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 45

def layout
  @layout
end

#max_duration ⇒ Object

Maximum duration in seconds after which recording/streaming is forcefully stopped. Default: \‘15000\` seconds (3 hours). This is a preventive circuit breaker to prevent billing surprises in case a user starts recording/streaming and leaves the room.



37
38
39
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 37

def max_duration
  @max_duration
end

#min_idle_time_out ⇒ Object

Amount of time in seconds to wait before ending a recording or live stream when the room is idle (e.g. when all users have muted video and audio). Default: 300 (seconds). Note: Once the timeout has been reached, it typically takes an additional 1-3 minutes for the recording or live stream to be shut down.



34
35
36
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 34

def min_idle_time_out
  @min_idle_time_out
end

#rtmp_url ⇒ Object

Returns the value of attribute rtmp_url.



47
48
49
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 47

def rtmp_url
  @rtmp_url
end

#video_bitrate ⇒ Object

Property that specifies the video bitrate for the output video in kilobits per second (kbps).



28
29
30
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 28

def video_bitrate
  @video_bitrate
end

#width ⇒ Object

Property that specifies the output width of the given stream.



19
20
21
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 19

def width
  @width
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 237

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Daily.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 52

def self.attribute_map
  {
    :'width' => :'width',
    :'height' => :'height',
    :'fps' => :'fps',
    :'video_bitrate' => :'videoBitrate',
    :'audio_bitrate' => :'audioBitrate',
    :'min_idle_time_out' => :'minIdleTimeOut',
    :'max_duration' => :'maxDuration',
    :'background_color' => :'backgroundColor',
    :'instance_id' => :'instanceId',
    :'layout' => :'layout',
    :'rtmp_url' => :'rtmpUrl',
    :'endpoints' => :'endpoints'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 213

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 93

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 75

def self.openapi_types
  {
    :'width' => :'Float',
    :'height' => :'Float',
    :'fps' => :'Float',
    :'video_bitrate' => :'Float',
    :'audio_bitrate' => :'Float',
    :'min_idle_time_out' => :'Float',
    :'max_duration' => :'Float',
    :'background_color' => :'String',
    :'instance_id' => :'String',
    :'layout' => :'DailyStreamingLayoutConfig',
    :'rtmp_url' => :'DailyLiveStreamingOptionsRtmpUrl',
    :'endpoints' => :'Array<DailyStreamingEndpoint>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      width == o.width &&
      height == o.height &&
      fps == o.fps &&
      video_bitrate == o.video_bitrate &&
      audio_bitrate == o.audio_bitrate &&
      min_idle_time_out == o.min_idle_time_out &&
      max_duration == o.max_duration &&
      background_color == o.background_color &&
      instance_id == o.instance_id &&
      layout == o.layout &&
      rtmp_url == o.rtmp_url &&
      endpoints == o.endpoints
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 308

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



206
207
208
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 206

def hash
  [width, height, fps, video_bitrate, audio_bitrate, min_idle_time_out, max_duration, background_color, instance_id, layout, rtmp_url, endpoints].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



166
167
168
169
170
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 166

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



284
285
286
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 284

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 290

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



278
279
280
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 278

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



174
175
176
177
 
# File 'lib/daily-ruby/models/daily_live_streaming_options.rb', line 174

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end