daily-ruby 0.0.0 → 1.0.0

data/docs/RecordingsApi.md

@@ -0,0 +1,303 @@
+# Daily::RecordingsApi
+
+All URIs are relative to *https://api.daily.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_recording**](RecordingsApi.md#delete_recording) | **DELETE** /recordings/{recording_id} | recordings/:id |
+| [**get_recording_info**](RecordingsApi.md#get_recording_info) | **GET** /recordings/{recording_id} | recordings/:id |
+| [**get_recording_link**](RecordingsApi.md#get_recording_link) | **GET** /recordings/{recording_id}/access-link | recordings/:id/access-link |
+| [**list_recordings**](RecordingsApi.md#list_recordings) | **GET** /recordings | /recordings |
+
+
+## delete_recording
+
+> Object delete_recording(recording_id)
+
+recordings/:id
+
+Delete a recording
+
+### Examples
+
+```ruby
+require 'time'
+require 'daily-ruby'
+# setup authorization
+Daily.configure do |config|
+  # Configure API key authorization: sec0
+  config.api_key['sec0'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sec0'] = 'Bearer'
+end
+
+api_instance = Daily::RecordingsApi.new
+recording_id = 'recording_id_example' # String | 
+
+begin
+  # recordings/:id
+  result = api_instance.delete_recording(recording_id)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->delete_recording: #{e}"
+end
+```
+
+#### Using the delete_recording_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_recording_with_http_info(recording_id)
+
+```ruby
+begin
+  # recordings/:id
+  data, status_code, headers = api_instance.delete_recording_with_http_info(recording_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->delete_recording_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recording_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_recording_info
+
+> <GetRecordingInfo200Response> get_recording_info(recording_id)
+
+recordings/:id
+
+Get info about a recording
+
+### Examples
+
+```ruby
+require 'time'
+require 'daily-ruby'
+# setup authorization
+Daily.configure do |config|
+  # Configure API key authorization: sec0
+  config.api_key['sec0'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sec0'] = 'Bearer'
+end
+
+api_instance = Daily::RecordingsApi.new
+recording_id = 'recording_id_example' # String | 
+
+begin
+  # recordings/:id
+  result = api_instance.get_recording_info(recording_id)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->get_recording_info: #{e}"
+end
+```
+
+#### Using the get_recording_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRecordingInfo200Response>, Integer, Hash)> get_recording_info_with_http_info(recording_id)
+
+```ruby
+begin
+  # recordings/:id
+  data, status_code, headers = api_instance.get_recording_info_with_http_info(recording_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRecordingInfo200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->get_recording_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recording_id** | **String** |  |  |
+
+### Return type
+
+[**GetRecordingInfo200Response**](GetRecordingInfo200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_recording_link
+
+> <GetRecordingLink200Response> get_recording_link(recording_id)
+
+recordings/:id/access-link
+
+Generate an access link for a recording
+
+### Examples
+
+```ruby
+require 'time'
+require 'daily-ruby'
+# setup authorization
+Daily.configure do |config|
+  # Configure API key authorization: sec0
+  config.api_key['sec0'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sec0'] = 'Bearer'
+end
+
+api_instance = Daily::RecordingsApi.new
+recording_id = 'recording_id_example' # String | 
+
+begin
+  # recordings/:id/access-link
+  result = api_instance.get_recording_link(recording_id)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->get_recording_link: #{e}"
+end
+```
+
+#### Using the get_recording_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRecordingLink200Response>, Integer, Hash)> get_recording_link_with_http_info(recording_id)
+
+```ruby
+begin
+  # recordings/:id/access-link
+  data, status_code, headers = api_instance.get_recording_link_with_http_info(recording_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRecordingLink200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->get_recording_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recording_id** | **String** |  |  |
+
+### Return type
+
+[**GetRecordingLink200Response**](GetRecordingLink200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_recordings
+
+> <ListRecordings200Response> list_recordings(opts)
+
+/recordings
+
+List recordings
+
+### Examples
+
+```ruby
+require 'time'
+require 'daily-ruby'
+# setup authorization
+Daily.configure do |config|
+  # Configure API key authorization: sec0
+  config.api_key['sec0'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sec0'] = 'Bearer'
+end
+
+api_instance = Daily::RecordingsApi.new
+opts = {
+  limit: 56, # Integer | 
+  ending_before: 'ending_before_example', # String | 
+  starting_after: 'starting_after_example', # String | 
+  room_name: 'room_name_example' # String | 
+}
+
+begin
+  # /recordings
+  result = api_instance.list_recordings(opts)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->list_recordings: #{e}"
+end
+```
+
+#### Using the list_recordings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRecordings200Response>, Integer, Hash)> list_recordings_with_http_info(opts)
+
+```ruby
+begin
+  # /recordings
+  data, status_code, headers = api_instance.list_recordings_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRecordings200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling RecordingsApi->list_recordings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **ending_before** | **String** |  | [optional] |
+| **starting_after** | **String** |  | [optional] |
+| **room_name** | **String** |  | [optional] |
+
+### Return type
+
+[**ListRecordings200Response**](ListRecordings200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RecordingsBucket.md

@@ -0,0 +1,26 @@
+# Daily::RecordingsBucket
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bucket_name** | **String** | The name of the Amazon S3 bucket to use for recording storage. | [optional] |
+| **bucket_region** | **String** | The region which the specified S3 bucket is located in. | [optional] |
+| **assume_role_arn** | **String** | The Amazon Resource Name (ARN) of the role Daily should assume when storing the recording in the specified bucket. | [optional] |
+| **allow_api_access** | **Boolean** | Controls whether the recording will be accessible using Daily's API. | [optional] |
+| **allow_streaming_from_bucket** | **Boolean** | Specifies which [`Content-Disposition`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response header the recording link retrieved from the [access-link](/reference/rest-api/recordings/get-recording-link) REST API endpoint will have. If `allow_streaming_from_bucket` is `false`, the header will be `Content-Dispostion: attachment`. If `allow_streaming_from_bucket` is `true`, the header will be `Content-Disposition: inline`. To play the recording link directly in the browser or embed it in a video player, set this property to `true`. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingsBucket.new(
+  bucket_name: my-daily-recording,
+  bucket_region: ap-south-1,
+  assume_role_arn: arn:aws:iam::555555555555:role/DailyS3AccessRole,
+  allow_api_access: null,
+  allow_streaming_from_bucket: null
+)
+```
+

data/docs/RoomProperties.md

@@ -0,0 +1,94 @@
+# Daily::RoomProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nbf** | **Integer** | \"Not before\". This is a [unix timestamp](https://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. | [optional] |
+| **exp** | **Integer** | \"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](https://www.daily.co/blog/add-advanced-security-features-to-video-chats-with-the-daily-api/) | [optional] |
+| **max_participants** | **Integer** | How many people are allowed in a room at the same time.  ⚠️ [Contact us](https://www.daily.co/contact) if you need to set the limit above 200. | [optional][default to 200] |
+| **enable_people_ui** | **Boolean** | 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). | [optional] |
+| **enable_pip_ui** | **Boolean** | Sets whether the room can use [Daily Prebuilt](https://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. | [optional] |
+| **enable_emoji_reactions** | **Boolean** | Determines if [Daily Prebuilt](https://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. | [optional] |
+| **enable_hand_raising** | **Boolean** | Sets whether the participants in the room can use [Daily Prebuilt](https://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. | [optional] |
+| **enable_prejoin_ui** | **Boolean** | Determines whether participants enter a waiting room with a camera, mic, and browser check before joining a call.  ⚠️ You must be using [Daily Prebuilt](https://daily.co/prebuilt) to use `enable_prejoin_ui`. | [optional] |
+| **enable_network_ui** | **Boolean** | Determines whether the network button, and the network panel it reveals on click, appears in this room.  ⚠️ You must be using [Daily Prebuilt](https://daily.co/prebuilt) to use `enable_network_ui`. | [optional] |
+| **enable_noise_cancellation_ui** | **Boolean** | 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](https://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). | [optional] |
+| **enable_breakout_rooms** | **Boolean** | Sets whether [Daily Prebuilt](https://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](https://daily.co/blog/daily-prebuilt-video-chat) to use `enable_breakout_rooms`.  ⚠️ This property is in beta. | [optional] |
+| **enable_knocking** | **Boolean** | 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. | [optional] |
+| **enable_screenshare** | **Boolean** | 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. | [optional][default to true] |
+| **enable_video_processing_ui** | **Boolean** | 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. | [optional][default to true] |
+| **enable_chat** | **Boolean** | This property is one of [multiple ways to add chat to Daily video calls](https://www.daily.co/blog/three-ways-to-add-chat-to-your-video-calls-with-the-daily-api/). | [optional][default to false] |
+| **start_video_off** | **Boolean** | Disable the default behavior of automatically turning on a participant's camera on a direct `join()` (i.e. without `startCamera()` first). | [optional][default to false] |
+| **start_audio_off** | **Boolean** | Disable the default behavior of automatically turning on a participant's microphone on a direct `join()` (i.e. without `startCamera()` first). | [optional][default to false] |
+| **owner_only_broadcast** | **Boolean** | In Daily Prebuilt, only the meeting owners will be able to turn on camera, unmute mic, and share screen.  See [setting up calls](https://docs.daily.co/docs/setting-up-calls). | [optional][default to false] |
+| **enable_recording** | **String** | Jump to [recording docs](/reference/rest-api/recordings). | [optional][default to '<not set>'] |
+| **eject_at_room_exp** | **Boolean** | 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). | [optional][default to false] |
+| **eject_after_elapsed** | **Integer** | 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). | [optional] |
+| **enable_advanced_chat** | **Boolean** | 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. | [optional][default to false] |
+| **enable_hidden_participants** | **Boolean** | 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](https://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. | [optional][default to false] |
+| **enable_mesh_sfu** | **Boolean** | 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. | [optional] |
+| **sfu_switchover** | **Float** | 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. | [optional][default to 2] |
+| **experimental_optimize_large_calls** | **Boolean** | 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. | [optional] |
+| **lang** | **String** | 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](https://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. | [optional][default to 'en'] |
+| **meeting_join_hook** | **String** | 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](https://www.daily.co/blog/configure-a-webhook-to-send-notifications-when-someone-joins-your-video-calls/) | [optional] |
+| **geo** | **String** | 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) | [optional][default to 'NULL'] |
+| **rtmp_geo** | **String** | 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\"` | [optional][default to 'The closest available region to the SFU region used by the meeting.'] |
+| **disable_rtmp_geo_fallback** | **Boolean** | 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. | [optional][default to false] |
+| **recordings_bucket** | [**RecordingsBucket**](RecordingsBucket.md) |  | [optional] |
+| **enable_terse_logging** | **Boolean** | 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. | [optional][default to false] |
+| **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. | [optional] |
+| **enable_transcription_storage** | **Boolean** | 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. | [optional][default to false] |
+| **transcription_bucket** | [**TranscriptionBucket**](TranscriptionBucket.md) |  | [optional] |
+| **recordings_template** | **String** | 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` | [optional][default to '{domain_name}/{room_name}/{epoch_time}.'] |
+| **streaming_endpoints** | [**Array<RoomPropertiesStreamingEndpointsInner>**](RoomPropertiesStreamingEndpointsInner.md) | 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: | [optional] |
+| **permissions** | [**Permissions**](Permissions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RoomProperties.new(
+  nbf: null,
+  exp: null,
+  max_participants: null,
+  enable_people_ui: null,
+  enable_pip_ui: null,
+  enable_emoji_reactions: null,
+  enable_hand_raising: null,
+  enable_prejoin_ui: null,
+  enable_network_ui: null,
+  enable_noise_cancellation_ui: null,
+  enable_breakout_rooms: null,
+  enable_knocking: null,
+  enable_screenshare: null,
+  enable_video_processing_ui: null,
+  enable_chat: null,
+  start_video_off: null,
+  start_audio_off: null,
+  owner_only_broadcast: null,
+  enable_recording: null,
+  eject_at_room_exp: null,
+  eject_after_elapsed: null,
+  enable_advanced_chat: null,
+  enable_hidden_participants: null,
+  enable_mesh_sfu: null,
+  sfu_switchover: null,
+  experimental_optimize_large_calls: null,
+  lang: null,
+  meeting_join_hook: null,
+  geo: null,
+  rtmp_geo: null,
+  disable_rtmp_geo_fallback: null,
+  recordings_bucket: null,
+  enable_terse_logging: null,
+  auto_transcription_settings: {"language":"de"},
+  enable_transcription_storage: null,
+  transcription_bucket: null,
+  recordings_template: null,
+  streaming_endpoints: null,
+  permissions: null
+)
+```
+

data/docs/RoomPropertiesStreamingEndpointsInner.md

@@ -0,0 +1,28 @@
+# Daily::RoomPropertiesStreamingEndpointsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Used by the `startLiveStreaming()` API to reference which stream configuration to start. | [optional] |
+| **type** | **String** | Whether the streaming endpoint is `rtmp` or `hls`. | [optional] |
+| **hls_config_storage_path** | **String** | 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['storage']['bucket_name']/hls_config['storage']['path']/<mtgSessionId>/master.m3u8`. | [optional] |
+| **hls_config_storage_path_template** | **String** | `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` | [optional] |
+| **hls_config_save_hls_recording** | **Boolean** | 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. | [optional] |
+| **hls_config_variants** | [**Array<RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner>**](RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner.md) | 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 | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RoomPropertiesStreamingEndpointsInner.new(
+  name: rtmp_ivs,
+  type: hls,
+  hls_config_storage_path: my-bucket-name/my-folder-name,
+  hls_config_storage_path_template: null,
+  hls_config_save_hls_recording: null,
+  hls_config_variants: null
+)
+```
+

data/docs/RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner.md

@@ -0,0 +1,26 @@
+# Daily::RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **width** | **Float** | Output width. Min: `32`. Max: `1920`. | [optional] |
+| **height** | **Float** | Output height. Min: `32`. Max: `1920`. For portrait mode, the height can be greater than the width.  | [optional] |
+| **fps** | **Float** | Output FPS. Min: `1`. Max: `30`. | [optional] |
+| **bitrate** | **Float** | Bitrate in kilobits per second (kbps). Min: `100`. Max: `5000`. | [optional] |
+| **iframe_only** | **Boolean** | Whether this variant is iframe-only. One iframe is generated for each segment. If `true`, the `fps` property is ignored. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner.new(
+  width: null,
+  height: null,
+  fps: null,
+  bitrate: null,
+  iframe_only: null
+)
+```
+