Class: Daily::RoomProperties

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RoomProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



257
258
259
260
261
262
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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/daily-ruby/models/room_properties.rb', line 257

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::RoomProperties` 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::RoomProperties`. 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?(:'nbf')
    self.nbf = attributes[:'nbf']
  end

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

  if attributes.key?(:'max_participants')
    self.max_participants = attributes[:'max_participants']
  else
    self.max_participants = 200
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'enable_screenshare')
    self.enable_screenshare = attributes[:'enable_screenshare']
  else
    self.enable_screenshare = true
  end

  if attributes.key?(:'enable_video_processing_ui')
    self.enable_video_processing_ui = attributes[:'enable_video_processing_ui']
  else
    self.enable_video_processing_ui = true
  end

  if attributes.key?(:'enable_chat')
    self.enable_chat = attributes[:'enable_chat']
  else
    self.enable_chat = false
  end

  if attributes.key?(:'start_video_off')
    self.start_video_off = attributes[:'start_video_off']
  else
    self.start_video_off = false
  end

  if attributes.key?(:'start_audio_off')
    self.start_audio_off = attributes[:'start_audio_off']
  else
    self.start_audio_off = false
  end

  if attributes.key?(:'owner_only_broadcast')
    self.owner_only_broadcast = attributes[:'owner_only_broadcast']
  else
    self.owner_only_broadcast = false
  end

  if attributes.key?(:'enable_recording')
    self.enable_recording = attributes[:'enable_recording']
  else
    self.enable_recording = '<not set>'
  end

  if attributes.key?(:'eject_at_room_exp')
    self.eject_at_room_exp = attributes[:'eject_at_room_exp']
  else
    self.eject_at_room_exp = false
  end

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

  if attributes.key?(:'enable_advanced_chat')
    self.enable_advanced_chat = attributes[:'enable_advanced_chat']
  else
    self.enable_advanced_chat = false
  end

  if attributes.key?(:'enable_hidden_participants')
    self.enable_hidden_participants = attributes[:'enable_hidden_participants']
  else
    self.enable_hidden_participants = false
  end

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

  if attributes.key?(:'sfu_switchover')
    self.sfu_switchover = attributes[:'sfu_switchover']
  else
    self.sfu_switchover = 2
  end

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

  if attributes.key?(:'lang')
    self.lang = attributes[:'lang']
  else
    self.lang = 'en'
  end

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

  if attributes.key?(:'geo')
    self.geo = attributes[:'geo']
  else
    self.geo = 'NULL'
  end

  if attributes.key?(:'rtmp_geo')
    self.rtmp_geo = attributes[:'rtmp_geo']
  else
    self.rtmp_geo = 'The closest available region to the SFU region used by the meeting.'
  end

  if attributes.key?(:'disable_rtmp_geo_fallback')
    self.disable_rtmp_geo_fallback = attributes[:'disable_rtmp_geo_fallback']
  else
    self.disable_rtmp_geo_fallback = false
  end

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

  if attributes.key?(:'enable_terse_logging')
    self.enable_terse_logging = attributes[:'enable_terse_logging']
  else
    self.enable_terse_logging = false
  end

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

  if attributes.key?(:'enable_transcription_storage')
    self.enable_transcription_storage = attributes[:'enable_transcription_storage']
  else
    self.enable_transcription_storage = false
  end

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

  if attributes.key?(:'recordings_template')
    self.recordings_template = attributes[:'recordings_template']
  else
    self.recordings_template = '{domain_name}/{room_name}/{epoch_time}.'
  end

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

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

Instance Attribute Details

#auto_transcription_settings ⇒ Object

Options to use when ‘auto_start_transcription` is true. See [`startTranscription()`](/reference/daily-js/instance-methods/start-transcription) for available options.



117
118
119
 
# File 'lib/daily-ruby/models/room_properties.rb', line 117

def auto_transcription_settings
  @auto_transcription_settings
end

#disable_rtmp_geo_fallback ⇒ Object

Disable the fall back behavior of rtmp_geo. When rtmp_geo is set, we first try to connect to a media server in desired region. If a media server is not available in the desired region, we fall back to default region based on SFU’s region. This property disables this automatic fall back. When this property is set, we will trigger a recording/streaming error event when media worker is unavailable. Also, the client should retry recording/streaming.



109
110
111
 
# File 'lib/daily-ruby/models/room_properties.rb', line 109

def disable_rtmp_geo_fallback
  @disable_rtmp_geo_fallback
end

#eject_after_elapsed ⇒ Object

Eject a meeting participant this many seconds after the participant joins the meeting. You can use this is a default length limit to prevent long meetings. This can be overridden by setting ‘eject` properties of a [meeting token](/reference/rest-api/meeting-tokens).



79
80
81
 
# File 'lib/daily-ruby/models/room_properties.rb', line 79

def eject_after_elapsed
  @eject_after_elapsed
end

#eject_at_room_exp ⇒ Object

If there’s a meeting going on at room ‘exp` time, end the meeting by kicking everyone out. This behavior can be overridden by setting `eject` properties of a [meeting token](/reference/rest-api/meeting-tokens).



76
77
78
 
# File 'lib/daily-ruby/models/room_properties.rb', line 76

def eject_at_room_exp
  @eject_at_room_exp
end

#enable_advanced_chat ⇒ Object

Property that gives end users a richer chat experience. This includes: * Emoji reactions to chat messages * Emoji picker in the chat input form * Ability to send a Giphy chat message ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.



82
83
84
 
# File 'lib/daily-ruby/models/room_properties.rb', line 82

def enable_advanced_chat
  @enable_advanced_chat
end

#enable_breakout_rooms ⇒ Object

Sets whether [Daily Prebuilt](www.daily.co/prebuilt)’s breakout rooms feature is enabled. When set to ‘true`, an owner in a Prebuilt call can create breakout rooms to divide participants into smaller, private groups. ⚠️ You must be using [Daily Prebuilt](daily.co/blog/daily-prebuilt-video-chat) to use `enable_breakout_rooms`. ⚠️ This property is in beta.



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

def enable_breakout_rooms
  @enable_breakout_rooms
end

#enable_chat ⇒ Object

This property is one of [multiple ways to add chat to Daily video calls](www.daily.co/blog/three-ways-to-add-chat-to-your-video-calls-with-the-daily-api/).



61
62
63
 
# File 'lib/daily-ruby/models/room_properties.rb', line 61

def enable_chat
  @enable_chat
end

#enable_emoji_reactions ⇒ Object

Determines if [Daily Prebuilt](www.daily.co/prebuilt) displays the Emoji Reactions UI. When set to ‘true`, a Reactions button appears in the call tray. This button allows users to select and send a reaction into the call. When set to `false`, the Reactions button is hidden and the feature is disabled. Usage: This feature is a good fit for meetings when a host or presenter would benefit from receiving nonverbal cues from the audience. It’s also great to keep meetings fun. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.



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

def enable_emoji_reactions
  @enable_emoji_reactions
end

#enable_hand_raising ⇒ Object

Sets whether the participants in the room can use [Daily Prebuilt](www.daily.co/prebuilt)‘s hand raising controls. When set to `true`, an additional button will be available in Daily Prebuilt’s UI to toggle a hand raise. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.



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

def enable_hand_raising
  @enable_hand_raising
end

#enable_hidden_participants ⇒ Object

When enabled, non-owner users join a meeting with a hidden presence, meaning they won’t appear as a named participant in the meeting and have no [participant events](docs.daily.co/reference/daily-js/events/participant-events) associated to them. Additionally, these participants can only receive media tracks from owner participants. Hidden participants can be tracked using the [‘participantCounts()`](/reference/daily-js/instance-methods/participant-counts) method. Hidden participants do not have entries in the [`participants()`](/reference/daily-js/instance-methods/participants) method return value. When used with [Daily Prebuilt](/guides/products/prebuilt), hidden participants are included in the participant count available in the UI; however, are not included in the People panel and can only read chat messages. This property should be used to support hosting large meetings. See our [guide on interactive live streaming](/guides/scaling-calls/interactive-live-streaming-rtmp-output#interactive-live-streaming-up-to-100-000-participants) for additional instruction.



85
86
87
 
# File 'lib/daily-ruby/models/room_properties.rb', line 85

def enable_hidden_participants
  @enable_hidden_participants
end

#enable_knocking ⇒ Object

Turns on a lobby experience for private rooms. A participant without a corresponding [meeting token](/reference/rest-api/meeting-tokens/config) can request to be admitted to the meeting with a "knock", and wait for the meeting owner to admit them.



52
53
54
 
# File 'lib/daily-ruby/models/room_properties.rb', line 52

def enable_knocking
  @enable_knocking
end

#enable_mesh_sfu ⇒ Object

Configures a room to use multiple SFUs for a call’s media. This feature enables calls to scale to large sizes and to reduce latency between participants. It is recommended specifically for interactive live streaming. See our [guide for interactive live streaming](/guides/scaling-calls/interactive-live-streaming-rtmp-output#daily-prebuilt-configurations-to-support-100-000-participants) for additional instruction.



88
89
90
 
# File 'lib/daily-ruby/models/room_properties.rb', line 88

def enable_mesh_sfu
  @enable_mesh_sfu
end

#enable_network_ui ⇒ Object

Determines whether the network button, and the network panel it reveals on click, appears in this room. ⚠️ You must be using [Daily Prebuilt](daily.co/prebuilt) to use ‘enable_network_ui`.



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

def enable_network_ui
  @enable_network_ui
end

#enable_noise_cancellation_ui ⇒ Object

Determines whether Daily Prebuilt displays noise cancellation controls. When set to ‘true`, a participant can enable microphone noise cancellation during a Daily Prebuilt call. ⚠️ This flag only applies to [Daily Prebuilt](daily.co/prebuilt). It has no effect when building custom video applications with the Daily call object. To learn more about adding noise cancellation to a custom application, see the [`updateInputSettings()` docs](/reference/daily-js/instance-methods/update-input-settings).



46
47
48
 
# File 'lib/daily-ruby/models/room_properties.rb', line 46

def enable_noise_cancellation_ui
  @enable_noise_cancellation_ui
end

#enable_people_ui ⇒ Object

Determines if [Daily Prebuilt](/guides/products/prebuilt) displays the People UI. When set to true, a People button in the call tray reveals a People tab in the call sidebar. The tab lists all participants, and next to each name indicates audio status and an option to pin the participant. When ‘enable_people_ui` is set to false, the button and tab are hidden. ⚠️ Has no effect on custom calls built on the Daily [call object](/guides/products/call-object).



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

def enable_people_ui
  @enable_people_ui
end

#enable_pip_ui ⇒ Object

Sets whether the room can use [Daily Prebuilt](www.daily.co/prebuilt)‘s Picture in Picture controls. When set to `true`, an additional button will be available in Daily Prebuilt’s UI to toggle the Picture in Picture feature. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.



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

def enable_pip_ui
  @enable_pip_ui
end

#enable_prejoin_ui ⇒ Object

Determines whether participants enter a waiting room with a camera, mic, and browser check before joining a call. ⚠️ You must be using [Daily Prebuilt](daily.co/prebuilt) to use ‘enable_prejoin_ui`.



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

def enable_prejoin_ui
  @enable_prejoin_ui
end

#enable_recording ⇒ Object

Jump to [recording docs](/reference/rest-api/recordings).



73
74
75
 
# File 'lib/daily-ruby/models/room_properties.rb', line 73

def enable_recording
  @enable_recording
end

#enable_screenshare ⇒ Object

Sets whether users in a room can screen share during a session. This property cannot be changed after a session starts. For dynamic control over permissions, use the [‘updateParticipant()`](/reference/daily-js/instance-methods/update-participant#permissions) method to control user permissions.



55
56
57
 
# File 'lib/daily-ruby/models/room_properties.rb', line 55

def enable_screenshare
  @enable_screenshare
end

#enable_terse_logging ⇒ Object

Reduces the volume of log messages. This feature should be enabled when there are more than 200 participants in a meeting to help improve performance. See our [guides for supporting large experiences](/guides/scaling-calls) for additional instruction.



114
115
116
 
# File 'lib/daily-ruby/models/room_properties.rb', line 114

def enable_terse_logging
  @enable_terse_logging
end

#enable_transcription_storage ⇒ Object

Live transcriptions generated can be saved as WebVTT. This flag controls if transcription started with [‘startTranscription()`](/reference/daily-js/instance-methods/start-transcription) should be saved or not.



120
121
122
 
# File 'lib/daily-ruby/models/room_properties.rb', line 120

def enable_transcription_storage
  @enable_transcription_storage
end

#enable_video_processing_ui ⇒ Object

Determines whether Daily Prebuilt displays background blur controls. When set to ‘true`, a participant can enable blur during a Daily Prebuilt call. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.



58
59
60
 
# File 'lib/daily-ruby/models/room_properties.rb', line 58

def enable_video_processing_ui
  @enable_video_processing_ui
end

#exp ⇒ Object

"Expires". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in this room after this time. More resources: - [Add advanced security to video chats with the Daily API](www.daily.co/blog/add-advanced-security-features-to-video-chats-with-the-daily-api/)



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

def exp
  @exp
end

#experimental_optimize_large_calls ⇒ Object

Enables Daily Prebuilt to support group calls of up to 1,000 participants and [owner only broadcast](/reference/rest-api/rooms/config#owner_only_broadcast) calls of up to 100K participants. When set to true, Daily Prebuilt will: - Automatically mute the local user on joining - Update grid view to show a maximum of 12 users in the grid at a time - Allow only 16 users to be unmuted at the same time. When more than 16 users are unmuted, the oldest active speaker will be automatically muted. See our [guide on large real-time calls](/guides/scaling-calls/large-real-time-calls) for additional instruction. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.



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

def experimental_optimize_large_calls
  @experimental_optimize_large_calls
end

#geo ⇒ Object

Daily uses signaling servers to manage all of the participants in a given call session. In an SFU/server mode call, the server will send and receive all audio and video from each participant. In a peer-to-peer call, each participant sends media directly to and from each other peer, but a signaling server still manages call state. Daily runs servers in several different AWS regions to minimize latency for users around the world. The job of ‘picking’ a call server is handled when the first participant joins a room. The first participant’s browser connects to a call server using Amazon’s Route 53 DNS resolution, which chooses a server in the region closest to them. This isn’t always optimal. For example, if one person joins in London, and then ten more people join from Cape Town, the call will still be hosted out of ‘eu-west-2` . The majority of the participants will have higher latency to the server than if one of them had joined first and the call was being hosted in `af-south-1`. In cases like this, you may want to configure your domain (or a specific room) to always choose a call server in a specific AWS region. Available regions: - `"af-south-1"` (Cape Town) - `"ap-northeast-2"` (Seoul) - `"ap-southeast-1"` (Singapore) - `"ap-southeast-2"` (Sydney) - `"ap-south-1"` (Mumbai) - `"eu-central-1"` (Frankfurt) - `"eu-west-2"` (London) - `"sa-east-1"` (São Paulo) - `"us-east-1"` (N. Virginia) - `"us-west-2"` (Oregon)



103
104
105
 
# File 'lib/daily-ruby/models/room_properties.rb', line 103

def geo
  @geo
end

#lang ⇒ Object

The default language of the [Daily prebuilt video call UI](/guides/products/prebuilt#daily-prebuilt-ui), for this room. Setting the language at the room level will override any domain-level language settings you have. Read more about [changing prebuilt UI language settings](help.daily.co/en/articles/4579930-changing-the-language-setting-of-the-prebuilt-ui). ‘*` Norwegian `"no"` and Russian `"ru"` are only available in the new Daily Prebuilt.



97
98
99
 
# File 'lib/daily-ruby/models/room_properties.rb', line 97

def lang
  @lang
end

#max_participants ⇒ Object

How many people are allowed in a room at the same time. ⚠️ [Contact us](www.daily.co/contact) if you need to set the limit above 200.



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

def max_participants
  @max_participants
end

#meeting_join_hook ⇒ Object

Sets a URL that will receive a webhook when a user joins a room. Default is NULL. Character limit for webhook URL is 255. More resources: - [Configuring a webhook to send notifications when someone joins your video calls](www.daily.co/blog/configure-a-webhook-to-send-notifications-when-someone-joins-your-video-calls/)



100
101
102
 
# File 'lib/daily-ruby/models/room_properties.rb', line 100

def meeting_join_hook
  @meeting_join_hook
end

#nbf ⇒ Object

"Not before". This is a [unix timestamp](stackoverflow.com/questions/20822821/what-is-a-unix-timestamp-and-why-use-it) (seconds since the epoch.) Users cannot join a meeting in this room before this time.



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

def nbf
  @nbf
end

#owner_only_broadcast ⇒ Object

In Daily Prebuilt, only the meeting owners will be able to turn on camera, unmute mic, and share screen. See [setting up calls](docs.daily.co/docs/setting-up-calls).



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

def owner_only_broadcast
  @owner_only_broadcast
end

#permissions ⇒ Object

Returns the value of attribute permissions.



130
131
132
 
# File 'lib/daily-ruby/models/room_properties.rb', line 130

def permissions
  @permissions
end

#recordings_bucket ⇒ Object

Returns the value of attribute recordings_bucket.



111
112
113
 
# File 'lib/daily-ruby/models/room_properties.rb', line 111

def recordings_bucket
  @recordings_bucket
end

#recordings_template ⇒ Object

Cloud recordings are stored in either Daily’s S3 bucket or the customer’s own S3 bucket. By default recordings are stored as ‘domain_name/room_name/epoch_time`. Sometimes, the use case may call for custom recording file names to be used (for example, if you’d like to enforce the presence of the .mp4 extension in the file name). ‘recordings_template` is made up of a replacement string with prefixes, suffixes, or both. The currently supported replacements are: - `epoch_time`: The epoch time in seconds (mandatory) - `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) - `recording_id`: The recording ID of the recording (optional) The restrictions for defining a recording template are as follows: - The `epoch_time` tag is mandatory to ensure the recording file name is unique under all conditions - 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 - `.mp4` is the only valid extension Examples - Example domain: "myDomain" - Example room: "myRoom" Example 1: - Template: `myprefix-domain_name-epoch_time.mp4` - Resulting file name: `myprefix-myDomain-1675842936274.mp4` Example 2: - Template: `room_name/instance_id/epoch_time` - Resulting room name: `myRoom/d529cd2f-fbcc-4fb7-b2c0-c4995b1162b6/1675842936274`



125
126
127
 
# File 'lib/daily-ruby/models/room_properties.rb', line 125

def recordings_template
  @recordings_template
end

#rtmp_geo ⇒ Object

Used to select the region where an RTMP stream should originate. In cases where RTMP streaming services aren’t available in the desired region, we’ll attempt to fall back to the default region based on the SFU being used for the meeting. Available regions: - ‘"us-west-2"` (Oregon) - `"eu-central-1"` (Frankfurt) - `"ap-south-1"` (Mumbai) The default regions are grouped based on the SFU region like so: - RTMP region `"us-west-2"` includes SFU regions: `"us-west-2"`, `"us-east-1"`, `"sa-east-1"` - RTMP region `"eu-central-1"` includes SFU regions: `"eu-central-1"`, `"eu-west-2"`, `"af-south-1"` - RTMP region `"ap-south-1"` includes SFU regions: `"ap-southeast-1"`, `"ap-southeast-2"`, `"ap-northeast-2"`, `"ap-south-1"`



106
107
108
 
# File 'lib/daily-ruby/models/room_properties.rb', line 106

def rtmp_geo
  @rtmp_geo
end

#sfu_switchover ⇒ Object

Dictates the participant count after which room topology automatically switches from Peer-to-Peer (P2P) to Selective Forwarding Unit (SFU) mode, or vice versa. For example, if ‘sfu_switchover` is set to `3` and the current network topology is P2P, the topology will switch to SFU mode when the fourth participant joins the call. If the current topology is SFU, it will switch to P2P mode when the participant count decreases from `3` to `2`. We recommend specifying an integer value for this property except for cases where you would like the room to switch to SFU mode as soon as the first participant joins. In this case, set `sfu_switchover` to `0.5`. See our [guide about video call architecture](/guides/architecture-and-monitoring/intro-to-video-arch#the-architecture-of-a-room-p2p-vs-sfu-calls) for additional information.



91
92
93
 
# File 'lib/daily-ruby/models/room_properties.rb', line 91

def sfu_switchover
  @sfu_switchover
end

#start_audio_off ⇒ Object

Disable the default behavior of automatically turning on a participant’s microphone on a direct ‘join()` (i.e. without `startCamera()` first).



67
68
69
 
# File 'lib/daily-ruby/models/room_properties.rb', line 67

def start_audio_off
  @start_audio_off
end

#start_video_off ⇒ Object

Disable the default behavior of automatically turning on a participant’s camera on a direct ‘join()` (i.e. without `startCamera()` first).



64
65
66
 
# File 'lib/daily-ruby/models/room_properties.rb', line 64

def start_video_off
  @start_video_off
end

#streaming_endpoints ⇒ Object

An array of stream endpoint configuration objects, which allows configurations to be pre-defined without having to pass them into [‘startLiveStreaming()`](/reference/daily-js/instance-methods/start-live-streaming) at runtime. For example, an RTMP endpoint can be set up for YouTube as a `streaming_endpoints` configuration along with another configuration for HLS storage. HLS output can only be stored on a customer’s S3, not in Daily’s storage infrastructure. The stream configuration defines which S3 bucket to store the HLS output. (See the [S3 bucket guide](/guides/products/live-streaming-recording/storing-recordings-in-a-custom-s3-bucket) for more information.) Example: “‘json { "properties": { // … add additional room properties here "streaming_endpoints": [ { "name": "rtmp_youtube", "type": "rtmp", "rtmp_config": { "url": "rtmps://exampleYouTubeServer.com:443/stream" } }, { "name": "rtmp_ivs", "type": "rtmp", "rtmp_config": { "url": "rtmps://811111111111.global-contribute.live-video.net:443/app/" } }, { "name": "hls_akamai", "type": "hls", "hls_config": { "save_hls_recording": true/false, "storage": { "bucket_name": "daily-hls-streams", "bucket_region": "us-west-2", "assume_role_arn": "arn:aws:iam::999999999999:role/DailyS3AccessRole", "path_template": "testHarness/live_streaming_id/instance_id" }, "variant" : [ { "width": 1920, "height": 1080, "fps": 30, "bitrate": 3500, "iframe_only": false }, { "width": 1280, "height": 720, "fps": 30, "bitrate": 2500, "iframe_only": false }, { "width": 640, "height": 360, "fps": 30, "bitrate": 780, "iframe_only": true } ] } } ] } } “` To reset the `streaming_endpoints` property, pass `null` instead of an array. When calling `startLiveStreaming()`, the pre-defined `streaming_endpoints` `name` can be used: “`javascript await callObject.startLiveStreaming({ endpoints: ["endpoint":"rtmp_youtube","endpoint":"rtmp_fb"], width: 1280, height: 720, }); “` Properties:



128
129
130
 
# File 'lib/daily-ruby/models/room_properties.rb', line 128

def streaming_endpoints
  @streaming_endpoints
end

#transcription_bucket ⇒ Object

Returns the value of attribute transcription_bucket.



122
123
124
 
# File 'lib/daily-ruby/models/room_properties.rb', line 122

def transcription_bucket
  @transcription_bucket
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



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/daily-ruby/models/room_properties.rb', line 591

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/daily-ruby/models/room_properties.rb', line 155

def self.attribute_map
  {
    :'nbf' => :'nbf',
    :'exp' => :'exp',
    :'max_participants' => :'max_participants',
    :'enable_people_ui' => :'enable_people_ui',
    :'enable_pip_ui' => :'enable_pip_ui',
    :'enable_emoji_reactions' => :'enable_emoji_reactions',
    :'enable_hand_raising' => :'enable_hand_raising',
    :'enable_prejoin_ui' => :'enable_prejoin_ui',
    :'enable_network_ui' => :'enable_network_ui',
    :'enable_noise_cancellation_ui' => :'enable_noise_cancellation_ui',
    :'enable_breakout_rooms' => :'enable_breakout_rooms',
    :'enable_knocking' => :'enable_knocking',
    :'enable_screenshare' => :'enable_screenshare',
    :'enable_video_processing_ui' => :'enable_video_processing_ui',
    :'enable_chat' => :'enable_chat',
    :'start_video_off' => :'start_video_off',
    :'start_audio_off' => :'start_audio_off',
    :'owner_only_broadcast' => :'owner_only_broadcast',
    :'enable_recording' => :'enable_recording',
    :'eject_at_room_exp' => :'eject_at_room_exp',
    :'eject_after_elapsed' => :'eject_after_elapsed',
    :'enable_advanced_chat' => :'enable_advanced_chat',
    :'enable_hidden_participants' => :'enable_hidden_participants',
    :'enable_mesh_sfu' => :'enable_mesh_sfu',
    :'sfu_switchover' => :'sfu_switchover',
    :'experimental_optimize_large_calls' => :'experimental_optimize_large_calls',
    :'lang' => :'lang',
    :'meeting_join_hook' => :'meeting_join_hook',
    :'geo' => :'geo',
    :'rtmp_geo' => :'rtmp_geo',
    :'disable_rtmp_geo_fallback' => :'disable_rtmp_geo_fallback',
    :'recordings_bucket' => :'recordings_bucket',
    :'enable_terse_logging' => :'enable_terse_logging',
    :'auto_transcription_settings' => :'auto_transcription_settings',
    :'enable_transcription_storage' => :'enable_transcription_storage',
    :'transcription_bucket' => :'transcription_bucket',
    :'recordings_template' => :'recordings_template',
    :'streaming_endpoints' => :'streaming_endpoints',
    :'permissions' => :'permissions'
  }
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



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/daily-ruby/models/room_properties.rb', line 567

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



250
251
252
253
 
# File 'lib/daily-ruby/models/room_properties.rb', line 250

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

.openapi_types ⇒ Object

Attribute type mapping.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/daily-ruby/models/room_properties.rb', line 205

def self.openapi_types
  {
    :'nbf' => :'Integer',
    :'exp' => :'Integer',
    :'max_participants' => :'Integer',
    :'enable_people_ui' => :'Boolean',
    :'enable_pip_ui' => :'Boolean',
    :'enable_emoji_reactions' => :'Boolean',
    :'enable_hand_raising' => :'Boolean',
    :'enable_prejoin_ui' => :'Boolean',
    :'enable_network_ui' => :'Boolean',
    :'enable_noise_cancellation_ui' => :'Boolean',
    :'enable_breakout_rooms' => :'Boolean',
    :'enable_knocking' => :'Boolean',
    :'enable_screenshare' => :'Boolean',
    :'enable_video_processing_ui' => :'Boolean',
    :'enable_chat' => :'Boolean',
    :'start_video_off' => :'Boolean',
    :'start_audio_off' => :'Boolean',
    :'owner_only_broadcast' => :'Boolean',
    :'enable_recording' => :'String',
    :'eject_at_room_exp' => :'Boolean',
    :'eject_after_elapsed' => :'Integer',
    :'enable_advanced_chat' => :'Boolean',
    :'enable_hidden_participants' => :'Boolean',
    :'enable_mesh_sfu' => :'Boolean',
    :'sfu_switchover' => :'Float',
    :'experimental_optimize_large_calls' => :'Boolean',
    :'lang' => :'String',
    :'meeting_join_hook' => :'String',
    :'geo' => :'String',
    :'rtmp_geo' => :'String',
    :'disable_rtmp_geo_fallback' => :'Boolean',
    :'recordings_bucket' => :'RecordingsBucket',
    :'enable_terse_logging' => :'Boolean',
    :'auto_transcription_settings' => :'Object',
    :'enable_transcription_storage' => :'Boolean',
    :'transcription_bucket' => :'TranscriptionBucket',
    :'recordings_template' => :'String',
    :'streaming_endpoints' => :'Array<RoomPropertiesStreamingEndpointsInner>',
    :'permissions' => :'Permissions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/daily-ruby/models/room_properties.rb', line 508

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nbf == o.nbf &&
      exp == o.exp &&
      max_participants == o.max_participants &&
      enable_people_ui == o.enable_people_ui &&
      enable_pip_ui == o.enable_pip_ui &&
      enable_emoji_reactions == o.enable_emoji_reactions &&
      enable_hand_raising == o.enable_hand_raising &&
      enable_prejoin_ui == o.enable_prejoin_ui &&
      enable_network_ui == o.enable_network_ui &&
      enable_noise_cancellation_ui == o.enable_noise_cancellation_ui &&
      enable_breakout_rooms == o.enable_breakout_rooms &&
      enable_knocking == o.enable_knocking &&
      enable_screenshare == o.enable_screenshare &&
      enable_video_processing_ui == o.enable_video_processing_ui &&
      enable_chat == o.enable_chat &&
      start_video_off == o.start_video_off &&
      start_audio_off == o.start_audio_off &&
      owner_only_broadcast == o.owner_only_broadcast &&
      enable_recording == o.enable_recording &&
      eject_at_room_exp == o.eject_at_room_exp &&
      eject_after_elapsed == o.eject_after_elapsed &&
      enable_advanced_chat == o.enable_advanced_chat &&
      enable_hidden_participants == o.enable_hidden_participants &&
      enable_mesh_sfu == o.enable_mesh_sfu &&
      sfu_switchover == o.sfu_switchover &&
      experimental_optimize_large_calls == o.experimental_optimize_large_calls &&
      lang == o.lang &&
      meeting_join_hook == o.meeting_join_hook &&
      geo == o.geo &&
      rtmp_geo == o.rtmp_geo &&
      disable_rtmp_geo_fallback == o.disable_rtmp_geo_fallback &&
      recordings_bucket == o.recordings_bucket &&
      enable_terse_logging == o.enable_terse_logging &&
      auto_transcription_settings == o.auto_transcription_settings &&
      enable_transcription_storage == o.enable_transcription_storage &&
      transcription_bucket == o.transcription_bucket &&
      recordings_template == o.recordings_template &&
      streaming_endpoints == o.streaming_endpoints &&
      permissions == o.permissions
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



662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/daily-ruby/models/room_properties.rb', line 662

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


554
555
556
 
# File 'lib/daily-ruby/models/room_properties.rb', line 554

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



560
561
562
 
# File 'lib/daily-ruby/models/room_properties.rb', line 560

def hash
  [nbf, exp, max_participants, enable_people_ui, enable_pip_ui, enable_emoji_reactions, enable_hand_raising, enable_prejoin_ui, enable_network_ui, enable_noise_cancellation_ui, enable_breakout_rooms, enable_knocking, enable_screenshare, enable_video_processing_ui, enable_chat, start_video_off, start_audio_off, owner_only_broadcast, enable_recording, eject_at_room_exp, eject_after_elapsed, enable_advanced_chat, enable_hidden_participants, enable_mesh_sfu, sfu_switchover, experimental_optimize_large_calls, lang, meeting_join_hook, geo, rtmp_geo, disable_rtmp_geo_fallback, recordings_bucket, enable_terse_logging, auto_transcription_settings, enable_transcription_storage, transcription_bucket, recordings_template, streaming_endpoints, permissions].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



469
470
471
472
473
 
# File 'lib/daily-ruby/models/room_properties.rb', line 469

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



638
639
640
 
# File 'lib/daily-ruby/models/room_properties.rb', line 638

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



644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/daily-ruby/models/room_properties.rb', line 644

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



632
633
634
 
# File 'lib/daily-ruby/models/room_properties.rb', line 632

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



477
478
479
480
481
482
483
484
 
# File 'lib/daily-ruby/models/room_properties.rb', line 477

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  enable_recording_validator = EnumAttributeValidator.new('String', ["cloud", "local", "raw-tracks", "<not set>"])
  return false unless enable_recording_validator.valid?(@enable_recording)
  lang_validator = EnumAttributeValidator.new('String', ["de", "en", "es", "fi", "fr", "it", "jp", "ka", "nl", "no", "pt", "pt-BR", "pl", "ru", "sv", "tr", "user"])
  return false unless lang_validator.valid?(@lang)
  true
end