zConfiguration

zConfigurations represent read/write configuration parameters: you can get the current value of the parameter, by specifying the parameter name but leaving out the value. Or, you can set the value by specifying the parameter name with a value.

zConfiguration Call ClosedCaption Visible: `<on/off>`

Show/Hide ClosedCaption.

Schema:

zConfiguration Call ClosedCaption Visible: <on/off>

Example:

zConfiguration Call ClosedCaption Visible:On
*c zConfiguration Call ClosedCaption Visible: on
** end

zConfiguration Call ClosedCaption FontSize: `<0/1/2>`

Change ClosedCaption.FontSize.

Schema:

zConfiguration Call ClosedCaption FontSize: <0/1/2>

Example:

zConfiguration Call ClosedCaption FontSize:0
*c zConfiguration Call ClosedCaption FontSize: 0
** end

zConfiguration Call ClosedCaption Disable: `<on/off>`

Disable/Enable ClosedCaption when CanDisable is true.

Schema:

zConfiguration Call ClosedCaption Disable: <on/off>

Example:

zConfiguration Call ClosedCaption Disable:on
*c zConfiguration Call ClosedCaption Disable: on
** end

zConfiguration Call Sharing `optimize_video_sharing` - In-Meeting

Turn on or off video optimization for screen sharing.

Schema:

zConfiguration Call Sharing optimize_video_sharing: <on/off>

Example:

zConfiguration Call Sharing optimize_video_sharing
*c zConfiguration Call Sharing optimize_video_sharing: off
** end
OK

optimize_video_sharing — Set to On to optimize screen sharing when playing videos.

zConfiguration Call Microphone Mute - In-Meeting

Mute/unmute the Zoom Room microphone.

Schema:

zConfiguration Call Microphone Mute: <on/off>

Example:

zConfiguration Call Microphone Mute
*c zConfiguration Call Microphone Mute: off
** end
OK

Mute — Set to On to mute the currently selected microphone.

zConfiguration Call Camera Mute - In-Meeting

Mute/unmute the Zoom Room camera.

Schema:

zConfiguration Call Camera Mute: <on/off>

Example:

zConfiguration Call Camera Mute
*c zConfiguration Call Camera Mute: off
** end
OK

Mute — Set to On to mute the currently selected camera.

zConfiguration Audio Input `selectedId`

Get the ID of the currently selected audio input device. Or, switch to an audio input device by setting its ID here. Get the list of device IDs using zStatus Audio Input Line.

Schema:

zConfiguration Audio Input selectedId: <string>

Example:

zConfiguration Audio Input SelectedId
*c zConfiguration Audio Input selectedId: Sennheiser SC70 USB CTRL
** end
OK

selectedId — The ID of the device.

zConfiguration Audio Input is_sap_disabled

Turn on or off software audio processing (SAP).

Schema:

zConfiguration Audio Input is_sap_disabled: <on/off>

Example:

zConfiguration Audio Input is_sap_disabled
*c zConfiguration Audio Input is_sap_disabled: off
** end
OK

is_sap_disabled — Set to On to disable software audio processing (SAP), which includes automatic gain control (AGC) for the microphone and acoustic echo cancellation (AEC). You'll want to disable SAP if you have a speakerphone that implements echo cancellation.

zConfiguration Audio Input `reduce_reverb`

Turn on or off reduce reverb feature.

Schema:

zConfiguration Audio Input reduce_reverb: <on/off>

Example:

zConfiguration Audio Input reduce_reverb
*c zConfiguration Audio Input reduce_reverb: off
** end
OK

reduce_reverb — Set to On to reduce echo coming from the Zoom Room. This feature will only work if is_sap_disabled is set to Off.

zConfiguration Audio Input `volume`

Get/Set the volume for the currently selected microphone.

Schema:

zConfiguration Audio Input volume: <int>

Example:

zConfiguration Audio Input volume
*c zConfiguration Audio Input volume: 0
** end
OK

volume — Range is 0 to 100. Volume settings are stored per-device, and automatically change to a new value when the selected device changes, in which case the ZR-CSAPI issues a notification.

zConfiguration Audio Output `selectedId`

Get/Set the ID of the currently selected audio output device. Or, switch to an audio output device by setting its ID here. Get the list of device IDs using zStatus Audio Output Line.

Schema:

zConfiguration Audio Output selectedId: <string>

Example:

zConfiguration Audio Output selectedId
*c zConfiguration Audio Output selectedId: Sennheiser SC70 USB CTRL
** end
OK

selectedId — The ID of the device.

zConfiguration Audio Output `volume`

Get/Set the volume for the currently selected speaker.

Schema:

zConfiguration Audio Output volume: <int>

Example:

zConfiguration Audio Output volume
*c zConfiguration Audio Output volume: 60
** end
OK

volume — Range is 0 to 100. Volume settings are stored per-device, and automatically change to a new value when the selected device changes, in which case the ZR-CSAPI issues a notification.

zConfiguration Video `hide_conf_self_video`

Show or hide the self view video while in a meeting.

Schema:

zConfiguration Video hide_conf_self_video: <on/off>

Example:

zConfiguration Video hide_conf_self_video
*c zConfiguration Video hide_conf_self_video: on
** end
OK

hide_conf_self_video — Set to On to hide the self-view video, which appears either full-screen (if no other video participants have joined), or in a thumbnail window in active speaker mode.

zConfiguration Video Camera `selectedId`

Get/Set the ID of the currently selected camera. Or, switch to a camera by setting its ID here. Get the list of device IDs using zStatus Camera Line.

Schema:

zConfiguration Video Camera selectedId: <string>

Example:

zConfiguration Video Camera selectedId
*c zConfiguration Video Camera selectedId: CDC85FD0-E73A-4FC2-B3A8-EA237D6990E0
** end
OK

selectedId — The ID of the device.

zConfiguration Video Camera Mirror

Get/Set Mirror mode for the ZR self view video window. This setting does not affect what other participants see.

Schema:

zConfiguration Video Camera Mirror: <on/off>

Example:

zConfiguration Video Camera Mirror
*c zConfiguration Video Camera Mirror: on
** end
OK

Mirror — Set to On to mirror the camera.

zConfiguration Client appVersion

Get/Set the appVersion value. This string will appear on the Web Portal under the ZR Devices list for this Zoom Room. It can be used to report the version of software running in an automation controller.

Schema:

zConfiguration Client appVersion: <string>

Example:

zConfiguration Client appVersion
*c zConfiguration Client appVersion: 1.0.9
** end
OK

appVersion — The app version text that will appear on the Zoom Web Portal.

zConfiguration Client deviceSystem

Get/Set the deviceSystem value. This string will appear on the Web Portal under the ZR Devices list for this Zoom Room. It can be used to report the type of automation controller connected to the ZR.

Schema:

zConfiguration Client deviceSystem[: <string>]

Example:

zConfiguration Client deviceSystem
*c zConfiguration Client deviceSystem: Command Line 2
** end
OK

deviceSystem — The system device text that will appear on the Zoom Web Portal.

zConfiguration Call Layout ShareThumb - In-Meeting

Swaps the screen share image to/from a thumbnail. Corresponds to the Swap Content button in the Layout options on the ZRC. Normally, when sharing screen content, the screen capture content is shown full-screen, and other videos are shown in a thumbnail. Use this command to put the sharing content into a thumbnail video.

Schema:

zConfiguration Call Layout ShareThumb: <on/off>

Example:

zConfiguration Call Layout ShareThumb
*c zConfiguration Call Layout ShareThumb: off
** end
OK

ShareThumb — If allowed by can_Switch_Floating_Share_Content, set to On to show sharing content in a thumbnail, instead of full-screen. If set to Off, shows sharing content full screen, which is the normal default operation. Applies when viewing the Speaker video layout, which shows a large video that takes the entire screen, plus one thumbnail showing other content.

zConfiguration Call Layout Style - In-Meeting

Configure the layout options. Corresponds to the Change view button on the ZRC. Layout options include: Gallery, Speaker, Strip, or ShareAll to show sharing on all screens. First invoke zStatus Call Layout to determine which layouts are possible.

Schema:

zConfiguration Call Layout Style: <Gallery, Speaker, Strip, ShareAll>

Example:

zConfiguration Call Layout Style
*c zConfiguration Call Layout Style: Speaker
** end
OK

Style — The style of video layout to show.

zConfiguration Call Layout Size - In-Meeting

Set size of the thumbnails: In Speaker mode only, change the size of the thumbnail video, which can either be a self-view video, or a remote view, or a sharing video.

Schema:

zConfiguration Call Layout Size: <Off | Size1 | Size2 | Size3 | Strip>

Example:

zConfiguration Call Layout Size
*c zConfiguration Call Layout Size: Size1
** end
OK

Size — For the Speaker view mode, allowed values are Off, Size1, Size2, Size3. Strip is ignored. For filmstrip mode view, only the Strip value is allowed.

zConfiguration Call Layout Position - In-Meeting

Set the position of the thumbnails. In Speaker mode only, change the position of the thumbnail video, which can either be a self-view video, a remote view, or a sharing view.

Schema:

zConfiguration Call Layout Position: <Center | Up | Right | UpRight | Down | DownRight | Left | UpLeft | DownLeft>

Example:

zConfiguration Call Layout Position
*c zConfiguration Call Layout Position: UpRight
** end
OK

Position — For Speaker view, currently supported values include UpRight, DownRight, UpLeft, DownLeft. Other values are reserved for future use.

zConfiguration Call Lock Enable - In-Meeting

Corresponds to Lock Meeting button in the user management dialog of the iPad ZRC. After a meeting is locked, no new participants are allowed to join.

Schema:

zConfiguration Call Lock Enable: <on/off>

Example:

zConfiguration Call Lock Enable
*c zConfiguration Call Lock Enable: off
** end
OK

Enable — Set to On to prevent other participants from joining the meeting.

zConfiguration Call MuteUserOnEntry Enable - In-Meeting

Turn on/off Mute on Entry. Corresponds to the Mute Participants on Entry button in the ZRC user management dialog. When enabled, the audio of participants who join the meeting will be automatically muted upon joining.

Schema:

zConfiguration Call MuteUSerOnEntry Enable: <on/off>

Example:

zConfiguration Call MuteUSerOnEntry Enable
*c zConfiguration Call MuteUserOnEntry Enable: off
** end
OK

Enable — Set to On to mute all new users on entry.

zConfiguration Call ClosedCaption Visible - In-Meeting

Turn on/off closed captioning. Turning this on will display closed captioning if it is available. To see if closed captioning is available, refer to zStatus Call ClosedCaption Available

Schema:

zConfiguration Call ClosedCaption Visible: <on/off>

Example:

zConfiguration Call ClosedCaption Visible
*c zConfiguration Call ClosedCaption Visible: off
** end
OK

Enable — Set to On to see available closed captions. Resets after every meeting. Default is off at the beginning of a meeting.

zConfiguration Call ClosedCaption FontSize - In-Meeting

Sets closed captioning size. To see if closed captioning is available, refer to zStatus Call ClosedCaption Available.

Schema:

zConfiguration Call ClosedCaption FontSize: <0-2>

Example:

zConfiguration Call ClosedCaption FontSize
*c zConfiguration Call ClosedCaption FontSize: 1
** end
OK

FontSize — Resets after every meeting. Default is 1 at the beginning of a meeting.

zConfiguration SIPCall Microphone Mute

Mute or unmute the microphone in a SIP call.

Syntax:

zConfiguration SIPCall Microphone Mute: <on/off>

Example:

zconfiguration sipcall microphone mute: on
** end
OK
*c zConfiguration SIPCall Microphone Mute: on
** end

zConfiguration Call Share Setting

Enables or disables participant sharing.

Schema:

zConfiguration Call Share Setting: [HOST_GRAB, LOCK_SHARE, ANYONE_GRAB, MULTI_SHARE]

Example:

zConfiguration Call Share Setting: host_grab
*c CallShareSettingResult (status=OK):
** end
OK
*c zConfiguration Call Share Setting: HOST_GRAB
** end
*s Video Optimizable: on
** end
zConfiguration Call Share Setting
*c zConfiguration Call Share Setting: HOST_GRAB
** end
OK

zConfiguration

zConfiguration Call ClosedCaption Visible: <on/off>

zConfiguration Call ClosedCaption FontSize: <0/1/2>

zConfiguration Call ClosedCaption Disable: <on/off>

zConfiguration Call Sharing optimize_video_sharing - In-Meeting

zConfiguration Call Microphone Mute - In-Meeting

zConfiguration Call Camera Mute - In-Meeting

zConfiguration Audio Input selectedId

zConfiguration Audio Input is_sap_disabled

zConfiguration Audio Input reduce_reverb

zConfiguration Audio Input volume

zConfiguration Audio Output selectedId

zConfiguration Audio Output volume

zConfiguration Video hide_conf_self_video

zConfiguration Video Camera selectedId

zConfiguration Video Camera Mirror

zConfiguration Client appVersion

zConfiguration Client deviceSystem

zConfiguration Call Layout ShareThumb - In-Meeting

zConfiguration Call Layout Style - In-Meeting

zConfiguration Call Layout Size - In-Meeting

zConfiguration Call Layout Position - In-Meeting

zConfiguration Call Lock Enable - In-Meeting

zConfiguration Call MuteUserOnEntry Enable - In-Meeting

zConfiguration Call ClosedCaption Visible - In-Meeting

zConfiguration Call ClosedCaption FontSize - In-Meeting

zConfiguration SIPCall Microphone Mute

zConfiguration Call Share Setting

zConfiguration Call ClosedCaption Visible: `<on/off>`

zConfiguration Call ClosedCaption FontSize: `<0/1/2>`

zConfiguration Call ClosedCaption Disable: `<on/off>`

zConfiguration Call Sharing `optimize_video_sharing` - In-Meeting

zConfiguration Audio Input `selectedId`

zConfiguration Audio Input `reduce_reverb`

zConfiguration Audio Input `volume`

zConfiguration Audio Output `selectedId`

zConfiguration Audio Output `volume`

zConfiguration Video `hide_conf_self_video`

zConfiguration Video Camera `selectedId`