本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DCV 模块
实现 DCV 协议的客户端的模块。
方法
列表
身份验证(url,回调)→ {身份验证}
启动指定的 NICE DCV 服务器终端节点的身份验证过程。
参数:
名称 | 类型 | 说明 |
---|---|---|
url
|
字符串 | 运行中的 NICE DCV 服务器的主机名和端口格式如下:https://dcv_host_address:port . 例如:https://my-dcv-server:8443 . |
callbacks
|
验证回调 | 在身份验证过程中可以调用的回调。 |
返回值:
-身份验证对象。
- 类型
连接(配置)→ {Promise。 <Connection>| 承诺。 < {代码: ConnectionError代码,消息:字符串} >}
连接到指定的 NICE DCV 服务器端点。如果连接成功,它将返回 Connection 对象。如果连接失败,它会返回错误对象。
参数:
名称 | 类型 | 说明 |
---|---|---|
config
|
ConnectionConfig | ConnectionConfig 对象。 |
返回值:
-连接对象或错误对象。
- 类型
-
承诺。 <Connection> | 承诺。 < {代码: ConnectionError代码,消息:string} >
setLogHandler(处理程序)→ {void}
设置自定义日志处理程序函数。覆盖默认日志处理程序时,使用浏览器控制台进行调试时,原始日志条目的位置将丢失。
参数:
名称 | 类型 | 说明 |
---|---|---|
handler
|
函数 | 自定义日志处理程序函数。处理函数包含级别(数字)、LevelName(字符串)、域(字符串)和消息(字符串)。 |
返回值:
- 类型
-
void
setLogLevel(级别)→ {void}
设置日志级别。只有在使用默认日志处理程序时必需。
参数:
名称 | 类型 | 说明 |
---|---|---|
level
|
LogLevel | 要使用的日志级别。 |
返回值:
- 类型
-
void
成员
列表
- (常量)AudioError:AudioError代码
- (常量)AuthenticationError:AuthenticationError代码
- (常量)ChannelError:ChannelError代码
- (常量)ClosingReasonError:ClosingReasonErrorCode
- (常量)ConnectionError:ConnectionError代码
- (常量)CustomChannelError:CustomChannelErrorCode
- (常量)DisplayConfigError:DisplayConfigErrorCode
- (常量)FileStorageError:FileStorageErrorCode
- (常量)LogLevel:LogLevel
- (常量)MultiMonitorError:MultiMonitorErrorCode
- (常量)ResolutionError:ResolutionError代码
- (常量)版本
- (常量)WebcamError:WebcamError代码
(常量)AudioError:AudioError代码
这些区域有:AudioError枚举。
类型:
(常量)AuthenticationError:AuthenticationError代码
这些区域有:AuthenticationError枚举。
类型:
(常量)ChannelError:ChannelError代码
这些区域有:ChannelError枚举。
类型:
(常量)ClosingReasonError:ClosingReasonErrorCode
这些区域有:ClosingReason错误代码枚举。
类型:
(常量)ConnectionError:ConnectionError代码
这些区域有:ConnectionError枚举。
类型:
(常量)CustomChannelError:CustomChannelErrorCode
这些区域有:CustomChannel错误代码枚举。
类型:
(常量)DisplayConfigError:DisplayConfigErrorCode
这些区域有:DisplayConfig错误代码枚举。
类型:
(常量)FileStorageError:FileStorageErrorCode
这些区域有:FileStorage错误代码枚举。
类型:
(常量)LogLevel:LogLevel
可用的 SDK 日志级别。
类型:
(常量)MultiMonitorError:MultiMonitorErrorCode
这些区域有:MultiMonitor错误代码枚举。
类型:
(常量)ResolutionError:ResolutionError代码
这些区域有:ResolutionError枚举。
类型:
(常量)版本
NICE DCV 版本包含主要版、次要版本、修补程序、修订版、扩展版和 version Strr。
属性:
名称 | 类型 | 说明 |
---|---|---|
major
|
integer | 主要版本号。 |
minor
|
integer | 次要版本号。 |
patch
|
integer | 修补程序版本号。 |
revision
|
integer | 修订版号。 |
extended
|
字符串 | 扩展的字符串。 |
versionStr
|
字符串 | 表单中的主要、次要、修补程序和修订版号的连接major.minor.patch+build.revision . |
(常量)WebcamError:WebcamError代码
这些区域有:WebcamError枚举。
类型:
类型和回调定义
列表
- AudioError代码
- 验证回调
- AuthenticationError代码
- authErrorCallback(身份验证,错误)
- authPromptCredentials回调(身份验证、质询)
- authSuccessCallback(身份验证、身份验证数据)
- 通道
- ChannelError代码
- clipboardEventCallback(事件)
- ClosingReasonErrorCode
- ColorSpace
- 连接回调
- ConnectionConfig
- ConnectionError代码
- 创建目录(路径)
- CustomChannelErrorCode
- dataChannelCallback(信息)
- Delete 文件(路径)
- deviceChangeEvent回调 ()
- 断开回调(原因)
- displayAvailabilityCallback(状态,DisplayID)
- DisplayConfigErrorCode
- displayLayoutCallback(服务器宽度、ServerHeight、头)
- 功能
- featuresUpdateCallback(功能列表)
- fileDownloadCallback(文件资源)
- filePrintedCallback(PrintResource)
- 文件存储
- filestorageEnabledCallback(启用)
- FileStorageErrorCode
- firstFrameCallback(已启用调整大小,relativeMouseMode已启用,DisplayID)
- idleWarningNotification回调 (disconnectionDateTime)
- collaboratorListCallback(合作者)
- licenseNotificationCallback(通知)
- 列表(路径)
- LogLevel
- 监控
- MultiMonitorErrorCode
- qualityIndicatorState回调(状态)
- 重命名目录(src、dest)
- 重命名文件(src、dest)
- ResolutionError代码
- 检索文件(路径)
- ScreenShot 回调(截图)
- ServerInfo
- stats
- StoreFile(文件、目录)
- WebcamError代码
AudioError代码
这些区域有:AudioErrorDCV 模块中可用的代码枚举
-
SETTING_AUDIO_FAILED
-
CHANNEL_NOT_AVAILABLE
类型:
-
number
验证回调
身份验证回调
类型:
-
对象
属性:
名称 | 类型 | 说明 |
---|---|---|
promptCredentials
|
authPromptCredentials回调 | 当用户要求凭据受到质疑时要调用的回调函数。 |
error
|
authErrorCallback | 身份验证失败时要调用的回调函数。 |
success
|
authSuccessCallback | 身份验证成功时要调用的回调函数。 |
AuthenticationError代码
这些区域有:AuthenticationErrorDCV 模块中可用的代码枚举
-
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 和身份验证令牌。
|
通道
可以指定的可用频道。
类型:
-
“剪贴板” | “显示” | “输入” | “音频” | “文件存储”
ChannelError代码
这些区域有:ChannelErrorDCV 模块中可用的代码枚举
-
ALREADY_OPEN
-
INITIALIZATION_FAILED
-
REJECTED
类型:
-
number
clipboardEventCallback(事件)
当clipboardEvent
生成。
参数:
名称 | 类型 | 说明 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
event
|
对象 | 有关剪贴板事件的信息。
|
ClosingReasonErrorCode
这些区域有:ClosingReasonDCV 模块中可用的错误代码枚举
-
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
类型:
-
number
ColorSpace
可以指定的可用色彩空间。
类型:
-
“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 客户端 SDK 1.1.0 版起)。 |
qualityIndicatorState
|
qualityIndicatorState回调 | 连接质量指示器改变状态时要调用的回调函数。 |
filestorageEnabled
|
filestorageEnabledCallback | 启用或禁用文件存储时要调用的回调函数。 |
featuresUpdate
|
featuresUpdateCallback | 要在功能状态发生变化时调用的回调函数。 |
clipboardEvent
|
clipboardEventCallback | 当clipboardEvent 生成。 |
deviceChangeEvent
|
deviceChangeEvent回调 | 当deviceChange 触发事件。 |
screenshot
|
屏幕截图回调 | 当screenshot 可用。 |
ConnectionConfig
NICE DCV 连接的配置。
类型:
-
对象
属性:
名称 | 类型 | 说明 |
---|---|---|
url
|
字符串 | 运行中的 NICE DCV 服务器的主机名和端口格式如下:https://dcv_host_address:port . 例如:https://my-dcv-server:8443 . |
sessionId
|
字符串 | 漂亮的 DCV 会话 ID。 |
authToken
|
字符串 | 连接到服务器时使用的身份验证令牌。 |
baseUrl
|
字符串 | 从中加载 SDK 文件的绝对或相对 URL。 |
resourceBaseUrl
|
字符串 | 用于访问 DCV 资源的绝对或相对 URL。 |
enabledChannels
|
数组。 <Channel> | 表示可以启用的频道列表。如果未指定或提供空阵列,则默认为所有可用频道。 |
losslessColorspace
|
ColorSpace | 表示将使用的色彩空间。如果未指定,则默认为 “RGB”。 |
divId
|
字符串 | 的 IDdiv HTML DOM 中的对象,其中 SDK 应该使用远程流创建画布。 |
volumeLevel
|
integer | 首选的音量级别。有效范围为 0 至 100。 |
clipboardAutoSync
|
布尔值 | 指示兼容的 Web 浏览器是否启用了从 NICE DCV 会话剪贴板到本地客户端剪贴板的自动复制功能。 |
dynamicAudioTuning
|
布尔值 | 指示建立连接时是否根据 NICE DCV 服务器音频设置动态调整音频。 |
clientHiDpiScaling
|
布尔值 | 指示是否根据客户的 DPI 缩放画布。 |
highColorAccuracy
|
布尔值 | 指示是否应使用高色彩准确度(如果可用)。如果未指定,则默认为false . |
enableWebCodecs
|
布尔值 | 指示是否WebCodecs如果可用,应使用。如果未指定,则默认为 false 。 |
observers
|
连接回调 | 用于调用与连接相关的事件的回调函数。 |
callbacks
|
连接回调 | 与observers 属性,但是每个回调都包括Connection对象作为第一个参数。 |
ConnectionError代码
这些区域有:ConnectionErrorDCV 模块中可用的代码枚举
-
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
这些区域有:CustomChannelDCV 模块中可用的错误代码枚举
-
TRANSPORT_ERROR
类型:
-
number
dataChannelCallback(信息)
NICE DCV 服务器发送有关数据通道可用性的通知时要调用的回调函数。
参数:
名称 | 类型 | 说明 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
info
|
对象 | 有关数据通道的信息。
|
Delete 文件(路径)
参数:
名称 | 类型 | 说明 |
---|---|---|
path
|
字符串 | 服务器上标识我们要删除的文件的绝对路径。 |
deviceChangeEvent回调 ()
当deviceChange
触发事件。
断开回调(原因)
连接结束时调用的回调函数。
参数:
名称 | 类型 | 说明 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
reason
|
对象 | 断开连接的原因。
|
displayAvailabilityCallback(状态,DisplayID)
显示器的可用性发生变化时要调用的回调函数。
参数:
名称 | 类型 | 说明 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
status
|
对象 | 显示器的状态。
|
|||||||||
displayId
|
number | 显示器的标识符。 |
DisplayConfigErrorCode
这些区域有:DisplayConfigDCV 模块中可用的错误代码枚举
-
INVALID_ARGUMENT
-
UNSUPPORTED_OPERATION
-
NO_CHANNEL
类型:
-
number
displayLayoutCallback(服务器宽度、ServerHeight、头)
更改显示布局或分辨率时要调用的回调函数。
参数:
名称 | 类型 | 描述 |
---|---|---|
serverWidth
|
number | 主显示器的宽度 (像素)。 |
serverHeight
|
number | 主显示器的高度 (像素)。 |
heads
|
数组。 <显示器> | NICE DCV 服务器支持的显示头。 |
功能
功能值。
-
display
-表示单显示器视频流的可用性。 -
display-multi
-表示多显示器视频流的可用性。 -
high-color-accuracy
-表示色彩准确度高(自 NICE DCV Web 客户端 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 服务器的文件上传功能的可用性。
类型:
-
字符串
featuresUpdateCallback(功能列表)
要在功能状态发生变化时调用的回调函数。
参数:
名称 | 类型 | 说明 |
---|---|---|
featuresList
|
数组。 <功能> | 一系列已更改的功能。 |
fileDownloadCallback(文件资源)
准备好从 NICE DCV 服务器下载文件时要调用的回调函数。
参数:
名称 | 类型 | 说明 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fileResource
|
对象 | 有关可供下载的文件的信息。
|
filePrintedCallback(PrintResource)
在 NICE DCV 服务器上打印文件时要调用的回调函数。
参数:
名称 | 类型 | 说明 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
printResource
|
对象 | 有关打印文件的信息。
|
文件存储
允许在文件系统上探索和执行操作的对象。
类型:
-
对象
属性:
名称 | 类型 | 说明 |
---|---|---|
list
|
列表 | 允许列出服务器上提供的路径上存在的项目(文件和目录)的函数。 |
createDirectory
|
创建目录 | 允许在服务器上指定路径上创建目录的函数。 |
retrieveFile
|
检索文件 | 允许在服务器上指定路径本地下载文件的函数。 |
deleteFile
|
DeleteFile | 允许删除服务器上指定路径处的文件的函数。 |
renameFile
|
重命名文件 | 允许将文件从指定源路径重命名到指定目标路径的函数。 |
renameDirectory
|
重命名目录 | 允许将目录从指定源路径重命名为绝对目标路径的函数。 |
storeFile
|
存储文件 | 允许将本地文件上传到服务器上提供的路径的函数。 |
filestorageEnabledCallback(启用)
启用文件存储时要调用的回调函数。仅限 Internet Explorer 11 上的懒惰频道。
参数:
名称 | 类型 | 说明 |
---|---|---|
enabled
|
布尔值 | 指示是否启用了文件存储。 |
FileStorageErrorCode
这些区域有:FileStorageDCV 模块中可用的错误代码枚举
-
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 日志级别。
类型:
-
TRACE | 调试 | 信息 | 警告 | 错误 | 静音
监控
类型:
-
对象
属性:
名称 | 类型 | 说明 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
字符串 | 显示头的名称。 | |||||||||||||||
rect
|
对象 | 有关显示头的信息。
|
|||||||||||||||
primary
|
布尔值 | 指示显示头是否为主显示头。这取决于远程操作系统(如果可用)。 | |||||||||||||||
dpi
|
number | 显示头的 DPI。 |
MultiMonitorErrorCode
这些区域有:MultiMonitorDCV 模块中可用的错误代码枚举
-
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
|
字符串 | 服务器上指定目标路径和文件名的绝对目标路径。 |
ResolutionError代码
这些区域有:ResolutionErrorDCV 模块中可用的代码枚举
-
INVALID_ARGUMENT
-
NO_CHANNEL
类型:
-
number
检索文件(路径)
参数:
名称 | 类型 | 说明 |
---|---|---|
path
|
字符串 | 服务器上标识我们要在本地下载的文件的绝对路径。 |
ScreenShot 回调(截图)
截图可用时要调用的回调函数。
参数:
名称 | 类型 | 说明 |
---|---|---|
screenshot
|
byte[] | PNG 格式的屏幕截图缓冲区,或null 如果屏幕截图检索失败。 |
ServerInfo
类型:
-
对象
属性:
名称 | 类型 | 说明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name
|
字符串 | 软件的名称。 | ||||||||||||
version
|
对象 | 软件版本号。
|
||||||||||||
os
|
字符串 | 操作系统。 | ||||||||||||
arch
|
字符串 | 架构。 | ||||||||||||
hostname
|
字符串 | 主机名。 |
stats
类型:
-
对象
属性:
名称 | 类型 | 描述 |
---|---|---|
fps
|
number | 每秒当前帧数。 |
traffic
|
number | 当前流量(以位/秒为单位)。 |
peakTraffic
|
number | 自连接建立以来的流量峰值(以位/秒为单位)。 |
latency
|
number | 当前延迟(以毫秒为单位)。 |
currentChannels
|
number | 自建立连接以来已打开的频道数。 |
openedChannels
|
number | 当前打开的频道数。 |
channelErrors
|
number | 报告错误的频道数。 |
StoreFile(文件、目录)
参数:
名称 | 类型 | 说明 |
---|---|---|
file
|
文件 | 我们想要上传到服务器的文件对象(有关更多信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/API/File)。 |
dir
|
字符串 | 我们要上传文件的服务器上的绝对路径。 |
WebcamError代码
这些区域有:WebcamErrorDCV 模块中可用的代码枚举
-
SETTING_WEBCAM_FAILED
-
CHANNEL_NOT_AVAILABLE
类型:
-
number