Class: Daily::RecordingStreamingOptions
- Inherits:
-
Object
- Object
- Daily::RecordingStreamingOptions
- Defined in:
- lib/daily-ruby/models/recording_streaming_options.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#audio_bitrate ⇒ Object
Property that specifies the audio bitrate for the output audio in kilobits per second (kbps).
-
#background_color ⇒ Object
Specifies the background color of the stream, formatted as \#rrggbb or \#aarrggbb string.
-
#fps ⇒ Object
Property that specifies the video frame rate per second.
-
#height ⇒ Object
Property that specifies the output height of the given stream.
-
#instance_id ⇒ Object
UUID for a streaming or recording session.
-
#layout ⇒ Object
Returns the value of attribute layout.
-
#max_duration ⇒ Object
Maximum duration in seconds after which recording/streaming is forcefully stopped.
-
#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).
-
#type ⇒ Object
The type of recording that will be started.
-
#video_bitrate ⇒ Object
Property that specifies the video bitrate for the output video in kilobits per second (kbps).
-
#width ⇒ Object
Property that specifies the output width of the given stream.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RecordingStreamingOptions
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ RecordingStreamingOptions
Initializes the object
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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 119 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::RecordingStreamingOptions` 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::RecordingStreamingOptions`. 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?(:'type') self.type = attributes[:'type'] else self.type = 'cloud' end if attributes.key?(:'layout') self.layout = attributes[:'layout'] 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/recording_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/recording_streaming_options.rb', line 40 def background_color @background_color end |
#fps ⇒ Object
Property that specifies the video frame rate per second.
25 26 27 |
# File 'lib/daily-ruby/models/recording_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/recording_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/recording_streaming_options.rb', line 43 def instance_id @instance_id end |
#layout ⇒ Object
Returns the value of attribute layout.
48 49 50 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 48 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/recording_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/recording_streaming_options.rb', line 34 def min_idle_time_out @min_idle_time_out end |
#type ⇒ Object
The type of recording that will be started.
46 47 48 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 46 def type @type 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/recording_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/recording_streaming_options.rb', line 19 def width @width end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 263 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
90 91 92 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 90 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 73 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', :'type' => :'type', :'layout' => :'layout' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 239 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
112 113 114 115 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 112 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 95 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', :'type' => :'String', :'layout' => :'DailyStreamingLayoutConfig' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 208 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 && type == o.type && layout == o.layout end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 334 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
226 227 228 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 226 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
232 233 234 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 232 def hash [width, height, fps, video_bitrate, audio_bitrate, min_idle_time_out, max_duration, background_color, instance_id, type, layout].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
181 182 183 184 185 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 181 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)
310 311 312 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 310 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 316 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
304 305 306 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 304 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
189 190 191 192 193 194 |
# File 'lib/daily-ruby/models/recording_streaming_options.rb', line 189 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' type_validator = EnumAttributeValidator.new('String', ["cloud", "raw-tracks", "unknown_default_open_api"]) return false unless type_validator.valid?(@type) true end |