Skip to content

Latest commit

 

History

History
62 lines (56 loc) · 10 KB

Properties.md

File metadata and controls

62 lines (56 loc) · 10 KB
Raw

Daily::Properties

Properties

Name Type Description Notes
room_name String The room for which this token is valid. If `room_name` isn't set, the token is valid for all rooms in your domain. *You should always set `room_name` if you are using this token to control access to a meeting. [optional]
eject_at_token_exp Boolean Kick this user out of the meeting at the time this meeting token expires. If either this property or `eject_after_elapsed` are set for the token, the room's `eject` properties are overridden. See an example in our advanced security tutorial. [optional][default to false]
eject_after_elapsed Integer Kick this user out of the meeting this many seconds after they join the meeting. If either this property or `eject_at_token_exp` are set for the token, the room's `eject` properties are overridden. See an example in our advanced security tutorial. [optional]
nbf Integer "Not before". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in with this token before this time. [optional]
exp Integer "Expires". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting with this token after this time. Daily strongly recommends adding an `exp` value to all meeting tokens. Learn more in our Daily blog post: Add advanced security to video chats with the Daily API [optional]
is_owner Boolean The user has meeting owner privileges. For example, if the room is configured for `owner_only_broadcast` and used in a Daily Prebuilt call, this user can send video, and audio, and can screenshare. [optional][default to false]
user_name String The user's name in this meeting. The name displays in the user interface when the user is muted or has turned off the camera, and in the chat window. This username is also saved in the meeting events log (meeting events are retrievable using the analytics API methods.) [optional]
user_id String The user's ID for this meeting session. During a session, this ID is retrievable in the `participants()` method and related participant events. Either during or after a session concludes, this ID is retrievable using the /meetings REST API endpoint. You can use `user_id` to map between your user database and meeting events/attendance. For domains configured for HIPAA compliance, if the `user_id` value is a UUID (for example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`), then the UUID will be returned for the participant in the `/meetings` REST API endpoint. Otherwise, the string `hipaa` will be returned in order to remove potential PHI. During a session, the provided `user_id` will always be returned through the `participants()` method and related events, regardless of the `user_id` value. The `user_id` has a limit of 36 characters. [optional]
enable_screenshare Boolean Sets whether or not the user is allowed to screen share. This setting applies for the duration of the meeting. If you're looking to dynamically control whether a user can screen share during a meeting, then use the `permissions` token property. [optional][default to true]
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]
enable_recording String Jump to recording docs. [optional]
enable_prejoin_ui Boolean Determines whether the participant using the meeting token enters a waiting room with a camera, mic, and browser check before joining a call. If this property is also set in the room or domain's configuration, the meeting token's configuration will take priority. ⚠️ You must be using Daily Prebuilt to use `enable_prejoin_ui`. [optional]
enable_live_captions_ui Boolean Sets whether the participant sees 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]
enable_recording_ui Boolean Determines whether the participant using the meeting token can see the Recording button in Daily Prebuilt's UI, which can be found in the video call tray. If this value is `false`, the button will not be included in the tray. If it's `true`, the Recording button will be displayed. This option is useful when only specific call participants should have recording permissions. ⚠️ You must be using Daily Prebuilt to use `enable_recording_ui`. [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 for additional instruction. [optional][default to false]
start_cloud_recording Boolean Start cloud recording when the user joins the room. This can be used to always record and archive meetings, for example in a customer support context. Note: This requires the `enable_recording` property of the room or token to be set to `cloud`. If you want to automatically record calls with other recording modes, use `callObject.startRecording()` after `await callObject.join()` in your code. [optional][default to false]
start_cloud_recording_opts Object Options for use when `start_cloud_recording` is `true`. See `startRecording` for available options. ⚠️ Specifying too many options may cause the token size to be very large. It is recommended to use token less than 2048 characters. For complex usecases, use the daily-js API. [optional]
auto_start_transcription Boolean Start transcription when an owner joins the room. This property can be used to always transcribe meetings once an owner joins. [optional][default to false]
close_tab_on_exit Boolean (For meetings that open in a separate browser tab.) When a user leaves a meeting using the button in the in-call menu bar, the browser tab closes. This can be a good way, especially on mobile, for users to be returned to a previous website flow after a call. [optional][default to false]
redirect_on_meeting_exit String (For meetings that open in a separate browser tab.) When a user leaves a meeting using the button in the in-call menu bar, 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]
lang String The default language of the Daily prebuilt video call UI, for this room. Setting the language at the token level will override any room or domain-level language settings you have. Read more about changing prebuilt UI language settings. `*` Norwegian `&quot;no&quot;` and Russian `&quot;ru&quot;` are only available in the new Daily Prebuilt. [optional][default to 'en']
permissions Permissions [optional]

Example

require 'daily-ruby'

instance = Daily::Properties.new(
  room_name: null,
  eject_at_token_exp: null,
  eject_after_elapsed: null,
  nbf: null,
  exp: null,
  is_owner: null,
  user_name: null,
  user_id: null,
  enable_screenshare: null,
  start_video_off: null,
  start_audio_off: null,
  enable_recording: null,
  enable_prejoin_ui: null,
  enable_live_captions_ui: null,
  enable_recording_ui: null,
  enable_terse_logging: null,
  start_cloud_recording: null,
  start_cloud_recording_opts: null,
  auto_start_transcription: null,
  close_tab_on_exit: null,
  redirect_on_meeting_exit: null,
  lang: null,
  permissions: null
)