本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DCV 模块
实现 DCV 协议客户端的模块。
方法
List
身份验证(网址、回调)→ {身份验证}
启动指定的 NICE DCV 服务器端点的身份验证过程。
参数:
名称 | 类型 | 描述 |
---|---|---|
url
|
字符串 | 正在运行的 NICE DCV 服务器的主机名和端口,格式如下:https://dcv_host_address:port 。例如:https://my-dcv-server:8443 。 |
callbacks
|
身份验证回调 | 在身份验证过程中可以调用的回调。 |
返回值:
-身份验证对象。
- 类型
连接(配置)→ {承诺。 < 连接 >|承诺。 < {代码:ConnectionErrorCode,消息:字符串} >}
连接到指定的 NICE DCV 服务器端点。如果连接成功,将返回一个连接对象。如果连接失败,它将返回一个错误对象。
参数:
名称 | 类型 | 描述 |
---|---|---|
config
|
ConnectionConfig | ConnectionConfig 对象。 |
返回值:
-连接或错误对象。
- 类型
-
诺言。 < 连接 > | 承诺。 < {code: ConnectionErrorCode,消息:string} >
setLogHandler(处理程序)→ {void}
设置自定义日志处理函数。重写默认日志处理程序时,使用浏览器控制台进行调试时,原始日志条目位置将丢失。
参数:
名称 | 类型 | 描述 |
---|---|---|
handler
|
函数 | 自定义日志处理函数。处理程序函数包含级别(数字)、LevelName(字符串)、域(字符串)和消息(字符串)。 |
返回值:
- 类型
-
void
setLogLevel(等级)→ {void}
设置日志级别。只有在使用默认日志处理程序时才需要这样做。
参数:
名称 | 类型 | 描述 |
---|---|---|
level
|
LogLevel | 要使用的日志级别。 |
返回值:
- 类型
-
void
成员
List
- (常量) AudioError:AudioErrorCode
- (常量) AuthenticationError:AuthenticationErrorCode
- (常量) ChannelError:ChannelErrorCode
- (常量) ClosingReasonError:ClosingReasonErrorCode
- (常量) ConnectionError:ConnectionErrorCode
- (常量) CustomChannelError:CustomChannelErrorCode
- (常量) DisplayConfigError:DisplayConfigErrorCode
- (常量) FileStorageError:FileStorageErrorCode
- (常量) LogLevel:LogLevel
- (常量) MultiMonitorError:MultiMonitorErrorCode
- (常量) ResolutionError:ResolutionErrorCode
- (常量) TimezoneRedirectionError:TimezoneRedirectionErrorCode
- (常量) TimezoneRedirectionSetting:TimezoneRedirectionSettingCode
- (常量) TimezoneRedirectionStatus:TimezoneRedirectionStatusCode
- (常量)版本
- (常量) ScreenshotError:ScreenshotErrorCode
- (常量) WebcamError:WebcamErrorCode
(常量) AudioError:AudioErrorCode
AudioError 代码枚举。
类型:
(常量) AuthenticationError:AuthenticationErrorCode
AuthenticationError 代码枚举。
类型:
(常量) ChannelError:ChannelErrorCode
ChannelError 代码枚举。
类型:
(常量) ClosingReasonError:ClosingReasonErrorCode
ClosingReasonError 代码枚举。
类型:
(常量) ConnectionError:ConnectionErrorCode
ConnectionError 代码枚举。
类型:
(常量) CustomChannelError:CustomChannelErrorCode
CustomChannelError 代码枚举。
类型:
(常量) DisplayConfigError:DisplayConfigErrorCode
DisplayConfigError 代码枚举。
类型:
(常量) FileStorageError:FileStorageErrorCode
FileStorageError 代码枚举。
类型:
(常量) LogLevel:LogLevel
可用的 SDK 日志级别。
类型:
(常量) MultiMonitorError:MultiMonitorErrorCode
MultiMonitorError 代码枚举。
类型:
(常量) ResolutionError:ResolutionErrorCode
ResolutionError 代码枚举。
类型:
(常量) TimezoneRedirectionError:TimezoneRedirectionErrorCode
TimezoneRedirectionError 代码枚举。
类型:
(常量) TimezoneRedirectionSetting:TimezoneRedirectionSettingCode
TimezoneRedirectionSetting 代码枚举。
类型:
(常量) TimezoneRedirectionStatus:TimezoneRedirectionStatusCode
TimezoneRedirectionStatus 代码枚举。
类型:
(常量)版本
包含主版本、次要版本、补丁版本、修订版、扩展版和版本的 NICE DCV 版本。
属性:
名称 | 类型 | 描述 |
---|---|---|
major
|
integer | 主要版本号。 |
minor
|
integer | 次要版本号。 |
patch
|
integer | 补丁版本号。 |
revision
|
integer | 修订号。 |
extended
|
字符串 | 扩展字符串。 |
versionStr
|
字符串 | 表单中主要编号、次要号、补丁号和修订版号的组合major.minor.patch+build.revision 。 |
(常量) ScreenshotError:ScreenshotErrorCode
ScreenshotError 代码枚举。
类型:
(常量) WebcamError:WebcamErrorCode
WebcamError 代码枚举。
类型:
类型和回调定义
List
- AudioErrorCode
- 身份验证回调
- AuthenticationErrorCode
- authErrorCallback(身份验证,错误)
- authPromptCredentials回调(身份验证、质询)
- authSuccessCallback(身份验证、身份验证数据)
- 通道
- ChannelErrorCode
- clipboardEventCallback(事件)
- ClosingReasonErrorCode
- 色彩空间
- 连接回调
- ConnectionConfig
- ConnectionErrorCode
- 创建目录(路径)
- CustomChannelErrorCode
- dataChannelCallback(信息)
- 删除文件(路径)
- deviceChangeEvent回调 ()
- 断开连接回调(原因)
- displayAvailabilityCallback(状态、显示ID)
- DisplayConfigErrorCode
- displayLayoutCallback(服务器宽度、服务器高度、头部)
- 功能
- featuresUpdateCallback(功能列表)
- fileDownloadCallback(文件资源)
- filePrintedCallback(打印资源)
- 文件存储
- filestorageEnabledCallback(已启用)
- FileStorageErrorCode
- firstFrameCallback(启用调整大小、已启 relativeMouseMode用、DisplayID)
- idleWarningNotification回调 (disconnectionDateTime)
- collaboratorListCallback(合作者)
- licenseNotificationCallback(通知)
- 列表(路径)
- LogLevel
- 监控
- MultiMonitorErrorCode
- qualityIndicatorState回调(状态)
- 重命名目录(src、dest)
- 重命名文件(src、dest)
- ResolutionErrorCode
- 检索文件(路径)
- 屏幕截图回调(屏幕截图)
- ScreenshotErrorCode
- 服务器信息
- stats
- StoreFile(文件、目录)
- TimezoneRedirectionErrorCode
- TimezoneRedirectionSettingCode
- TimezoneRedirectionStatusCode
- WebcamErrorCode
AudioErrorCode
DCV 模块中可用的 AudioError 代码枚举
-
SETTING_AUDIO_FAILED
-
CHANNEL_NOT_AVAILABLE
类型:
-
number
身份验证回调
身份验证回调
类型:
-
对象
属性:
名称 | 类型 | 描述 |
---|---|---|
promptCredentials
|
authPromptCredentials回调 | 当用户被要求提供证书时要调用的回调函数。 |
error
|
authErrorCallback | 身份验证失败时要调用的回调函数。 |
success
|
authSuccessCallback | 身份验证成功时要调用的回调函数。 |
AuthenticationErrorCode
DCV 模块中可用的 AuthenticationError 代码枚举
-
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
authErrorCallback(身份验证,错误)
身份验证失败时要调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
authentication
|
身份验证 | 身份验证对象。 | |||||||||
error
|
对象 | 身份验证过程引发的错误对象。
|
authPromptCredentials回调(身份验证、质询)
当用户被要求提供证书时要调用的回调函数。用户必须通过提供所请求的证书来回答挑战。
参数:
名称 | 类型 | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
authentication
|
身份验证 | 身份验证对象。 | |||||||||||||||
challenge
|
对象 | 挑战。
|
authSuccessCallback(身份验证、身份验证数据)
身份验证成功时要调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
authentication
|
身份验证 | 身份验证对象。 | |||||||||
authenticationData
|
数组。 <Object> | 包含 NICE DCV 会话 ID 和身份验证令牌的对象数组。
|
通道
可以指定的可用频道。
类型:
-
“剪贴板” | “显示” | “输入” | “音频” | “文件存储”
ChannelErrorCode
DCV 模块中可用的 ChannelError 代码枚举
-
ALREADY_OPEN
-
INITIALIZATION_FAILED
-
REJECTED
类型:
-
number
clipboardEventCallback(事件)
生成 aclipboardEvent
时要调用的回调函数。
参数:
名称 | 类型 | 描述 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
event
|
对象 | 有关剪贴板事件的信息。
|
ClosingReasonErrorCode
DCV 模块中可用的 ClosingReasonError 代码枚举
-
TRANSPORT_ERROR
-
NO_ERROR
-
GENERIC_ERROR
-
INTERNAL_SERVER_ERROR
-
PROTOCOL_ERROR
-
AUTHORIZATION_DENIED
-
AUTHORIZATION_REVOKED
-
ACCESS_REJECTED
-
IDLE_TIMEOUT_EXPIRED
-
DISCONNECT_BY_OWNER
-
DISCONNECT_BY_USER
-
EVICTED
类型:
-
number
色彩空间
可以指定的可用色彩空间。
类型:
-
“RGB” | “YUV_REC601" | “YUV_REC709”
连接回调
发生连接错误时可以调用的回调。
类型:
-
对象
属性:
名称 | 类型 | 描述 |
---|---|---|
disconnect
|
断开连接回调 | 连接结束时要调用的回调函数。 |
displayLayout
|
displayLayoutCallback | 更改显示布局或分辨率时要调用的回调函数。 |
displayAvailability
|
displayAvailabilityCallback | 显示器的可用性发生变化时调用的回调函数。 |
firstFrame
|
firstFrameCallback | 从 NICE DCV 服务器接收到第一帧时要调用的回调函数。 |
filePrinted
|
filePrintedCallback | 在 NICE DCV 服务器上打印文件时要调用的回调函数。 |
fileDownload
|
fileDownloadCallback | 准备从 NICE DCV 服务器下载文件时要调用的回调函数。 |
dataChannel
|
dataChannelCallback | 当 NICE DCV 服务器发送有关数据通道可用性的通知时调用的回调函数。 |
licenseNotification
|
licenseNotificationCallback | NICE DCV 服务器发送有关许可证状态的通知时要调用的回调函数。 |
idleWarningNotification
|
idleWarningNotification回调 | NICE DCV 服务器发送空闲超时警告时要调用的回调函数。 |
collaboratorList
|
collaboratorListCallback | NICE DCV 服务器发送合作者列表时要调用的回调函数(自 NICE DCV Web Client SDK 版本 1.1.0 起)。 |
qualityIndicatorState
|
qualityIndicatorState回调 | 连接质量指示器更改状态时要调用的回调函数。 |
filestorageEnabled
|
filestorageEnabledCallback | 启用或禁用文件存储时要调用的回调函数。 |
featuresUpdate
|
featuresUpdateCallback | 当功能的状态发生变化时调用的回调函数。 |
clipboardEvent
|
clipboardEventCallback | 生成 aclipboardEvent 时要调用的回调函数。 |
deviceChangeEvent
|
deviceChangeEvent回调 | 触发deviceChange 事件时要调用的回调函数。 |
screenshot
|
屏幕截图回调 | ascreenshot 可用时要调用的回调函数。 |
ConnectionConfig
NICE DCV 连接的配置。
类型:
-
对象
属性:
名称 | 类型 | 描述 |
---|---|---|
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
|
数组。 < 频道 > | 表示可以启用的频道列表。如果未指定或提供了空数组,则默认为所有可用通道。 |
losslessColorspace
|
色彩空间 | 表示将使用的色彩空间。如果未指定,则默认为 “RGB”。 |
divId
|
字符串 | HTML DOM 中div 对象的 ID,SDK 应在其中使用远程流创建画布。 |
volumeLevel
|
integer | 首选音量。有效范围为 0 到 100。 |
clipboardAutoSync
|
布尔值 | 表示是否为兼容的 Web 浏览器启用了从 NICE DCV 会话剪贴板到本地客户端剪贴板的自动复制。 |
dynamicAudioTuning
|
布尔值 | 指示在建立连接时是否基于 NICE DCV 服务器音频设置动态调整音频。 |
clientHiDpiScaling
|
布尔值 | 指示是否根据客户端的 DPI 缩放画布。 |
highColorAccuracy
|
布尔值 | 指示是否应使用高色彩精度(如果可用)。如果未指定,将默认值为false 。 |
enableWebCodecs
|
布尔值 | 表示是否 WebCodecs 应使用(如果可用)。如果未指定,则默认为 false 。 |
observers
|
连接回调 | 用于调用与连接相关的事件的回调函数。 |
callbacks
|
连接回调 | 与observers 属性相同,但每个回调都将 Co n nection 对象作为第一个参数。 |
ConnectionErrorCode
DCV 模块中可用的 ConnectionError 代码枚举
-
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 起) -
SERVER_UNREACHABLE
(自 DCV 服务器 2022.1 起)
类型:
-
number
创建目录(路径)
参数:
名称 | 类型 | 描述 |
---|---|---|
path
|
字符串 | 我们要在其中创建目录的服务器上的绝对路径。它还应包括目标目录的名称。 |
CustomChannelErrorCode
DCV 模块中可用的 CustomChannelError 代码枚举
-
TRANSPORT_ERROR
类型:
-
number
dataChannelCallback(信息)
当 NICE DCV 服务器发送有关数据通道可用性的通知时调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
info
|
对象 | 有关数据通道的信息。
|
删除文件(路径)
参数:
名称 | 类型 | 描述 |
---|---|---|
path
|
字符串 | 服务器上标识我们要删除的文件的绝对路径。 |
deviceChangeEvent回调 ()
触发deviceChange
事件时要调用的回调函数。
断开连接回调(原因)
连接结束时要调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
reason
|
对象 | 断开连接的原因。
|
displayAvailabilityCallback(状态、显示ID)
显示器的可用性发生变化时调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
status
|
对象 | 显示屏的状态。
|
|||||||||
displayId
|
number | 显示屏的标识符。 |
DisplayConfigErrorCode
DCV 模块中可用的 DisplayConfigError 代码枚举
-
INVALID_ARGUMENT
-
UNSUPPORTED_OPERATION
-
NO_CHANNEL
类型:
-
number
displayLayoutCallback(服务器宽度、服务器高度、头部)
更改显示布局或分辨率时要调用的回调函数。
参数:
名称 | 类型 | 描述 |
---|---|---|
serverWidth
|
number | 主显示器的宽度(以像素为单位)。 |
serverHeight
|
number | 主显示屏的高度(以像素为单位)。 |
heads
|
数组。 < 监视器 > | NICE DCV 服务器支持的显示头。 |
功能
特征值。
-
display
-表示单屏视频流的可用性。 -
display-multi
-表示多显示器视频流的可用性。 -
high-color-accuracy
-表示高色彩准确度的可用性(自 NICE DCV Web Client SDK 版本 1.1.0 起)。 -
mouse
-表示鼠标功能的可用性。 -
keyboard
-表示键盘功能的可用性。 -
keyboard-sas
-表示 SAS 序列(控制 + Alt + 删除)功能的可用性。 -
relative-mouse
-表示相对鼠标模式的可用性。 -
clipboard-copy
-表示从 NICE DCV 服务器到客户端的剪贴板复制功能的可用性。 -
clipboard-paste
-表示从客户端到 NICE DCV 服务器的剪贴板粘贴功能的可用性。 -
audio-in
-表示使用麦克风的音频输入功能的可用性。 -
audio-out
-表示音频播放功能的可用性。 -
webcam
-表示网络摄像头直播功能的可用性。 -
file-download
-表示从 NICE DCV 服务器向客户端下载文件功能的可用性。 -
file-upload
-表示从客户端到 NICE DCV 服务器的文件上传功能的可用性。 -
timezone-redirection
-表示时区重定向功能的可用性(自 NICE DCV Web Client SDK 版本 1.3.0 起)。
类型:
-
字符串
featuresUpdateCallback(功能列表)
当功能的状态发生变化时调用的回调函数。
参数:
名称 | 类型 | 描述 |
---|---|---|
featuresList
|
数组。 < 功能 > | 一系列已更改的功能。 |
fileDownloadCallback(文件资源)
准备从 NICE DCV 服务器下载文件时要调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fileResource
|
对象 | 有关准备下载的文件的信息。
|
filePrintedCallback(打印资源)
在 NICE DCV 服务器上打印文件时要调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
printResource
|
对象 | 有关打印文件的信息。
|
文件存储
允许在文件系统上浏览和执行操作的对象。
类型:
-
对象
属性:
名称 | 类型 | 描述 |
---|---|---|
list
|
清单 | 允许列出服务器上提供的路径中存在的项目(文件和目录)的函数。 |
createDirectory
|
创建目录 | 允许在服务器上的指定路径上创建目录的函数。 |
retrieveFile
|
检索文件 | 允许在服务器上的指定路径本地下载文件的函数。 |
deleteFile
|
删除文件 | 允许删除服务器上指定路径上的文件的函数。 |
renameFile
|
重命名文件 | 允许将文件从指定源路径重命名到指定目标路径的函数。 |
renameDirectory
|
重命名目录 | 允许将目录从指定源路径重命名为绝对目标路径的函数。 |
storeFile
|
StoreFile | 允许将本地文件上传到服务器上提供的路径的函数。 |
filestorageEnabledCallback(已启用)
启用文件存储时要调用的回调函数。仅限 Internet Explorer 11 上的懒人
参数:
名称 | 类型 | 说明 |
---|---|---|
enabled
|
布尔值 | 指示是否启用文件存储。 |
FileStorageErrorCode
DCV 模块中可用的 FileStorageError 代码枚举
-
CANCELLED
-
ABORTED
-
INVALID_ARGUMENT
-
NOT_IMPLEMENTED
-
ERROR
-
ALREADY_EXIST
-
NOT_FOUND
类型:
-
number
firstFrameCallback(启用调整大小、已启 relativeMouseMode用、DisplayID)
从 NICE DCV 服务器接收到第一帧时要调用的回调函数。为每个显示器发出。
参数:
名称 | 类型 | 说明 |
---|---|---|
resizeEnabled
|
布尔值 | 表示服务器是否支持调整客户端显示布局的大小。 |
relativeMouseModeEnabled
|
布尔值 | 表示服务器是否支持相对鼠标模式。 |
displayId
|
number | 显示屏的标识符。 |
idleWarningNotification回调 (disconnectionDateTime)
NICE DCV 服务器发送空闲超时警告时要调用的回调函数。
参数:
名称 | 类型 | 说明 |
---|---|---|
disconnectionDateTime
|
日期 | 断开连接的日期和时间。 |
collaboratorListCallback(合作者)
NICE DCV 服务器发送协作者列表时要调用的回调函数。
参数:
名称 | 类型 | 描述 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
collaborators
|
数组。 <Object> | 包含合作者信息的对象列表。
|
licenseNotificationCallback(通知)
NICE DCV 服务器发送有关许可证状态的通知时要调用的回调函数。
参数:
名称 | 类型 | 描述 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
notification
|
对象 | 通知。
|
列表(路径)
参数:
名称 | 类型 | 描述 |
---|---|---|
path
|
字符串 | 我们要列出其内容的服务器上的绝对路径。 |
LogLevel
可用的 SDK 日志级别。
类型:
-
跟踪 | 调试 | 信息 | 警告 | 错误 | 静默
监控
类型:
-
对象
属性:
名称 | 类型 | 描述 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
字符串 | 显示头的名称。 | |||||||||||||||
rect
|
对象 | 有关显示头的信息。
|
|||||||||||||||
primary
|
布尔值 | 指示显示头是否为主显示头。这是由远程操作系统(如果可用)确定的。 | |||||||||||||||
dpi
|
number | 显示头的 DPI。 |
MultiMonitorErrorCode
DCV 模块中可用的 MultiMonitorError 代码枚举
-
NO_DISPLAY_CHANNEL
-
MAX_DISPLAY_NUMBER_REACHED
-
INVALID_ARGUMENT
-
DISPLAY_NOT_OPENED_BY_SERVER
-
REQUEST_TIMEOUT
-
GENERIC_ERROR
-
NO_ERROR
类型:
-
number
qualityIndicatorState回调(状态)
连接质量指示器更改状态时要调用的回调函数。
参数:
名称 | 类型 | 描述 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
state
|
数组。 <Object> | 有关连接质量的信息。
|
重命名目录(src、dest)
参数:
名称 | 类型 | 描述 |
---|---|---|
src
|
字符串 | 服务器上的绝对源路径,用于标识我们要重命名的目录。 |
dest
|
字符串 | 服务器上的绝对目标路径,指定目标路径和目录名。 |
重命名文件(src、dest)
参数:
名称 | 类型 | 描述 |
---|---|---|
src
|
字符串 | 服务器上标识我们要重命名的文件的绝对源路径。 |
dest
|
字符串 | 服务器上的绝对目标路径,指定目标路径和文件名。 |
ResolutionErrorCode
DCV 模块中可用的 ResolutionError 代码枚举
-
INVALID_ARGUMENT
-
NO_CHANNEL
-
NOT_IMPLEMENTED
类型:
-
number
检索文件(路径)
参数:
名称 | 类型 | 描述 |
---|---|---|
path
|
字符串 | 服务器上的绝对路径,用于标识我们要在本地下载的文件。 |
屏幕截图回调(屏幕截图)
屏幕截图可用时要调用的回调函数。
参数:
名称 | 类型 | 描述 |
---|---|---|
screenshot
|
byte[] | PNG 格式的屏幕截图缓冲区,null 或者屏幕截图检索失败时。 |
ScreenshotErrorCode
DCV 模块中可用的 ScreenshotError 代码枚举
-
NO_CHANNEL
-
GENERIC_ERROR
类型:
-
number
服务器信息
类型:
-
对象
属性:
名称 | 类型 | 描述 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
字符串 | 软件的名称。 | ||||||||||||
version
|
对象 | 软件版本号。
|
||||||||||||
os
|
字符串 | 操作系统。 | ||||||||||||
arch
|
字符串 | 架构。 | ||||||||||||
hostname
|
字符串 | 主机名。 |
stats
类型:
-
对象
属性:
名称 | 类型 | 描述 |
---|---|---|
fps
|
number | 当前每秒帧数。 |
traffic
|
number | 当前流量(以比特/秒为单位)。 |
peakTraffic
|
number | 自建立连接以来的流量峰值,以 bit/s 为单位。 |
latency
|
number | 当前延迟(毫秒)。 |
currentChannels
|
number | 自建立连接以来已打开的频道数量。 |
openedChannels
|
number | 当前打开的频道数量。 |
channelErrors
|
number | 报告错误的频道数量。 |
StoreFile(文件、目录)
参数:
名称 | 类型 | 描述 |
---|---|---|
file
|
文件 | 我们要上传到服务器的文件对象(有关更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/File)。 |
dir
|
字符串 | 我们要上传文件的服务器上的绝对路径。 |
TimezoneRedirectionErrorCode
DCV 模块中可用的 TimezoneRedirectionError 代码枚举
-
INVALID_ARGUMENT
-
NO_CHANNEL
-
USER_CANNOT_CHANGE
类型:
-
number
TimezoneRedirectionSettingCode
DCV 模块中可用的 TimezoneRedirectionSetting 代码枚举
-
ALWAYS_OFF
-
ALWAYS_ON
-
CLIENT_DECIDES
类型:
-
number
TimezoneRedirectionStatusCode
DCV 模块中可用的 TimezoneRedirectionStatus 代码枚举
-
SUCCESS
-
PERMISSION_ERROR
-
GENERIC_ERROR
类型:
-
number
WebcamErrorCode
DCV 模块中可用的 WebcamError 代码枚举
-
SETTING_WEBCAM_FAILED
-
CHANNEL_NOT_AVAILABLE
类型:
-
number