NICE DCV Web UI SDK - NICE DCV
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

NICE DCV Web UI SDK

A JavaScript React component library, currently exporting a single React component called DCVViewer which connects to the NICE DCV Server and renders the toolbar to interact with the remote stream.

Exposes

Components

DCVViewer

The React component rendering the toolbar with all of its functionalities useful to interact with the remote stream.

Properties:

dcv
Name Type Required Description
dcv Object Yes The object defining the properties necessary to establish the connection to the NICE DCV Server, setting the log level and the URL from where to load the NICE DCV Web Client SDK assets and access the DCV resources.
Name Type Required Description
sessionId String Yes The NICE DCV session ID.
authToken String Yes The authentication token to use when connecting to the server.
serverUrl String Yes The host name and port of the running NICE DCV server in the following format: https://dcv_host_address:port. For example: https://my-dcv-server:8443.
baseUrl String Yes The absolute or relative URL from which to load SDK files.
resourceBaseUrl String No (default: "") The absolute or relative URL from which to access DCV resources.
onDisconnect function No (default: () => {}) The callback function invoked when disconnecting from the NICE DCV server, and the connection is closed.
logLevel LogLevel No (default: LogLevel.INFO) The log level to use in the viewer.
uiConfig
Name Type Required Description
uiConfig Object No (default: {}) The object defining the properties to configure whether the toolbar is visible and whether to display the fullscreen and multimonitor buttons on it.
Name Type Required Description
toolbar Object No (default: {}) The Object defining the configuration options for the toolbar.
Name Type Required Description
visible Boolean No (default: true) The option to define whether to show or hide the toolbar.
fullscreenButton Boolean No (default: true) The option to define whether to show or hide the fullscreen button on the toolbar.
multimonitorButton Boolean No (default: true) The option to define whether to show or hide the multimonitor button on the toolbar.