DCV 模块 - NICE DCV
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DCV 模块

实现 DCV 协议客户端的模块。

Methods

身份验证(网址,回调)→ {Authentication}

启动指定的 NICE DCV 服务器端点的身份验证过程。

参数:

名称 类型 描述
url 字符串 正在运行的 NICE DCV 服务器的主机名和端口,格式如下:https://dcv_host_address:port。 例如:https://my-dcv-server:8443
callbacks 身份验证回调 在身份验证过程中可以调用的回调。

返回值:

-身份验证对象。

类型

身份验证

连接(配置)→ {承诺。 <Connection>| 承诺。 < {代码: ConnectionErrorCode,消息:字符串} >}

连接到指定的 NICE DCV 服务器端点。如果连接成功,则返回一个 Connection 对象。如果连接失败,则返回错误对象。

参数:

名称 类型 描述
config 连接配置 连接配置对象。

返回值:

-连接对象或错误对象。

类型

承诺 <Connection> | 承诺。 < {代码: 连接错误代码,消息:字符串} >

设置注册处理程序(处理程序)→ {void}

设置自定义日志处理函数。覆盖默认日志处理程序时,使用浏览器控制台进行调试时,原始日志条目位置将丢失。

参数:

名称 类型 描述
handler function 自定义日志处理函数。处理程序函数包含级别(数字)、级别名称(字符串)、域(字符串)和消息(字符串)。

返回值:

类型

void

setLogLevel 别(级别)→ {void}

设置日志级别。只有在使用默认日志处理程序时必需。

参数:

名称 类型 描述
level 日志级别 要使用的日志级别。

返回值:

类型

void

Members

(常量)音频错误:AudioErrorCode

音频错误代码枚举。

类型:

(常量)身份验证错误:AuthenticationErrorCode

身份验证错误代码枚举。

类型:

(常量)通道错误:ChannelErrorCode

通道错误代码枚举。

类型:

(常量)关闭原因错误:ClosingReasonErrorCode

关闭原因错误代码枚举。

类型:

(常量)连接错误:ConnectionErrorCode

连接错误代码枚举。

类型:

(常量)自定义通道错误:CustomChannelErrorCode

自定义通道错误代码枚举。

类型:

(常量)文件更改错误:FileStorageErrorCode

文件错误代码枚举。

类型:

(常数)多监视器:MultiMonitorErrorCode

多监视器代码枚举。

类型:

(常量)分辨率错误:ResolutionErrorCode

分辨率错误代码枚举。

类型:

(常量)版本

NICE DCV 版本包含主要、次要、修补程序、修订版、扩展版和版本 STR。

属性:

名称 类型 描述
major integer 主要版本号。
minor integer 次要版本号。
patch integer 修补程序版本号。
revision integer 修订版号。
extended 字符串 扩展字符串。
versionStr 字符串 主要、次要、修补程序和修订版号在窗体中的串联major.minor.patch+build.revision

(常量)网络摄像头错误:WebcamErrorCode

网络摄像头错误代码枚举。

类型:

类型和回调定义

AudioErrorCode

DCV 模块中提供的音频错误代码枚举

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

类型:

  • number

authenticationCallbacks

身份验证验证回调

类型:

  • Object

属性:

名称 类型 描述
promptCredentials 授权提示凭据回调 当用户受到凭据质询时要调用的回调函数。
error 授权错误回调 身份验证失败时要调用的回调函数。
success 验证成功回调 身份验证成功时要调用的回调函数。

AuthenticationErrorCode

DCV 模块中可用的验证错误代码枚举

  • 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

类型:

  • number

验证错误回调(身份验证,错误)

身份验证失败时要调用的回调函数。

参数:

名称 类型 描述
authentication 身份验证 身份验证对象。
error Object 身份验证过程引发的错误对象。
名称 类型 描述
code 身份验证错误代码 错误代码。
message 字符串 错误消息。

授权提示凭据回调(身份验证、质疑)

当用户受到凭据质询时要调用的回调函数。用户必须通过提供请求的凭据来回答质询。

参数:

名称 类型 描述
authentication 身份验证 身份验证对象。
challenge Object 挑战。
名称 类型 描述
requiredCredentials 数组。 <Object> 请求的凭据对象数组。
名称 类型 描述
name 字符串 请求凭据的名称。
type 字符串 请求凭据的类型。

验证后续回调(身份验证、身份验证数据)

身份验证成功时要调用的回调函数。

参数:

名称 类型 描述
authentication 身份验证 身份验证对象。
authenticationData 数组。 <Object> 包含 NICE DCV 会话 ID 和身份验证令牌的对象数组。
名称 类型 描述
sessionId 字符串 NICE DCV 会话 ID。
authToken 字符串 NICE DCV 会话的身份验证令牌。

Channel

可以指定的可用通道。

类型:

  • “剪贴板” | “显示” | “输入” | “音频” | “文件”

ChannelErrorCode

DCV 模块中可用的通道错误代码枚举

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

类型:

  • number

剪贴板停止回调(事件)

调用的回调函数,当clipboardEvent生成。

参数:

名称 类型 描述
event Object 有关剪贴板事件的信息。
名称 类型 Attributes 描述
name 建立 | 复制 | 粘贴 | 数据警报 | 自动复制 | 新数据可用 始终存在。事件名称。
clipboardData 对象 | 字符串 剪贴板中的数据。
autoCopy 布尔值 <optional> 指示是否启用了从会话剪贴板到本地客户端剪贴板的自动复制。
maxDataSize number <optional> 可放置在剪贴板中的最大数据量。
error 字符串 <optional> 错误信息(如果适用)。

ClosingReasonErrorCode

DCV 模块中可用的关闭原因错误代码枚举

  • TRANSPORT_ERROR

  • NO_ERROR

  • GENERIC_ERROR

  • INTERNAL_SERVER_ERROR

  • PROTOCOL_ERROR

  • AUTHORIZATION_DENIED

  • AUTHORIZATION_REVOKED

  • ACCESS_REJECTED

  • IDLE_TIMEOUT_EXPIRED

类型:

  • number

Colorspace

可以指定的可用颜色空间。

类型:

  • “RGB” | “我们的信息” | “我们的信息”

connectionCallbacks

在发生连接错误时可以调用的回调。

类型:

  • Object

属性:

名称 类型 描述
disconnect 断开连接回调 连接结束时调用的回调函数。
displayLayout 显示布局回调 在更改显示布局或分辨率时调用的回调函数。
displayAvailability 显示可用性回调 当显示器的可用性发生变化时调用的回调函数。
firstFrame 第一帧全面返回 从 NICE DCV 服务器接收第一帧时调用的回调函数。
filePrinted 文件打印回调 在 NICE DCV 服务器上打印文件时调用的回调函数。
fileDownload 文件下载回调 当文件准备好从 NICE DCV 服务器下载时调用的回调函数。
dataChannel 数据全程回调 NICE DCV 服务器发送有关数据通道可用性的通知时调用的回调函数。
licenseNotification 许可证回调 NICE DCV 服务器发送有关许可证状态的通知时调用的回调函数。
idleWarningNotification 空闲警告通知回调 NICE DCV 服务器发送空闲超时警告时调用的回调函数。
qualityIndicatorState 质量指标反馈 连接质量指示器更改状态时调用的回调函数。
filestorageEnabled 文件启用回调 启用或禁用文件存储时调用的回调函数。
featuresUpdate 功能支持全面 要素状态发生变化时调用的回调函数。
clipboardEvent 剪贴板拒绝回调 调用的回调函数,当clipboardEvent生成。
deviceChangeEvent 设备挂接事件回调 调用的回调函数,当deviceChange事件被触发。

ConnectionConfig

NICE DCV 连接的配置。

类型:

  • Object

属性:

名称 类型 描述
url 字符串 正在运行的 NICE DCV 服务器的主机名和端口,格式如下:https://dcv_host_address:port。 例如:https://my-dcv-server:8443
sessionId 字符串 NICE DCV 会话 ID。
authToken 字符串 连接到服务器时使用的身份验证令牌。
baseUrl 字符串 从中加载 SDK 文件的绝对或相对 URL。
resourceBaseUrl 字符串 从中访问 DCV 资源的绝对或相对 URL。
enabledChannels 数组。 <Channel> 指示可以启用的通道列表。如果未指定或提供空数组,则默认为所有可用通道。
losslessColorspace 颜色空间 指示将使用的色彩空间。如果未指定,则默认为 “RGB”。
divId 字符串 的 IDdiv对象,其中 SDK 应该使用远程流创建画布。
volumeLevel integer 首选卷级别。有效范围为 0 至 100。
clipboardAutoSync 布尔值 指示是否为兼容的 Web 浏览器启用了从 NICE DCV 会话剪贴板到本地客户端剪贴板的自动复制。
dynamicAudioTuning 布尔值 指示建立连接时是否根据 NICE DCV 服务器音频设置动态调整音频。
clientHiDpiScaling 布尔值 指示是否根据客户端的 DPI 缩放画布。
observers 连接回调 用于调用与连接相关的事件的回调函数。
callbacks 连接回调 与观察者相同,但每个回调都会添加Connection对象作为第一个参数。

ConnectionErrorCode

DCV 模块中可用的连接错误代码枚举

  • ALREADY_OPEN

  • INVALID_CONFIG

  • INITIALIZATION_FAILED

  • REJECTED

  • MAIN_CHANNEL_ALREADY_OPEN

  • GENERIC_ERROR(自 DCV 服务器 2021.0 以来)

  • INTERNAL_SERVER_ERROR(自 DCV 服务器 2021.0 以来)

  • AUTHENTICATION_FAILED(自 DCV 服务器 2021.0 以来)

  • PROTOCOL_ERROR(自 DCV 服务器 2021.0 以来)

  • INVALID_SESSION_ID(自 DCV 服务器 2021.0 以来)

  • INVALID_CONNECTION_ID(自 DCV 服务器 2021.0 以来)

  • CONNECTION_LIMIT_REACHED(自 DCV 服务器 2021.0 以来)

类型:

  • number

创建目录(路径)

参数:

名称 类型 描述
path 字符串 我们想要创建一个目录的服务器上的绝对路径. 它还应包含目标目录的名称。

CustomChannelErrorCode

DCV 模块中可用的自定义通道错误代码枚举

  • TRANSPORT_ERROR

类型:

  • number

数据全程回调(信息)

NICE DCV 服务器发送有关数据通道可用性的通知时调用的回调函数。

参数:

名称 类型 描述
info Object 有关数据通道的信息。
名称 类型 描述
name 字符串 数据通道的名称。
token 字符串 数据通道的身份验证令牌。

删除文件(路径)

参数:

名称 类型 描述
path 字符串 服务器上标识我们要删除的文件的绝对路径。

设备挂接事件回调 ()

调用的回调函数,当deviceChange事件被触发。

断开连接回叫(原因)

连接结束时调用的回调函数。

参数:

名称 类型 描述
reason Object 断开连接的原因。
名称 类型 描述
code number 原因代码。
message 字符串 原因消息。

显示可用性回调(状态、显示 ID)

当显示器的可用性发生变化时调用的回调函数。

参数:

名称 类型 描述
status Object 显示的状态。
名称 类型 描述
enabled 布尔值 指示是否启用了显示。
closed 布尔值 指示显示是否已关闭。
displayId number 显示的标识符。

显示布局回调(服务器宽度,服务器高度,头)

在更改显示布局或分辨率时调用的回调函数。

参数:

名称 类型 描述
serverWidth number 主显示器的宽度 (宽度)。
serverHeight number 主显示器的高度(像素)。
heads 数组。 <显示器> NICE DCV 服务器支持的显示头。

feature

要素值。

  • display-表示单显示视频流的可用性。

  • display-multi-指示多显示视频流的可用性。

  • mouse-指示鼠标功能的可用性。

  • keyboard-表示键盘功能的可用性。

  • keyboard-sas-指示 SAS 序列(控制 + 替代 + 删除)功能的可用性。

  • relative-mouse-指示相对鼠标模式的可用性。

  • clipboard-copy-指示剪贴板复制功能从 NICE DCV 服务器到客户端的可用性。

  • clipboard-paste-指示剪贴板粘贴功能从客户端到 NICE DCV 服务器的可用性。

  • audio-in-指示使用麦克风的音频输入功能的可用性。

  • audio-out-指示音频播放功能的可用性。

  • webcam-指示网络摄像头流功能的可用性。

  • file-download-指示从 NICE DCV 服务器到客户端的文件下载功能的可用性。

  • file-upload-指示从客户端到 NICE DCV 服务器的文件上传功能的可用性。

类型:

  • 字符串

功能支持背部(功能列表)

要素状态发生变化时调用的回调函数。

参数:

名称 类型 描述
featuresList 数组。 <功能> 已更改的功能数组。

文件下载回调(文件资源)

当文件准备好从 NICE DCV 服务器下载时调用的回调函数。

参数:

名称 类型 描述
fileResource Object 有关可供下载的文件的信息。
名称 类型 描述
id 字符串 文件的标识符。
url 字符串 用于下载文件的 URL。
domain 字符串 资源域。
token 字符串 用于下载文件的身份验证令牌。此令牌也包含在 URL 中。

文件打印回调(打印资源)

在 NICE DCV 服务器上打印文件时调用的回调函数。

参数:

名称 类型 描述
printResource Object 有关打印文件的信息。
名称 类型 描述
id 字符串 打印文件的标识符。
url 字符串 用于下载打印文件的 URL。
domain 字符串 资源域。在本例中,printer
token 字符串 用于下载打印文件的身份验证令牌。此令牌也包含在 URL 中。

filestorage

允许在文件系统上浏览和执行操作的对象。

类型:

  • Object

属性:

名称 类型 描述
list list 允许列出服务器上提供的路径中存在的项目(文件和目录)的函数。
createDirectory CreateDirectory 允许在服务器上的指定路径创建目录的函数。
retrieveFile 检索文件 允许在服务器上指定路径上本地下载文件的函数。
deleteFile 删除文件 允许删除服务器上指定路径上的文件的函数。
renameFile 重命名文件 允许将文件从指定的源路径重命名为指定目标路径的函数。
renameDirectory 重命名目录 允许将目录从指定的源路径重命名为绝对目标路径的函数。
storeFile 存储文件 允许将本地文件上载到服务器上提供的路径的函数。

文件启用回调(已启用)

启用文件存储时调用的回调函数。仅在互联网浏览器上懒惰通道 11.

参数:

名称 类型 描述
enabled 布尔值 指示是否启用文件存储。

FileStorageErrorCode

DCV 模块中可用的文件错误代码枚举

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

类型:

  • number

第一帧全面返回(启用调整大小、启用相对鼠标模式、显示 ID)

从 NICE DCV 服务器接收第一帧时调用的回调函数。为每个显示器发出。

参数:

名称 类型 描述
resizeEnabled 布尔值 指示服务器是否支持调整客户端显示布局的大小。
relativeMouseModeEnabled 布尔值 指示服务器是否支持相对鼠标模式。
displayId number 显示的标识符。

空闲警告通知回调(断开连接日期时间)

NICE DCV 服务器发送空闲超时警告时调用的回调函数。

参数:

名称 类型 描述
disconnectionDateTime 日期 断开连接的日期和时间。

许可证回调(通知)

NICE DCV 服务器发送有关许可证状态的通知时调用的回调函数。

参数:

名称 类型 描述
notification Object 通知功能。
名称 类型 描述
product 字符串 DCV 产品。
status 字符串 许可证的状态。
message 字符串 消息
leftDays number 许可证过期前的天数。
isDemo 布尔值 指示许可证是否为演示许可证。
numUnlicensed number 未许可连接的数量。
licensingMode 字符串 许可模式。
documentationUrl 字符串 文档的 URL。

列表 (路径)

参数:

名称 类型 描述
path 字符串 我们要列出内容的服务器上的绝对路径。

LogLevel

可用的 SDK 日志级别。

类型:

  • 跟踪 | 调试 | 信息 | 警告 | 错误 | 无声

Monitor

类型:

  • Object

属性:

名称 类型 描述
name 字符串 显示头的名称。
rect Object 有关显示头的信息。
名称 类型 描述
x number 初始x坐标为显示头。
y number 初始y坐标为显示头。
width number 显示头的宽度 (宽度)。
height number 显示头的高度(像素)。
primary 布尔值 指示显示头是否为主显示头。这是由远程操作系统(如果可用)确定的。
dpi number 显示头的 DPI。

MultiMonitorErrorCode

DCV 模块中可用的多监视器代码枚举

  • NO_DISPLAY_CHANNEL

  • MAX_DISPLAY_NUMBER_REACHED

  • INVALID_ARGUMENT

  • DISPLAY_NOT_OPENED_BY_SERVER

  • REQUEST_TIMEOUT

  • GENERIC_ERROR

  • NO_ERROR

类型:

  • number

质量指标反馈(状态)

连接质量指示器更改状态时调用的回调函数。

参数:

名称 类型 描述
state 数组。 <Object> 有关连接质量的信息。
名称 类型 描述
name 字符串 指标的名称。
status 正常 | 警告 | 严重 状态描述。
changed 布尔值 指示状态是否更改。

重命名目录(src,目标)

参数:

名称 类型 描述
src 字符串 服务器上标识我们要重命名的目录的绝对源路径。
dest 字符串 指定目标路径和目录名称的服务器上的绝对目标路径。

重命名文件(src,目标)

参数:

名称 类型 描述
src 字符串 服务器上标识我们要重命名的文件的绝对源路径。
dest 字符串 指定目标路径和文件名的服务器上的绝对目标路径。

ResolutionErrorCode

DCV 模块中可用的分辨率错误代码枚举

  • INVALID_ARGUMENT

  • NO_CHANNEL

类型:

  • number

检索文件(路径)

参数:

名称 类型 描述
path 字符串 服务器上标识我们要在本地下载的文件的绝对路径。

serverInfo

类型:

  • Object

属性:

名称 类型 描述
name 字符串 软件的名称。
version Object 软件版本号。
名称 类型 描述
major number 主要版本号。
minor number 次要版本号。
revision number 修订版本号。
os 字符串 操作系统。
arch 字符串 架构。
hostname 字符串 主机名。

stats

类型:

  • Object

属性:

名称 类型 描述
fps number 当前每秒帧数。
traffic number 当前流量(以 bit/s 为单位)。
peakTraffic number 建立连接以来的流量峰值(位/秒)。
latency number 当前延迟时间(以毫秒为单位)
currentChannels number 自建立连接以来已打开的通道数。
openedChannels number 当前打开通道的数量。
channelErrors number 报告错误的通道数。

存储文件(文件,目录)

参数:

名称 类型 描述
file 文件 文件对象 (有关更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/File) 我们要上传到服务器.
dir 字符串 我们要上传文件的服务器上的绝对路径。

WebcamErrorCode

DCV 模块中可用的网络摄像头错误代码枚举

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

类型:

  • number