Class: Daily::RoomPropertiesStreamingEndpointsInner
- Inherits:
-
Object
- Object
- Daily::RoomPropertiesStreamingEndpointsInner
- Defined in:
- lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb
Instance Attribute Summary collapse
-
#hls_config_save_hls_recording ⇒ Object
If ‘true`, the live stream will be saved as a recording after streaming has ended.
-
#hls_config_storage_path ⇒ Object
The ‘s3Key` path prefix for where to store the recordings.
-
#hls_config_storage_path_template ⇒ Object
‘path_template` is made up of a replacement string with prefixes, suffixes, or both.
-
#hls_config_variants ⇒ Object
An optional array of variants to generate for HLS.
-
#name ⇒ Object
Used by the ‘startLiveStreaming()` API to reference which stream configuration to start.
-
#type ⇒ Object
Whether the streaming endpoint is ‘rtmp` or `hls`.
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 = {}) ⇒ RoomPropertiesStreamingEndpointsInner
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 = {}) ⇒ RoomPropertiesStreamingEndpointsInner
Initializes the object
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 73 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::RoomPropertiesStreamingEndpointsInner` 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::RoomPropertiesStreamingEndpointsInner`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'hls_config_storage_path') self.hls_config_storage_path = attributes[:'hls_config_storage_path'] end if attributes.key?(:'hls_config_storage_path_template') self.hls_config_storage_path_template = attributes[:'hls_config_storage_path_template'] end if attributes.key?(:'hls_config_save_hls_recording') self.hls_config_save_hls_recording = attributes[:'hls_config_save_hls_recording'] end if attributes.key?(:'hls_config_variants') if (value = attributes[:'hls_config_variants']).is_a?(Array) self.hls_config_variants = value end end end |
Instance Attribute Details
#hls_config_save_hls_recording ⇒ Object
If ‘true`, the live stream will be saved as a recording after streaming has ended. If `false`, the stream is available only until the streaming is live.
31 32 33 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 31 def hls_config_save_hls_recording @hls_config_save_hls_recording end |
#hls_config_storage_path ⇒ Object
The ‘s3Key` path prefix for where to store the recordings. Therefore, the final final master.m3u8 path template is `<bucket_name>/<path>/<mtgSessionId>/master.m3u8`, i.e. `hls_config[’bucket_name’]/hls_config[‘path’]/<mtgSessionId>/master.m3u8`.
25 26 27 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 25 def hls_config_storage_path @hls_config_storage_path end |
#hls_config_storage_path_template ⇒ Object
‘path_template` is made up of a replacement string with prefixes, suffixes, or both. `path_template` without replacement string is also valid. The currently supported replacements are: - `epoch_time`: The epoch time in seconds (optional) - `domain_name`: Your Daily domain (optional) - `room_name`: The name of the room which is getting recorded (optional) - `mtg_session_id`: The ID of the meeting session which is getting recorded (optional) - `instance_id`: The instance ID of the recording (optional) - `live_streaming_id`: The ID of the live streaming in our DB (optional) The restrictions for defining a recording template are as follows: - The maximum size of the template is 1024 characters - Each replacement parameter should be placed within a curly bracket (e.g., `domain_name`) - Only alphanumeric characters `(0-9, A-Z, a-z)` and `.`, `/`, `-`, `_` are valid within the template Examples - Example domain: "myDomain" - Example room: "myRoom" - example hls bucket: "HLS_S3_BUCKET" Example 1: - Template: `my-hls-domain_name-epoch_time` - Resulting path of master.m3u8: `s3://HLS_S3_BUCKET/my-hls-myDomain-1675842936274/master.m3u8` Example 2: - Template: `room_name/instance_id/` - Resulting path of master.m3u8: `myRoom/d529cd2f-fbcc-4fb7-b2c0-c4995b1162b6/master.m3u8`
28 29 30 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 28 def hls_config_storage_path_template @hls_config_storage_path_template end |
#hls_config_variants ⇒ Object
An optional array of variants to generate for HLS. For most use cases this property can be omitted as Daily uses sensible defaults. The array defines the resolution, FPS, and bitrate for each variant. The following limitations apply: - There can be a maximum of one variant with 1080p resolution. All other variants must be less than or equal to 720p. - A maximum of four variants can be specified, other than iframe-only stream - We do not support iframe-only variant, at least one full-stream variant is required
34 35 36 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 34 def hls_config_variants @hls_config_variants end |
#name ⇒ Object
Used by the ‘startLiveStreaming()` API to reference which stream configuration to start.
19 20 21 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 19 def name @name end |
#type ⇒ Object
Whether the streaming endpoint is ‘rtmp` or `hls`.
22 23 24 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 22 def type @type end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 180 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
49 50 51 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 49 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
37 38 39 40 41 42 43 44 45 46 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 37 def self.attribute_map { :'name' => :'name', :'type' => :'type', :'hls_config_storage_path' => :hls_config['storage']['path'], :'hls_config_storage_path_template' => :hls_config['storage']['path_template'], :'hls_config_save_hls_recording' => :hls_config['save_hls_recording'], :'hls_config_variants' => :hls_config['variants'] } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 156 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
66 67 68 69 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 66 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
54 55 56 57 58 59 60 61 62 63 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 54 def self.openapi_types { :'name' => :'String', :'type' => :'String', :'hls_config_storage_path' => :'String', :'hls_config_storage_path_template' => :'String', :'hls_config_save_hls_recording' => :'Boolean', :'hls_config_variants' => :'Array<RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
130 131 132 133 134 135 136 137 138 139 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 130 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && type == o.type && hls_config_storage_path == o.hls_config_storage_path && hls_config_storage_path_template == o.hls_config_storage_path_template && hls_config_save_hls_recording == o.hls_config_save_hls_recording && hls_config_variants == o.hls_config_variants end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 251 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
143 144 145 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 143 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
149 150 151 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 149 def hash [name, type, hls_config_storage_path, hls_config_storage_path_template, hls_config_save_hls_recording, hls_config_variants].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
115 116 117 118 119 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 115 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)
227 228 229 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 227 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 233 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
221 222 223 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 221 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
123 124 125 126 |
# File 'lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb', line 123 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end |