Skip to content

Latest commit

 

History

History
69 lines (66 loc) · 13 KB

UserInMeetingSettings.md

File metadata and controls

69 lines (66 loc) · 13 KB

# UserInMeetingSettings

Properties

Name Type Description Notes
allow_host_to_enable_focus_mode bool Whether the host can enable Focus Mode when scheduling a meeting. This value defaults to `null`. [optional]
allow_live_streaming bool Allow livestreaming. [optional]
post_meeting_feedback bool Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting. [optional]
whiteboard bool Whether to enable the Zoom Whiteboard feature. [optional]
allow_participants_chat_with int Who participants can chat with: * `1` — The participant cannot use chat. * `2` — The participant can chat with the host and co-hosts only. * `3` — The participant can chat with other participants publicly. * `4` - The participant can chat with other participants publicly and privately. Note: This setting is only available with client versions 5.7.3 and above. [optional]
allow_users_save_chats int How participants can save meeting chats: * `1` — Participants cannot save meeting chats. * `2` — Participants can only save host and co-host meeting chats. * `3` — Participants can save all meeting chats. [optional]
annotation bool Allow meeting participants to use the annotation tools. This value defaults to `false`. [optional] [default to false]
attendee_on_hold bool Allow the host to put an attendee on hold. This value defaults to `false`. This field has been deprecated and is no longer supported. [optional] [default to false]
attention_mode_focus_mode bool Whether the Focus Mode feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. This value defaults to `false`. [optional] [default to false]
auto_saving_chat bool Automatically save all in-meeting chats. This value defaults to `false`. [optional] [default to false]
breakout_room bool Allow the meeting host to split meeting participants into separate breakout rooms. [optional] [default to false]
breakout_room_schedule bool Allow the host to assign participants to breakout rooms when scheduling. This feature is only available in version 4.5.0 or higher. [optional]
chat bool Enable chat during meeting for all participants. This value defaults to `false`. [optional] [default to false]
closed_caption bool Enable closed captions. This value defaults to `false`. [optional] [default to false]
closed_captioning \Zoom\Api\Model\UserInMeetingSettingsClosedCaptioning [optional]
co_host bool Allow the host to add co-hosts. This value defaults to `false`. [optional] [default to false]
custom_data_center_regions bool Use custom data center regions: * `true` — Users can select data center regions to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. * `false` — Only use the default data center regions. [optional]
custom_live_streaming_service bool Allow custom livestreaming. [optional]
custom_service_instructions string The custom livestreaming service instructions. [optional]
data_center_regions string[] If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following data center regions to opt in to: * `AU` — Australia. * `LA` — Latin America. * `CA` — Canada. * `CN` — China. * `DE` — Germany. * `HK` — Hong Kong SAR. * `IN` — India. * `IE` — Ireland. * `TY` — Japan. * `MX` — Mexico. * `NL` — Netherlands. * `SG` — Singapore. * `US` — United States. [optional]
disable_screen_sharing_for_host_meetings bool Enable the Disable desktop screen sharing for meetings you host setting. [optional]
disable_screen_sharing_for_in_meeting_guests bool Enable the Disable screen sharing when guests are in the meeting setting. [optional]
e2e_encryption bool Require AES encryption for meetings. [optional]
entry_exit_chime string When to play the meeting entry/exit sound notification: * `host` — Only when the host joins or leaves. * `all` — When any participant joins or leaves. * `none` - Disable the entry/exit sound notification. This value defaults to `all`. [optional] [default to 'all']
far_end_camera_control bool Allow another user to take control of the user's camera. This value defaults to `false`. [optional] [default to false]
feedback bool Enable the Feedback to Zoom setting. This value defaults to `false`. [optional] [default to false]
file_transfer bool Indicates whether in-meeting file transfer setting has been enabled for the user or not. [optional]
group_hd bool Enable group HD video. This value defaults to `false`. [optional] [default to false]
join_from_desktop bool Allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited. [optional]
join_from_mobile bool Allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited. [optional]
language_interpretation \Zoom\Api\Model\UserInMeetingSettingsLanguageInterpretation [optional]
live_streaming_facebook bool Allow Facebook livestreaming. [optional]
live_streaming_youtube bool Allow YouTube livestreaming. [optional]
manual_captioning \Zoom\Api\Model\UserSettingsInMeetingManualCaptioning [optional]
meeting_reactions bool Whether meeting participants can communicate using the emoji reactions located in the Reactions menu in the meeting toolbar. [optional]
meeting_survey bool Allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher. [optional]
non_verbal_feedback bool Enable the Non-verbal feedback setting. This value defaults to `false`. [optional] [default to false]
polling bool Add polls to the meeting controls. This value defaults to `false`. [optional] [default to false]
private_chat bool Enable private chat between participants during meetings. This value defaults to `false`. [optional] [default to false]
record_play_voice bool Let the user record and play their own voice. [optional]
remote_control bool Enable the Remote control setting. This value defaults to `false`. [optional] [default to false]
remote_support bool Enable the Remote support setting. This value defaults to `false`. [optional] [default to false]
request_permission_to_unmute bool Indicates whether the Request permission to unmute participants option has been enabled for the user or not. [optional]
screen_sharing bool Allow host and participants to share their screen or content during meetings [optional]
share_dual_camera bool Allow the use of shared dual cameras. This value defaults to `false`. This field is deprecated. [optional] [default to false]
show_a_join_from_your_browser_link bool Allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited. [optional]
show_meeting_control_toolbar bool Always display the in-meeting controls. [optional]
slide_control bool Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher. [optional]
virtual_background bool Enable Virtual Backgrounds. This value defaults to `false`. [optional] [default to false]
virtual_background_settings \Zoom\Api\Model\UserInMeetingSettingsVirtualBackgroundSettings [optional]
waiting_room bool Enable the Waiting Room feature. This value defaults to `false`. [optional] [default to false]
webinar_chat \Zoom\Api\Model\UserInMeetingSettingsWebinarChat [optional]
webinar_live_streaming \Zoom\Api\Model\UserInMeetingSettingsWebinarLiveStreaming [optional]
webinar_polling \Zoom\Api\Model\UserInMeetingSettingsWebinarPolling [optional]
webinar_survey bool Allow the host to present surveys to attendees once a webinar has ended. [optional]
who_can_share_screen string Indicates who can share their screen or content during meetings. The value can be one of the following: <br> `host`: Only host can share the screen.<br> `all`: Both hosts and attendees can share their screen during meetings. For Webinar, the hosts and panelists can start screen sharing, but not the attendees. [optional]
who_can_share_screen_when_someone_is_sharing string Indicates who is allowed to start sharing screen when someone else in the meeting is sharing their screen. The value can be one of the following:<br> `host`: Only a host can share the screen when someone else is sharing.<br> `all`: Anyone in the meeting is allowed to start sharing their screen when someone else is sharing. For Webinar, the hosts and panelists can start screen sharing, but not the attendees. [optional]
participants_share_simultaneously string Indicates how many participants can share at the same time. The value can be one of the following:<br> `one`: Only one participant can share at a time .<br> `multiple`: Multiple participants can share simultaneously (dual monitors recommended). [optional]
workplace_by_facebook bool Allow Workplace by Facebook livestreaming. [optional]
auto_answer bool Allow the user to view and add contacts to the Auto-answer group in chat feature. Calls from members of the Auto Answer Group will be automatically answered the user. [optional]
allow_show_zoom_windows bool Enable the Show Zoom windows during screen share feature. [optional]

[Back to Model list] [Back to API list] [Back to README]