NICE DCV

(1)

NICE DCV

Web Client SDK Developer Guide

(2)

NICE DCV: Web Client SDK Developer Guide

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

What is the NICE DCV Web Client SDK?

NICE DCV is a high-performance remote display protocol. It lets you securely deliver remote desktops and application streaming from any cloud or data center to any device, over varying network conditions.

By using NICE DCV with Amazon EC2, you can run graphics-intensive applications remotely on Amazon EC2 instances. You can then stream the results to more modest client machines, which eliminates the need for expensive dedicated workstations.

The NICE DCV Web Client SDK is a JavaScript library that you can use to develop your own NICE DCV web browser client applications. Your end users can use these applications to connect to and interact with a running NICE DCV session.

Using the NICE DCV Web Client SDK as a building block, you can build customized web applications that provide users with instant access to their desktop or applications from anywhere, with a responsive and ﬂuid performance that is almost indistinguishable from a natively installed application.

This guide explains how to use the NICE DCV Web Client SDK to build your custom web browser client applications to interact with NICE DCV sessions within your workﬂows.

Topics

• Prerequisites (p. 1)

• Supported features (p. 1)

• Browser support (p. 2)

• Versioning convention (p. 2)

Prerequisites

Before you start working with the NICE DCV Web Client SDK, ensure that you're familiar with NICE DCV and NICE DCV sessions. For more information, see the NICE DCV Administrator Guide.

The NICE DCV Web Client SDK supports NICE DCV server version 2020 and later.

Supported features

You can build custom web browser client applications that support the following NICE DCV features:

• Connect to Windows NICE DCV servers

• Connect to Linux NICE DCV servers

• Manage streaming modes

• Transfer ﬁles

• Print from sessions

• Copy and paste

• Stereo 2.0 audio playback

• Stereo 2.0 audio recording (on Windows servers)

(5)

Browser support

• Touchscreen

• Stylus (on Linux, Windows 10, and Windows Server 2019 servers)

• Multiple monitor support

For more information about these features, see Supported features in the NICE DCV User Guide.

Browser support

The NICE DCV Web Client SDK supports JavaScript (ES6) and it can be used from JavaScript or TypeScript applications.

The NICE DCV Web Client SDK supports the following web browsers:

Browser Version

Google Chrome Latest three major versions Mozilla Firefox Latest three major versions Microsoft Edge Latest three major versions Apple Safari for macOS Latest three major versions

Versioning convention

The NICE DCV Web Client SDK version is deﬁned in the following format: major.minor.patch. The versioning convention generally adheres to the semantic versioning model. A change in the major version, such as from 1.x.x to 2.x.x, indicates that breaking changes that might require code changes and a planned deployment have been introduced. A change in the minor version, such as from 1.1.x to 1.2.x, is backwards compatible, but might include deprecated elements.

(6)

Getting started with the NICE DCV Web Client SDK

The NICE DCV Web Client SDK comprises of a main dcv.js ﬁle and some auxiliary components. All the ﬁles are distributed inside a compressed archive that can be downloaded from the NICE website . To get started with the NICE DCV Web Client SDK

1. The NICE DCV Web Client SDK archive is digitally signed with a secure GPG signature. To verify the archive's signature, you must import the NICE GPG key. To do so, open a terminal window and import the NICE GPG key.

$ wget https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY

$ gpg --import NICE-GPG-KEY

2. Download the NICE DCV Web Client SDK archive and the NICE DCV Web Client SDK archive signature from the NICE website .

3. Verify the signature of the NICE DCV Web Client SDK archive using the signature.

$ gpg --verify

signature_filename.zip.sign archive_filename.zip

For example:

$ gpg --verify nice-dcv-web-client-sdk-1.1.0-295.zip.sign nice-dcv-web-client- sdk-1.1.0-295.zip

4. If the signature veriﬁes successfully, extract the contents of the NICE DCV Web Client SDK archive and place the extracted directory on your web server. For example:

$ unzip

archive_filename.zip -d /

path_to /

server_directory /

Important

• You must retain the folder structure when deploying the NICE DCV Web Client SDK on your web server.

• When using NICE DCV Web UI SDK, please beware that the DCVViewer React component expects the EULA.txt and third-party-licenses.txt ﬁles from this package to be present in the URL path for the embedded web server. The third-party-licenses.txt ﬁle should be

(7)

Connect to a NICE DCV server and get the ﬁrst frame

modiﬁed to also include the content of the corresponding ﬁle from NICE DCV Web Client SDK package and possibly any other license information from the libraries used by the consuming user application.

Connect to a NICE DCV server and get the ﬁrst frame

The following tutorial shows you how to prepare your HTML page for your custom web client, how to authenticate and connect to a NICE DCV server, and how to receive the ﬁrst frame of streamed content from the NICE DCV session.

Topics

• Step 1: Prepare your HTML page (p. 4)

• Step 2: Authenticate, connect, and get the ﬁrst frame (p. 4)

• Bonus: Automatically create an HTML login form (p. 6)

Step 1: Prepare your HTML page

In your web page, you must load the needed JavaScript modules and you must add a <div> HTML element with a valid id where you want the NICE DCV Web Client SDK to draw the content stream from the remote NICE DCV server.

For example:

<!DOCTYPE html>

<head>

<title>DCV first connection</title>

</head>

</body>

</html>

Step 2: Authenticate, connect, and get the ﬁrst frame

This section shows how to complete the user authentication process, how to connect the NICE DCV server, and how to receive the ﬁrst frame of content from the NICE DCV server.

First, from the index.js ﬁle import the NICE DCV Web Client SDK. It can be imported either as a Universal Module Deﬁnition (UMD) module, like so:

import "./dcvjs/dcv.js"

Otherwise, starting from version 1.1.0, it can also be imported as a ECMAScript Module (ESM) from the corresponding package, like so:

import dcv from "./dcvjs/dcv.js"

(8)

Step 2: Authenticate, connect, and get the ﬁrst frame

Deﬁne the variables to use to store the Authentication object, Connection object, and the NICE DCV server URL.

let auth, connection, serverUrl;

On script load, log the NICE DCV Web Client SDK version, and on page load, call the main function.

console.log("Using NICE DCV Web Client SDK version " + dcv.version.versionStr);

document.addEventListener('DOMContentLoaded', main);

The main function sets the log level and starts the authentication process.

function main () {

console.log("Setting log level to INFO");

dcv.setLogLevel(dcv.LogLevel.INFO);

serverUrl = "https://your-dcv-server-url:port/";

console.log("Starting authentication with", serverUrl);

auth = dcv.authenticate(

serverUrl, {

promptCredentials: onPromptCredentials, error: onError,

success: onSuccess }

);

}

The promptCredentials , error , and success functions are mandatory callback functions that must be deﬁned in the authentication process.

If the NICE DCV server prompts for credentials, the promptCredentials callback function receives the requested credential challenge from the NICE DCV server. If the NICE DCV server is conﬁgured to use system authentication, then the credentials must be provided in the form of a user name and a password. The following code samples assume that the user name is my_dcv_user and that the password is my_password .

If authentication fails, the error callback function receives an error object from the NICE DCV server.

If the authentication succeeds, the success callback function receives an array of couples that

includes the session id ( sessionId ) and authorization tokens ( authToken ) for each session that the my_dcv_user user is allowed to connect to on the NICE DCV server. The following code sample calls the connect function and connects to the ﬁrst session returned in the array.

function onPromptCredentials(auth, challenge) {

// Let's check if in challege we have a username and password request

if (challengeHasField(challenge, "username") && challengeHasField(challenge, "password")) { auth.sendCredentials({username: "my_dcv_user", password: "my_password"})

} else {

// Challenge is requesting something else...

}}

function challengeHasField(challenge, field) {

return challenge.requiredCredentials.some(credential => credential.name === field);

(9)

Bonus: Automatically create an HTML login form

}

function onError(auth, error) {

console.log("Error during the authentication: " + error.message);

}

// We connect to the first session returned function onSuccess(auth, result) {

let {sessionId, authToken} = {...result[0]};

connect(sessionId, authToken);

}

Connect to the NICE DCV server. The firstFrame callback method is called when the ﬁrst frame is received from the NICE DCV server.

function connect (sessionId, authToken) { console.log(sessionId, authToken);

dcv.connect({

url: serverUrl, sessionId: sessionId, authToken: authToken, divId: "dcv-display", callbacks: {

firstFrame: () => console.log("First frame received") }

}).then(function (conn) {

console.log("Connection established!");

connection= conn;

}).catch(function (error) {

console.log("Connection failed with error " + error.message);

});

}

Bonus: Automatically create an HTML login form

The challenge object is returned when the promptCredentials callback function is called. It includes a property named requiredCredentials that is an array of objects - one object per credential that is requested by the NICE DCV server. Each object includes the name and the type of the requested credential. You can use the challenge and requiredCredentials objects to automatically create an HTML login form.

The following code sample shows you how to do this.

let form, fieldSet;

function submitCredentials (e) { var credentials = {};

fieldSet.childNodes.forEach(input => credentials[input.id] = input.value);

auth.sendCredentials(credentials);

e.preventDefault();

}

function createLoginForm () {

var submitButton = document.createElement("button");

submitButton.type = "submit";

submitButton.textContent = "Login";

(10)

Work with NICE DCV features

form = document.createElement("form");

fieldSet = document.createElement("fieldset");

form.onsubmit = submitCredentials;

form.appendChild(fieldSet);

form.appendChild(submitButton);

document.body.appendChild(form);

}

function addInput (name) {

var type = name === "password" ? "password" : "text";

var inputField = document.createElement("input");

inputField.name = name;

inputField.id = name;

inputField.placeholder = name;

inputField.type = type;

fieldSet.appendChild(inputField);

}

function onPromptCredentials (_, credentialsChallenge) { createLoginForm();

credentialsChallenge.requiredCredentials.forEach(challenge => addInput(challenge.name));

}

Work with NICE DCV features

The availability of NICE DCV features depends on the permissions conﬁgured for the NICE DCV session and the capabilities of the client's web browser.

The features that are available in a NICE DCV session are managed by the permissions that have been specified for the session. This means that even if a feature is supported by the NICE DCV Web Client SDK, access to that feature might be prevented based on the permissions defined by the session administrator. For more information, see Configuring NICE DCV Authorization in the NICE DCV Administrator Guide .

Understanding the featuresUpdate callback function

When the availability of a feature in a NICE DCV session changes, the NICE DCV Web Client SDK notiﬁes you using the featuresUpdate callback function that you specify at the time of establishing the connection. For example:

featuresUpdate: function (connection, list) { ...

},

The callback function notiﬁes you only of the features for which the availability has changed. The list parameter is an array of strings, and it includes only the names of the updated features. For example, if the availability of the audio input feature changes for the session, the parameter includes only ["audio-in"] . If at a later point, the availability of the clipboard copy and paste features change for the session, the parameter includes only ["clipboard-copy", "clipboard-paste"] .

Handling feature updates

The featuresUpdate callback function only notiﬁes you that the availability of one or more features has changed. To know which features were updated, you must query the feature using the

(11)

Use NICE DCV Web UI SDK

connection.queryFeature method. This can be done at any time after the notiﬁcation of change has been received. This method returns a Promise that resolves to the requested feature's updated status.

The status value is always associated and it has a Boolean ( true | false ) property called enabled . Some features might have additional properties in the status value. If the feature's availability has not been updated, it's rejected.

The following example code shows how to do this.

// Connection callback called function featuresUpdate (_, list) { if (list.length > 0) {

list.forEach((feat) => {

connection.queryFeature(feat).then(status => console.log(feat, "is", status.enabled)));

});

}}

Use NICE DCV Web UI SDK

The following tutorial shows you how to authenticate against the NICE DCV server, connect to it and render the DCVViewer React component from the NICE DCV Web UI SDK.

Topics

• Prerequisites (p. 8)

• Step 1: Prepare your HTML page (p. 9)

• Step 2: Authenticate, connect and render the DCVViewer React component. (p. 9)

Prerequisites

You need to install React , ReactDOM , AWS UI Components React , AWS UI Global Styles and AWS UI Design Tokens .

$ npm i react react-dom @awsui/components-react @awsui/global-styles @awsui/design-tokens

You would also need to download NICE DCV Web Client SDK . See Getting started with the NICE DCV Web Client SDK (p. 3) to read the step-by-step guide on how to do that.

You must create an alias for importing the dcv module, since it is an external dependency for NICE DCV Web UI SDK. For instance, if you are using webpack to bundle your web app, you can use the resolve.alias option like so:

const path = require('path');

module.exports = { //...

resolve: { alias: {

dcv: path.resolve('path', 'to', 'dcv.js'), },

},};

(12)

Step 1: Prepare your HTML page

If you are using rollup for bundling, you can install @rollup/plugin-alias, and use it like so:

import alias from '@rollup/plugin-alias';

const path = require('path');

module.exports = { //...

plugins: [ alias({

entries: [

{ find: 'dcv', replacement: path.resolve('path', 'to', 'dcv.js') }, ]

}) ] };

Step 1: Prepare your HTML page

In your web page, you must load the required JavaScript modules and you should have a <div> HTML element with a valid id where the entry component of your app will be rendered.

For example:

<!DOCTYPE html>

<head>

<title>DCV first connection</title>

</head>

</body>

</html>

Step 2: Authenticate, connect and render the DCVViewer React component.

This section shows how to complete the user authentication process, how to connect the NICE DCV server, and how to render the DCVViewer React component.

First, from the index.js ﬁle, import React , ReactDOM and your top level App component.

import React from "react";

import ReactDOM from 'react-dom';

import App from './App';

Render the top level container node of your app.

ReactDOM.render(

<React.StrictMode>

<App />

</React.StrictMode>,

document.getElementById("root") );

In the App.js ﬁle, import the NICE DCV Web Client SDK as a ESM module, the DCVViewer React component from the NICE DCV Web UI SDK, React and the AWS UI Global Styles package.

(13)

Step 2: Authenticate, connect and render the DCVViewer React component.

import React from "react";

import dcv from "dcv";

import "@awsui/global-styles/index.css";

import {DCVViewer} from "./dcv-ui/dcv-ui.js";

Following is an example showing how to authenticate against the NICE DCV Server and render the DCVViewer React component from NICE DCV Web UI SDK, provided the authentication was successful.

const LOG_LEVEL = dcv.LogLevel.INFO;

const SERVER_URL = "https://your-dcv-server-url:port/";

const BASE_URL = "/static/js/dcvjs";

let auth;

function App() {

const [authenticated, setAuthenticated] = React.useState(false);

const [sessionId, setSessionId] = React.useState('');

const [authToken, setAuthToken] = React.useState('');

const [credentials, setCredentials] = React.useState({});

const onSuccess = (_, result) => {

var { sessionId, authToken } = { ...result[0] };

console.log("Authentication successful.");

setSessionId(sessionId);

setAuthToken(authToken);

setAuthenticated(true);

setCredentials({});

}

const onPromptCredentials = (_, credentialsChallenge) => { let requestedCredentials = {};

credentialsChallenge.requiredCredentials.forEach(challenge =>

requestedCredentials[challenge.name] = "");

setCredentials(requestedCredentials);

}

const authenticate = () => { dcv.setLogLevel(LOG_LEVEL);

auth = dcv.authenticate(

SERVER_URL, {

promptCredentials: onPromptCredentials, error: onError,

success: onSuccess }

);

}

const updateCredentials = (e) => { const { name, value } = e.target;

setCredentials({

...credentials, [name]: value });

}

const submitCredentials = (e) => { auth.sendCredentials(credentials);

e.preventDefault();

}

(14)

React.useEffect(() => { if (!authenticated) { authenticate();

}

}, [authenticated]);

const handleDisconnect = (reason) => {

console.log("Disconnected: " + reason.message + " (code: " + reason.code + ")");

auth.retry();

setAuthenticated(false);

} return (

authenticated ? <DCVViewer dcv={{

sessionId: sessionId, authToken: authToken, serverUrl: SERVER_URL, baseUrl: BASE_URL,

onDisconnect: handleDisconnect, logLevel: LOG_LEVEL

}}

uiConfig={{

toolbar: { visible: true,

fullscreenButton: true, multimonitorButton: true, },

}}

/>

: <div style={{

height: window.innerHeight, backgroundColor: "#373737", display: 'flex',

alignItems: 'center', justifyContent: 'center', }}

>

<form>

{Object.keys(credentials).map((cred) => ( <input

key={cred}

name={cred}

placeholder={cred}

type={cred === "password" ? "password" : "text"}

onChange={updateCredentials}

value={credentials[cred]}

/>

))}

</fieldset>

<button

type="submit"

onClick={submitCredentials}

>

Login </button>

</form>

</div>

);

}

(15)

const onError = (_, error) => {

console.log("Error during the authentication: " + error.message);

}

export default App;

The promptCredentials , error , and success functions are mandatory callback functions that must be deﬁned in the authentication process.

If the NICE DCV server prompts for credentials, the promptCredentials callback function receives the requested credential challenge from the NICE DCV server. If the NICE DCV server is conﬁgured to use system authentication, then the credentials must be provided in the form of a user name and a password.

If authentication fails, the error callback function receives an error object from the NICE DCV server.

If the authentication succeeds, the success callback function receives an array of couples that includes the session id ( sessionId ) and authorization tokens ( authToken ) for each session that the user is allowed to connect to on the NICE DCV server. The code sample above updates the React state to render the DCVViewer component on successful authentication.

To know more about the properties accepted by this component, see the NICE DCV Web UI SDK reference.

(16)

DCV module

SDK reference

This section provides descriptions, syntax, and usage examples for the NICE DCV Web Client SDK.

Topics

• DCV module (p. 13)

• Connection Class (p. 41)

• Authentication Class (p. 58)

• NICE DCV Web UI SDK (p. 59)

DCV module

A module that implements the client side of the DCV protocol.

Exposes

• Methods (p. 13)

• Members (p. 15)

• Type and callback deﬁnitions (p. 17)

Methods

List

• authenticate(url, callbacks) → {Authentication} (p. 13)

• connect(conﬁg) → {Promise.<Connection>|Promise.<{code: ConnectionErrorCode, message:

string}>} (p. 14)

• setLogHandler(handler) → {void} (p. 14)

• setLogLevel(level) → {void} (p. 15)

authenticate(url, callbacks) → {Authentication (p. 58)}

Starts the authentication process for the speciﬁed NICE DCV server endpoint.

Parameters:

Name Type Description

url string 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.

callbacks authenticationCallbacks (p. 19) The callbacks that are available to be called during the

authentication process.

(17)

Methods

Returns:

- The Authentication object.

Type

Authentication (p. 58)

connect(conﬁg) → {Promise.< Connection (p. 41)>|

Promise.<{code: ConnectionErrorCode (p. 26), message:

string}>}

Connects to the speciﬁed NICE DCV server endpoint. If connection succeeds, it returns a Connection object. If connection fails, it returns an error object.

Parameters:

config ConnectionConﬁg (p. 25) The ConnectionConﬁg object.

Returns:

- A Connection object, or an error object.

Type

Promise.<Connection (p. 41)> | Promise.<{code: ConnectionErrorCode (p. 26), message:

string}>

setLogHandler(handler) → {void}

Sets a custom log handler function. When overriding the default log handler, the original log entry position will be lost when debugging with the browser console.

Parameters:

handler function The custom log handler

function. The handler function contains level (number), levelName (string), domain (string), and message (string).

Returns:

Type void

(18)

Members

setLogLevel(level) → {void}

Sets the log level. This is required only if the default log handler is used.

Parameters:

level LogLevel (p. 36) The log level to use.

Returns:

Type void

Members

List

• (constant) AudioError :AudioErrorCode (p. 15)

• (constant) AuthenticationError :AuthenticationErrorCode (p. 15)

• (constant) ChannelError :ChannelErrorCode (p. 16)

• (constant) ClosingReasonError :ClosingReasonErrorCode (p. 16)

• (constant) ConnectionError :ConnectionErrorCode (p. 16)

• (constant) CustomChannelError :CustomChannelErrorCode (p. 16)

• (constant) DisplayConﬁgError :DisplayConﬁgErrorCode (p. 16)

• (constant) FileStorageError :FileStorageErrorCode (p. 16)

• (constant) MultiMonitorError :MultiMonitorErrorCode (p. 17)

• (constant) ResolutionError :ResolutionErrorCode (p. 17)

• (constant) version (p. 17)

• (constant) WebcamError :WebcamErrorCode (p. 17)

(constant) AudioError :AudioErrorCode (p. 19)

The AudioError codes enum.

Type:

• AudioErrorCode (p. 19)

(constant)

AuthenticationError :AuthenticationErrorCode (p. 19)

The AuthenticationError codes enum.

Type:

• AuthenticationErrorCode (p. 19)

(19)

Members

(constant) ChannelError :ChannelErrorCode (p. 22)

The ChannelError codes enum.

Type:

• ChannelErrorCode (p. 22)

(constant)

ClosingReasonError :ClosingReasonErrorCode (p. 23)

The ClosingReasonError codes enum.

Type:

• ClosingReasonErrorCode (p. 23)

(constant) ConnectionError :ConnectionErrorCode (p. 26)

The ConnectionError codes enum.

Type:

• ConnectionErrorCode (p. 26)

(constant)

CustomChannelError :CustomChannelErrorCode (p. 27)

The CustomChannelError codes enum.

Type:

• CustomChannelErrorCode (p. 27)

(constant) DisplayConﬁgError :DisplayConﬁgErrorCode (p. 29)

The DisplayConﬁgError codes enum.

Type:

• DisplayConﬁgErrorCode (p. 29)

(constant) FileStorageError :FileStorageErrorCode (p. 33)

The FileStorageError codes enum.

Type:

• FileStorageErrorCode (p. 33)

(20)

Type and callback deﬁnitions

(constant) MultiMonitorError :MultiMonitorErrorCode (p. 37)

The MultiMonitorError codes enum.

Type:

• MultiMonitorErrorCode (p. 37)

(constant) ResolutionError :ResolutionErrorCode (p. 39)

The ResolutionError codes enum.

Type:

• ResolutionErrorCode (p. 39)

(constant) version

The NICE DCV version with major, minor, patch, revision, extended, and versionStr.

Properties:

major integer The major version number.

minor integer The minor version number.

patch integer The patch version number.

revision integer The revision number.

extended string The extended string.

versionStr string A concatenation of the

major, minor, patch, and revision numbers in the form major.minor.patch +build.revision.

(constant) WebcamError :WebcamErrorCode (p. 41)

The WebcamError codes enum.

Type:

• WebcamErrorCode (p. 41)

Type and callback deﬁnitions

List

• AudioErrorCode (p. 19)

• authenticationCallbacks (p. 19)

(21)

• AuthenticationErrorCode (p. 19)

• authErrorCallback(authentication, error) (p. 20)

• authPromptCredentialsCallback(authentication, challenge) (p. 20)

• authSuccessCallback(authentication, authenticationData) (p. 21)

• Channel (p. 21)

• ChannelErrorCode (p. 22)

• clipboardEventCallback(event) (p. 22)

• ClosingReasonErrorCode (p. 23)

• Colorspace (p. 23)

• connectionCallbacks (p. 24)

• ConnectionConﬁg (p. 25)

• ConnectionErrorCode (p. 26)

• createDirectory(path) (p. 27)

• CustomChannelErrorCode (p. 27)

• dataChannelCallback(info) (p. 27)

• deleteFile(path) (p. 28)

• deviceChangeEventCallback() (p. 28)

• disconnectCallback(reason) (p. 28)

• displayAvailabilityCallback(status, displayId) (p. 29)

• DisplayConﬁgErrorCode (p. 29)

• displayLayoutCallback(serverWidth, serverHeight, heads) (p. 29)

• feature (p. 30)

• featuresUpdateCallback(featuresList) (p. 30)

• ﬁleDownloadCallback(ﬁleResource) (p. 30)

• ﬁlePrintedCallback(printResource) (p. 31)

• ﬁlestorage (p. 32)

• ﬁlestorageEnabledCallback(enabled) (p. 33)

• FileStorageErrorCode (p. 33)

• ﬁrstFrameCallback(resizeEnabled, relativeMouseModeEnabled, displayId) (p. 34)

• idleWarningNotiﬁcationCallback(disconnectionDateTime) (p. 34)

• collaboratorListCallback(collaborators) (p. 34)

• licenseNotiﬁcationCallback(notiﬁcation) (p. 35)

• list(path) (p. 36)

• LogLevel (p. 36)

• Monitor (p. 36)

• MultiMonitorErrorCode (p. 37)

• qualityIndicatorStateCallback(state) (p. 38)

• renameDirectory(src, dest) (p. 38)

• renameFile(src, dest) (p. 39)

• ResolutionErrorCode (p. 39)

• retrieveFile(path) (p. 39)

• screenshotCallback(screenshot) (p. 39)

• serverInfo (p. 40)

• stats (p. 40)

• storeFile(ﬁle, dir) (p. 41)

• WebcamErrorCode (p. 41)

(22)

AudioErrorCode

The AudioError code enums available in the DCV module

• SETTING_AUDIO_FAILED

• CHANNEL_NOT_AVAILABLE

Type:

• number

authenticationCallbacks

Authentication callbacks

Type:

• Object

Properties:

promptCredentials authPromptCredentialsCallback (p. 20)The callback function to be called when the user is challenged for credentials.

error authErrorCallback (p. 20) The callback function to be

called when authentication fails.

success authSuccessCallback (p. 21) The callback function to be called when authentication succeeds.

AuthenticationErrorCode

The AuthenticationError code enums available in the DCV module

• INVALID_MESSAGE

• UNKNOWN_AUTH_MODE

• SESSION_NOT_AVAILABLE

• NO_SESSIONS

• WRONG_CREDENTIALS

• SASL_CHALLENGE

• SASL_AUTH_MECHANISM

• FAILED_COMMUNICATION

• AUTHENTICATION_REJECTED

• GENERIC_ERROR

• WRONG_CREDENTIALS_FORMAT

• WRONG_CREDENTIALS_TYPE

• UNREQUESTED_CREDENTIALS

• MISSING_CREDENTIAL

(23)

Type:

• number

authErrorCallback(authentication, error)

The callback function to be called when authentication fails.

Parameters:

authentication Authentication (p. 58) The Authentication object.

error Object The error object raised by the

authentication process.

code AuthenticationErrorCode (p. 19)The error

code.

message string The error message.

authPromptCredentialsCallback(authentication, challenge)

The callback function to be called when the user is challenged for credentials. The user must answer the challenge by providing the requested credentials.

Parameters:

challenge Object The challenge.

Name Type Description requiredCredentialsArray.<Object>An

array of requested credential objects.

NameTypeDescription namestringThe

name of

(24)

Name Type Description NameTypeDescription

the requested credential.

typestringThe type ofthe requested credential.

authSuccessCallback(authentication, authenticationData)

The callback function to be called when authentication succeeds.

Parameters:

authenticationData Array.<Object> An array of objects that include NICE DCV session IDs and authentication tokens.

Name Type Description sessionIdstring The

NICE DCV session ID.

authTokenstring The

authentication token

for the NICEDCV session.

Channel

The available channels that can be speciﬁed.

Type:

• "clipboard" | "display" | "input" | "audio" | "ﬁlestorage"

(25)

ChannelErrorCode

The ChannelError code enums available in the DCV module

• ALREADY_OPEN

• INITIALIZATION_FAILED

• REJECTED

Type:

• number

clipboardEventCallback(event)

The callback function to be called when a clipboardEvent is generated.

Parameters:

event Object Information about the clipboard

event.

Name Type AttributesDescription name established

|copy | paste

|

dataSizeAlert

|

autoCopyDone

|

newDataAvailable

|autoPasteDone

|remoteError

|pasteAvailableData Always present.

The nameof the event.

clipboardDataObject

| string

Thedata in the clipboard.

autoCopyboolean<optional>Indicates whether automatic copying fromthe session

(26)

Name Type AttributesDescription clipboard to the local client clipboard is enabled.

maxDataSizenumber <optional>The maximum amount ofdata that canbe placed in the clipboard.

error string <optional>Error information if

applicable.

ClosingReasonErrorCode

The ClosingReasonError code enums available in the DCV module

• TRANSPORT_ERROR

• NO_ERROR

• GENERIC_ERROR

• INTERNAL_SERVER_ERROR

• PROTOCOL_ERROR

• AUTHORIZATION_DENIED

• AUTHORIZATION_REVOKED

• ACCESS_REJECTED

• IDLE_TIMEOUT_EXPIRED

Type:

• number

Colorspace

The available colorspaces that can be speciﬁed.

Type:

• "RGB" | "YUV_REC601" | "YUV_REC709"

(27)

connectionCallbacks

The callbacks that are available to be called in the event of a connection error.

Type:

• Object

Properties:

disconnect disconnectCallback (p. 28) The callback function to be called when the connection ends.

displayLayout displayLayoutCallback (p. 29) The callback function to be called when the display layout or resolution is changed.

displayAvailability displayAvailabilityCallback (p. 29) The callback function to be called when a display's availability changes.

firstFrame ﬁrstFrameCallback (p. 34) The callback function to be called when the ﬁrst frame is received from the NICE DCV server.

filePrinted ﬁlePrintedCallback (p. 31) The callback function to be called when a ﬁle is printed on the NICE DCV server.

fileDownload ﬁleDownloadCallback (p. 30) The callback function to be called when a ﬁle is ready to be downloaded from the NICE DCV server.

dataChannel dataChannelCallback (p. 27) The callback function to be called when the NICE DCV server sends a notiﬁcation about the availability of a data channel.

licenseNotification licenseNotiﬁcationCallback (p. 35) The callback function to be called when the NICE DCV server sends a notiﬁcation about the license state.

idleWarningNotification idleWarningNotiﬁcationCallback (p. 34)The callback function to be called when the NICE DCV server sends an idle timeout warning.

collaboratorList collaboratorListCallback (p. 34) The callback function to be called when the NICE DCV server sends the list of collaborators (since NICE DCV Web Client SDK version 1.1.0).

(28)

qualityIndicatorState qualityIndicatorStateCallback (p. 38)The callback function to be called when the connection quality indicator changes state.

filestorageEnabled ﬁlestorageEnabledCallback (p. 33)The callback function to be called when ﬁle storage is enabled or disabled.

featuresUpdate featuresUpdateCallback (p. 30) The callback function to be called when a feature's status changes.

clipboardEvent clipboardEventCallback (p. 22) The callback function to be called when a clipboardEvent is generated.

deviceChangeEvent deviceChangeEventCallback (p. 28)The callback function to be called when an deviceChange event is triggered.

screenshot screenshotCallback (p. 39) The callback function to be called when a screenshot is available.

ConnectionConﬁg

The conﬁguration for a NICE DCV connection.

Type:

• Object

Properties:

url string 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.

sessionId string The NICE DCV session ID.

authToken string The authentication token to use

when connecting to the server.

baseUrl string The absolute or relative URL

from which to load SDK ﬁles.

resourceBaseUrl string The absolute or relative URL

from which to access DCV resources.

(29)

enabledChannels Array.<Channel (p. 21)> Indicates the list of channels that can be enabled. If not speciﬁed or an empty array is provided, it defaults to all the available channels.

losslessColorspace Colorspace (p. 23) Indicates the colorspace that will be used. If not speciﬁed, it defaults to "RGB".

divId string The ID of the div object in the

HTML DOM where SDK should create the canvas with the remote stream.

volumeLevel integer The preferred volume level. The

valid range is 0 to 100.

clipboardAutoSync boolean Indicates whether automatic

copying from the NICE DCV session clipboard to the local client clipboard is enabled for compatible web browsers.

dynamicAudioTuning boolean Indicates whether to

dynamically tune the audio based on the NICE DCV server audio settings when a connection is established.

clientHiDpiScaling boolean Indicates whether to scale the

canvas based on the client's DPI.

highColorAccuracy boolean Indicates whether high color

accuracy should be used if available. If not speciﬁed, it defaults to false.

enableWebCodecs Boolean Indicates whether WebCodecs

should be used if available.

Defaults to false if not speciﬁed.

observers connectionCallbacks (p. 24) The callback functions to call for events that are related to the connection.

callbacks connectionCallbacks (p. 24) The same as the observers property, but each

callback includes the Connection (p. 41) object as the ﬁrst parameter.

ConnectionErrorCode

The ConnectionError code enums available in the DCV module

(30)

• ALREADY_OPEN

• INVALID_CONFIG

• INITIALIZATION_FAILED

• REJECTED

• MAIN_CHANNEL_ALREADY_OPEN

• GENERIC_ERROR (since DCV Server 2021.0)

• INTERNAL_SERVER_ERROR (since DCV Server 2021.0)

• AUTHENTICATION_FAILED (since DCV Server 2021.0)

• PROTOCOL_ERROR (since DCV Server 2021.0)

• INVALID_SESSION_ID (since DCV Server 2021.0)

• INVALID_CONNECTION_ID (since DCV Server 2021.0)

• CONNECTION_LIMIT_REACHED (since DCV Server 2021.0)

Type:

• number

createDirectory(path)

Parameters:

path string The absolute path on the server

where we want to create a directory. It should also include the name of the target directory.

CustomChannelErrorCode

The CustomChannelError code enums available in the DCV module

• TRANSPORT_ERROR

Type:

• number

dataChannelCallback(info)

The callback function to be called when the NICE DCV server sends a notiﬁcation about the availability of a data channel.

Parameters:

info Object Information about the data

channel.

(31)

name string The

name of the data channel.

token string The

authentication token

for the datachannel.

deleteFile(path)

Parameters:

identifying the ﬁle we want to delete.

deviceChangeEventCallback()

The callback function to be called when an deviceChange event is triggered.

disconnectCallback(reason)

The callback function to be called when the connection ends.

Parameters:

reason Object The reason for the

disconnection.

code number The

reason code.

message string The reason message.

(32)

displayAvailabilityCallback(status, displayId)

The callback function to be called when a display's availability changes.

Parameters:

status Object The status of the display.

Name Type Description enabled boolean Indicates

if the display is enabled.

closed boolean Indicates if the display is closed.

displayId number The identiﬁer for the display.

DisplayConﬁgErrorCode

The DisplayConﬁgError code enums available in the DCV module

• INVALID_ARGUMENT

• UNSUPPORTED_OPERATION

• NO_CHANNEL

Type:

• number

displayLayoutCallback(serverWidth, serverHeight, heads)

The callback function to be called when the display layout or resolution is changed.

Parameters:

serverWidth number The width (in pixels) of the

primary display.

serverHeight number The height (in pixels) of the

primary display.

(33)

heads Array.<Monitor (p. 36)> The display heads supported by the NICE DCV server.

feature

The feature values.

• display - Indicates the availability of a single-display video stream.

• display-multi - Indicates the availability of a multi-display video stream.

• high-color-accuracy - Indicates the availability of high color accuracy (since NICE DCV Web Client SDK version 1.1.0).

• mouse - Indicates the availability of mouse functionality.

• keyboard - Indicates the availability of keyboard functionality.

• keyboard-sas - Indicates the availability of SAS sequence (Control + Alt + Delete) functionality.

• relative-mouse - Indicates the availability of relative mouse mode.

• clipboard-copy - Indicates the availability of clipboard copy functionality from NICE DCV server to the client.

• clipboard-paste - Indicates the availability of clipboard paste functionality from the client to the NICE DCV server.

• audio-in - Indicates the availability of audio input functionality using the microphone.

• audio-out - Indicates the availability of audio playback functionality.

• webcam - Indicates the availability of webcam streaming functionality.

• file-download - Indicates availability of ﬁle download functionality from the NICE DCV server to the client.

• file-upload - Indicates availability of ﬁle upload functionality from the client to the NICE DCV server.

Type:

• string

featuresUpdateCallback(featuresList)

The callback function to be called when a feature's status changes.

Parameters:

featuresList Array.<feature (p. 30)> An array of features that have changed.

ﬁleDownloadCallback(ﬁleResource)

The callback function to be called when a ﬁle is ready to be downloaded from the NICE DCV server.

(34)

Parameters:

fileResource Object Information about the ﬁle that is

ready for download.

id string The

identiﬁer for the ﬁle.

url string The URL

to use to download the ﬁle.

domain string The resource domain.

token string The

authentication token to use to download the ﬁle.

The token is also included in the URL.

ﬁlePrintedCallback(printResource)

The callback function to be called when a ﬁle is printed on the NICE DCV server.

Parameters:

printResource Object Information about the printed

ﬁle.

id string The

identiﬁer for the

(35)

Name Type Description printed ﬁle.

url string The URL

to use to download the printed ﬁle.

domain string The resource domain.

In this case, printer.

token string The

authentication token to use to download the printed ﬁle. The token is also included in the URL.

ﬁlestorage

Object that allows for exploring and performing actions on the ﬁle system.

Type:

• Object

Properties:

list list (p. 36) Function that allows to list the

items (ﬁles and directories) present at the supplied path on the server.

createDirectory createDirectory (p. 27) Function that allows to create a directory at the speciﬁed path on the server.

(36)

retrieveFile retrieveFile (p. 39) Function that allows to locally download a ﬁle at the speciﬁed path on the server.

deleteFile deleteFile (p. 28) Function that allows to delete a

ﬁle at the speciﬁed path on the server.

renameFile renameFile (p. 39) Function that allows to rename

a file from the specified source path to the specified destination path.

renameDirectory renameDirectory (p. 38) Function that allows to rename a directory from the speciﬁed source path to the absolute destination path.

storeFile storeFile (p. 41) Function that allows to upload a

local ﬁle to the supplied path on the server.

ﬁlestorageEnabledCallback(enabled)

The callback function to be called when ﬁle storage is enabled. Lazy channel on Internet Explorer 11 only.

Parameters:

enabled boolean Indicates whether ﬁle storage is

enabled.

FileStorageErrorCode

The FileStorageError code enums available in the DCV module

• CANCELLED

• ABORTED

• NOT_IMPLEMENTED

• ERROR

• ALREADY_EXIST

• NOT_FOUND

Type:

• number

(37)

ﬁrstFrameCallback(resizeEnabled, relativeMouseModeEnabled, displayId)

The callback function to be called when the ﬁrst frame is received from the NICE DCV server. Emitted for each display.

Parameters:

resizeEnabled boolean Indicates whether the server

supports resizing the client display layout.

relativeMouseModeEnabled boolean Indicates whether the server

supports relative mouse mode.

displayId number The identiﬁer for the display.

idleWarningNotiﬁcationCallback(disconnectionDateTime)

The callback function to be called when the NICE DCV server sends an idle timeout warning.

Parameters:

disconnectionDateTime Date The date and time of the

disconnection.

collaboratorListCallback(collaborators)

The callback function to be called when the NICE DCV server sends the list of collaborators.

Parameters:

collaborators Array.<Object> A list of objects containing information on collaborators.

Name Type Description username string The

username of the collaborator.

owner boolean Indicates whether the

collaborator

(38)

Name Type Description is the session owner.

connectionIdnumber Indicates the ID assigned by the server to the connection.

licenseNotiﬁcationCallback(notiﬁcation)

The callback function to be called when the NICE DCV server sends a notiﬁcation about the license state.

Parameters:

notification Object The notiﬁcation.

Name Type Description product string The DCV

product.

status string The status of the license.

message string A message.

leftDays number The number of days before thelicense expires.

isDemo boolean Indicates if the license is a demo license.

numUnlicensednumber The number of

(39)

Name Type Description unlicensed connections.

licensingModestring The licensing mode.

documentationUrlstring The URL for the

documentation.

list(path)

Parameters:

of which we want to list the content.

LogLevel

The available SDK log levels.

Type:

Monitor

Type:

• Object

Properties:

name string The name of the display head.

rect Object Information about the display

head.

x number The

initial x

(40)

Name Type Description coordinate for the display head.

y number The

initial y coordinate for the display head.

width number The

width (in pixels) of the display head.

height number The height (inpixels) of the display head.

primary boolean Indicates whether the display

head is the primary display head. This is determined from the remote operating system if available.

dpi number The DPI of the display head.

MultiMonitorErrorCode

The MultiMonitorError code enums available in the DCV module

• NO_DISPLAY_CHANNEL

• MAX_DISPLAY_NUMBER_REACHED

• DISPLAY_NOT_OPENED_BY_SERVER

• REQUEST_TIMEOUT

• GENERIC_ERROR

• NO_ERROR

Type:

• number

(41)

qualityIndicatorStateCallback(state)

The callback function to be called when the connection quality indicator changes state.

Parameters:

state Array.<Object> Information about the

connection quality.

name string The

nameof the indicator.

status NORMAL

|

WARNING

|CRITICAL

Description of the status.

changed boolean Indicates whether thestatus changed.

renameDirectory(src, dest)

Parameters:

src string The absolute source path on the

server identifying the directory we want to rename.

dest string The absolute destination path

on the server specifying the target path and directory name.

(42)

renameFile(src, dest)

Parameters:

src string The absolute source path on the

server identifying the ﬁle we want to rename.

dest string The absolute destination path

on the server specifying the target path and ﬁle name.

ResolutionErrorCode

The ResolutionError code enums available in the DCV module

• NO_CHANNEL

Type:

• number

retrieveFile(path)

Parameters:

identifying the ﬁle we want to download locally.

screenshotCallback(screenshot)

The callback function to be called when a screenshot is available.

Parameters:

screenshot byte[] Screenshot buﬀer in PNG

format, or null if screenshot retrieval failed.

(43)

serverInfo

Type:

• Object

Properties:

name string The name of the software.

version Object The software version number.

major number The

major version number.

minor number The

minor version number.

revision number The revision version number.

os string The OS.

arch string The architecture.

hostname string The hostname.

stats

Type:

• Object

Properties:

fps number The current frames per second.

traffic number The current traﬃc in bit/s.

peakTraffic number The peak of traﬃc in bit/s since

the connection was established.

(44)

Connection Class

latency number The current latency in ms.

currentChannels number The number of channels that

have been opened since the connection was established.

openedChannels number The number of currently opened

channels.

channelErrors number The number of channels which

have reported an error.

storeFile(ﬁle, dir)

Parameters:

file File The ﬁle object (for more

information see https://

developer.mozilla.org/en-US/

docs/Web/API/File) we want to upload to the server.

dir string The absolute path on the server

where we want to upload the ﬁle.

WebcamErrorCode

The WebcamError code enums available in the DCV module

• SETTING_WEBCAM_FAILED

• CHANNEL_NOT_AVAILABLE

Type:

• number

Connection Class

The Connection Class obtained by calling the connect method (p. 14) of the dcv module. For an example showing how to use it, see the Getting started (p. 4) section.

Exposes

• Methods (p. 13)

(45)

Methods

List

• attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>} (p. 43)

• captureClipboardEvents(enabled, win, displayId) → {void} (p. 43)

• detachDisplay(displayId) → {void} (p. 44)

• disconnect() → {void} (p. 44)

• disconnectCollaborator(connectionId) → {void} (p. 44)

• enableDisplayQualityUpdates(enable) → {void} (p. 45)

• enterRelativeMouseMode() → {void} (p. 45)

• getConnectedDevices() → {Promise.<Array.<MediaDeviceInfo>>|Promise.<{message:

string}>} (p. 45)

• getFileExplorer() → {Promise.<ﬁlestorage>|Promise.<{code: ChannelErrorCode, message:

string}>} (p. 46)

• getServerInfo() → {serverInfo} (p. 46)

• getStats() → {stats} (p. 46)

• latchModiﬁerKey(key, location, isDown) → {boolean} (p. 46)

• openChannel(name, authToken, callbacks) → {Promise|Promise.<{code: ChannelErrorCode, message:

string}>} (p. 47)

• queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>}

(p. 48)

• registerKeyboardShortcuts(shortcuts) → {void} (p. 48)

• requestDisplayConﬁg(highColorAccuracy) → {Promise|Promise.<{code: DisplayConﬁgErrorCode, message: string}>} (p. 51)

• requestDisplayLayout(layout) → {Promise|Promise.<{code: ResolutionErrorCode, message:

string}>} (p. 51)

• requestResolution(width, height) → {Promise|Promise.<{code: ResolutionErrorCode, message:

string}>} (p. 52)

• sendKeyboardEvent(event) → {boolean} (p. 52)

• sendKeyboardShortcut(shortcut) → {void} (p. 52)

• setDisplayQuality(min, maxopt) → {void} (p. 54)

• setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message:

string}>} (p. 54)

• setKeyboardQuirks(quirks) → {void} (p. 54)

• setMaxDisplayResolution(maxWidth, maxHeight) → {void} (p. 55)

• setMicrophone(enable) → {Promise|Promise.<{code: AudioErrorCode, message: string}>} (p. 56)

• setMinDisplayResolution(minWidth, minHeight) → {void} (p. 56)

• setUploadBandwidth(value) → {number} (p. 57)

• setVolume(volume) → {void} (p. 57)

• setWebcam(enable, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message:

string}>} (p. 57)

• syncClipboards() → {boolean} (p. 58)

(46)

Methods

attachDisplay(win, displayConf) → {Promise.<number>|

Promise.<{code: MultiMonitorErrorCode (p. 37), message:

string}>}

Attaches a speciﬁc display to a window. You can't attach the main display. If successful, the function returns the displayId.

Parameters:

win Object The window to which the display

must be attached.

displayConf Object The conﬁguration of the display.

Name Type AttributesDescription displayIdnumber <optional>The

ID of the display.

displayDivName The nameof the display div.

Returns:

Promise. If rejected, the promise returns an error object.

Type

Promise.<number> | Promise.<{code: MultiMonitorErrorCode (p. 37), message: string}>

captureClipboardEvents(enabled, win, displayId) → {void}

Starts or stops listening to copy-paste events. In the case of interactive clipboards (always in the case of paste) we need to start listening to the copy/paste events. It could be useful to start and stop listening only when it is needed, for example, when a modal is shown.

Parameters:

Name Type Attributes Description

enabled boolean To start listening to

events, specify true. To stop listening to events, specify false.

(47)

Methods

Name Type Attributes Description

win Object <optional> The window in which

to listen for events. If omitted, the default window is used.

displayId number <optional> The ID of the display

that should listen the events. If omitted, the default display of the window is used.

Returns:

Type void

detachDisplay(displayId) → {void}

Detaches a speciﬁc display. The main display cannot be detached.

Parameters:

displayId number The ID of the display to detach.

Returns:

Type void

disconnect() → {void}

Disconnects from the NICE DCV server and closes the connection.

Returns:

Type void

disconnectCollaborator(connectionId) → {void}

Requests disconnect of collaborator connected with the provided connection id (since NICE DCV Web Client SDK version 1.1.0).

(48)

Methods

Parameters:

connectionId boolean The id of the connection that

will be disconnected.

Returns:

Type void

enableDisplayQualityUpdates(enable) → {void}

Enables or disables display quality updates for streaming areas that do not receive updates. Disabling display quality updates reduces bandwidth usage, but it also decreases the display quality.

Parameters:

enable boolean To enable display quality

updates, specify true. To disable display quality updates, specify false.

Returns:

Type void

enterRelativeMouseMode() → {void}

Enables relative mouse mode.

Returns:

Type void

getConnectedDevices() → {Promise.<Array.<MediaDeviceInfo>>|

Promise.<{message: string}>}

Requests a list of the media devices connected to the client computer.

(49)

Methods

Returns:

If successful, it returns a Promise that resolves to an array of MediaDeviceInfo objects. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo. If rejected, the promise returns an error object.

Type

Promise.<Array.<MediaDeviceInfo>> | Promise.<{message: string}>

getFileExplorer() → {Promise.<ﬁlestorage (p. 32)>|

Promise.<{code: ChannelErrorCode (p. 22), message:

string}>}

Gets an object to manage the NICE DCV server's ﬁle storage.

Returns:

Promise. Resolves to the ﬁle explorer object if fulﬁlled, or an error object if rejected.

Type

Promise.<ﬁlestorage (p. 32)> | Promise.<{code: ChannelErrorCode (p. 22), message: string}>

getServerInfo() → {serverInfo (p. 40)}

Gets information about the NICE DCV server.

Returns:

Information about the server software.

Type

serverInfo (p. 40)

getStats() → { stats (p. 40)}

Gets statistics about the NICE DCV server.

Returns:

Information about the streaming statistics.

Type

stats (p. 40)

latchModiﬁerKey(key, location, isDown) → {boolean}

Sends a single keyboard keydown or keyup event for an allowed modiﬁer.

(50)

Methods

Parameters:

key Control | Alt | AltGraph | Meta |

OS | Shift The key to send.

location KeyboardEvent.location The key's location. For more

information, see https://

developer.mozilla.org/en-US/

docs/Web/API/KeyboardEvent/

location.

isDown boolean If the key event to inject is a

keydown (true) or a keyup (false).

Returns:

If the requested combination is valid, the function returns true, otherwise it returns false.

Type boolean

openChannel(name, authToken, callbacks) → {Promise|

Promise.<{code: ChannelErrorCode (p. 22), message:

string}>}

Opens a custom data channel on the connection if it was created on the NICE DCV Server.

Parameters:

name string The name of the channel.

authToken string The authentication token to use

to connect to the channel.

callbacks Object The onMessage and onClose

callbacks functions to call.

Returns:

Promise. If rejected we receive an error object.

Type

Promise | Promise.<{code: ChannelErrorCode (p. 22), message: string}>

NICE DCV

NICE DCV

Web Client SDK Developer Guide

NICE DCV: Web Client SDK Developer Guide

Table of Contents

What is the NICE DCV Web Client SDK?

Prerequisites

Supported features

Browser support

Versioning convention

Getting started with the NICE DCV Web Client SDK

Connect to a NICE DCV server and get the ﬁrst frame

Step 1: Prepare your HTML page

Step 2: Authenticate, connect, and get the ﬁrst frame

Bonus: Automatically create an HTML login form

Work with NICE DCV features

Understanding the featuresUpdate callback function

Handling feature updates

Use NICE DCV Web UI SDK

Prerequisites

Step 1: Prepare your HTML page

Step 2: Authenticate, connect and render the DCVViewer React component.

SDK reference

DCV module

Methods

authenticate(url, callbacks) → {Authentication (p. 58)}

Parameters:

Returns:

connect(conﬁg) → {Promise.< Connection (p. 41)>|

Promise.<{code: ConnectionErrorCode (p. 26), message:

string}>}

Parameters:

Returns:

setLogHandler(handler) → {void}

Parameters:

Returns:

setLogLevel(level) → {void}

Parameters:

Returns:

Members

(constant) AudioError :AudioErrorCode (p. 19)

Type:

(constant)

AuthenticationError :AuthenticationErrorCode (p. 19)

Type:

(constant) ChannelError :ChannelErrorCode (p. 22)

Type:

(constant)

ClosingReasonError :ClosingReasonErrorCode (p. 23)

Type:

(constant) ConnectionError :ConnectionErrorCode (p. 26)

Type:

(constant)

CustomChannelError :CustomChannelErrorCode (p. 27)

Type:

(constant) DisplayConﬁgError :DisplayConﬁgErrorCode (p. 29)

Type:

(constant) FileStorageError :FileStorageErrorCode (p. 33)

Type:

(constant) MultiMonitorError :MultiMonitorErrorCode (p. 37)

Type:

(constant) ResolutionError :ResolutionErrorCode (p. 39)

Type:

(constant) version

Properties:

(constant) WebcamError :WebcamErrorCode (p. 41)

Type:

Type and callback deﬁnitions

AudioErrorCode

Type:

authenticationCallbacks

Type:

Properties:

AuthenticationErrorCode

Type:

authErrorCallback(authentication, error)

Parameters:

authPromptCredentialsCallback(authentication, challenge)

Parameters:

authSuccessCallback(authentication, authenticationData)