Skip to content

Latest commit

 

History

History
84 lines (78 loc) · 19.1 KB

DomainProperties.md

File metadata and controls

84 lines (78 loc) · 19.1 KB
Raw

Daily::DomainProperties

Properties

Name Type Description Notes
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_people_ui Boolean Determines if Daily 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. [optional][default to true]
enable_pip_ui Boolean Sets whether rooms for this domain can use Daily 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][default to false]
enable_emoji_reactions Boolean Determines if Daily 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][default to false]
enable_hand_raising Boolean Sets whether the participants in the room can use Daily 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][default to false]
enable_prejoin_ui Boolean Determines whether participants enter a waiting room with a camera, mic, and browser check before joining a call in any room under this domain. ⚠️ You must be using Daily Prebuilt to use `enable_prejoin_ui`. [optional][default to true]
enable_breakout_rooms Boolean Sets whether rooms for this domain have Daily Prebuilt’s breakout rooms feature 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 to use `enable_breakout_rooms`. ⚠️ This property is in beta. [optional][default to false]
enable_live_captions_ui Boolean Sets whether participants in a room see a closed captions button in their Daily Prebuilt call tray. When the closed caption button is clicked, closed captions are displayed locally. When set to `true`, a closed captions button appears in the call tray. When set to `false`, the closed captions button is hidden from the call tray. Note: Transcription must be enabled for the room or users must have permission to start transcription for this feature to be enabled. View the transcription guide for more details. ⚠️ You must be using Daily Prebuilt to use `enable_live_captions_ui`. [optional][default to false]
enable_network_ui Boolean Determines whether the network button, and the network panel it reveals on click, appears across all rooms belonging to this domain. ⚠️ You must be using Daily Prebuilt to use `enable_network_ui`. [optional][default to false]
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. 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. [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]
hide_daily_branding Boolean Whether "Powered by Daily" displays in the in-call UI. [optional][default to false]
redirect_on_meeting_exit String (For meetings that open in a separate browser tab.) When a user clicks on the in-call menu bar's &quot;leave meeting&quot; button, the browser loads this URL. A query string that includes a parameter of the form `recent-call=<domain>/<room>` is appended to the URL. On mobile, you can redirect to a deep link to bring a user back into your app. [optional]
hipaa Boolean Email us at [email protected] to turn on HIPAA. Learn more about our HIPAA compliance. [optional][default to false]
intercom_auto_record Boolean Whether to automatically start recording when an Intercom support agent joins an Intercom-created call. Please see our Intercom Messenger App page for more information. ⚠️This method is read-only; please contact us if you'd like to enable intercom call auto-recording. [optional]
lang String The default language for the video call UI, for all calls. If you set the language at this domain level, you can still override the setting for specific rooms in a room's configuration properties, or for a specific participant in a meeting token. You can also set the language dynamically using the front-end library setDailyLang() method. `*` Norwegian `&quot;no&quot;` and Russian `&quot;ru&quot;` 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. ⚠️ In place of the `meeting_join_hook`, we recommend setting up a webhook and listening for the `participant.joined` event. [optional][default to 'NULL']
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: - `&quot;af-south-1&quot;` (Cape Town) - `&quot;ap-northeast-2&quot;` (Seoul) - `&quot;ap-southeast-1&quot;` (Singapore) - `&quot;ap-southeast-2&quot;` (Sydney) - `&quot;ap-south-1&quot;` (Mumbai) - `&quot;eu-central-1&quot;` (Frankfurt) - `&quot;eu-west-2&quot;` (London) - `&quot;sa-east-1&quot;` (São Paulo) - `&quot;us-east-1&quot;` (N. Virginia) - `&quot;us-west-2&quot;` (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: - `&quot;us-west-2&quot;` (Oregon) - `&quot;eu-central-1&quot;` (Frankfurt) - `&quot;ap-south-1&quot;` (Mumbai) The default regions are grouped based on the SFU region like so: - RTMP region `&quot;us-west-2&quot;` includes SFU regions: `&quot;us-west-2&quot;`, `&quot;us-east-1&quot;`, `&quot;sa-east-1&quot;` - RTMP region `&quot;eu-central-1&quot;` includes SFU regions: `&quot;eu-central-1&quot;`, `&quot;eu-west-2&quot;`, `&quot;af-south-1&quot;` - RTMP region `&quot;ap-south-1&quot;` includes SFU regions: `&quot;ap-southeast-1&quot;`, `&quot;ap-southeast-2&quot;`, `&quot;ap-northeast-2&quot;`, `&quot;ap-south-1&quot;` [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]
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 for additional instruction. [optional][default to false]
enable_transcription_storage Boolean Live transcriptions generated can be saved as WebVTT. This flag controls if transcription started with `startTranscription()` should be saved or not. [optional][default to false]
transcription_bucket TranscriptionBucket [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: &quot;myDomain&quot; - Example room: &quot;myRoom&quot; 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}.']
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 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 `2` and the current network topology is P2P, the topology will switch to SFU mode when the third participant joins the call. If the current topology is SFU, it will switch to P2P mode when the participant count decreases from `2` to `1`. 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 for additional information. [optional][default to 0.5]
enable_adaptive_simulcast Boolean Configures a domain or room to use Daily Adaptive Bitrate. When enabled, along with configuring the client to `allowAdaptiveLayers`, the Daily client will continually adapt send settings to the current network conditions. `allowAdaptiveLayers` is `true` by default; if you haven't modified that setting, then setting `enable_adaptive_simulcast` to `true` will enable Daily Adaptive Bitrate for 1:1 calls. [optional][default to true]
enforce_unique_user_ids Boolean Configures a domain or room to disallow multiple participants from having the same `user_id`. This feature can be enabled to prevent users from &quot;sharing&quot; meeting tokens. When enabled, a participant joining or reconnecting to a meeting will cause existing participants with the same user_id to be ejected. [optional][default to false]
recordings_bucket RecordingsBucket [optional]
permissions Permissions [optional]
batch_processor_bucket Object Defines a custom S3 bucket where the batch processor will write its output [optional]
enable_opus_fec Boolean Enables the use of Opus in-band FEC (Forward Error Correction) when encoding audio to send, where possible. This can make audio quality more resilient to packet loss. [optional]
pinless_dialin Array<PinlessDialinInner> SIP Interconnect and Pinless Dialin,i.e., without entering a PIN code when dialling a phone number or directly calling a Daily SIP Interconnect address. In this case you dont need a SIP address associated to a particular Daily Room. When a call comes in to this phone number or to the sip interconnect address, it will trigger a webhook, where you'll need to create the Daily room and forward the call to the `sipUri` assocaited to the newly created room. The Pinless Dialin only works with purchased phone numbers, because the call is not intended for a particular Daily room. Read more details on our dosc-site. [optional]
pin_dialin Array<PinDialinInner> Dialin with a PIN code. This works with both the Global phone numbers and any number that you purchased. When a call comes into one of the phone numbers, the dialer must enter the PIN code. If the code is correct, the user will be connected to the Daily Room. Otherwise the incoming call will be disconnected if an incorrect PIN code is entered. [optional]

Example

require 'daily-ruby'

instance = Daily::DomainProperties.new(
  enable_advanced_chat: null,
  enable_people_ui: null,
  enable_pip_ui: null,
  enable_emoji_reactions: null,
  enable_hand_raising: null,
  enable_prejoin_ui: null,
  enable_breakout_rooms: null,
  enable_live_captions_ui: null,
  enable_network_ui: null,
  enable_noise_cancellation_ui: null,
  enable_video_processing_ui: null,
  hide_daily_branding: null,
  redirect_on_meeting_exit: null,
  hipaa: null,
  intercom_auto_record: null,
  lang: null,
  meeting_join_hook: null,
  geo: null,
  rtmp_geo: null,
  disable_rtmp_geo_fallback: null,
  enable_terse_logging: null,
  enable_transcription_storage: null,
  transcription_bucket: null,
  recordings_template: null,
  enable_mesh_sfu: null,
  sfu_switchover: null,
  enable_adaptive_simulcast: null,
  enforce_unique_user_ids: null,
  recordings_bucket: null,
  permissions: null,
  batch_processor_bucket: null,
  enable_opus_fec: null,
  pinless_dialin: null,
  pin_dialin: null
)