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

DCV模块

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

方法

authenticate(url, callbacks) → {Authentication}

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

参数：

返回值:

- Authentication 对象。

连接（配置）→ {承诺。 < 连接 >|承诺。 < {code: ConnectionErrorCode，消息：字符串} >}

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

参数：

返回值:

- Connection 对象或错误对象。

setLogHandler（处理程序）→ {void}

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

参数：

返回值:

setLogLevel（等级）→ {无效}

设置日志级别。只有在使用默认日志处理程序时，才需要使用该方法。

参数：

返回值:

成员

（常量） 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 代码枚举。

类型：

(constant) version

Amazon DCV 版本包含主要版本、次要版本、补丁版、修订版、扩展版和versionStr。

属性：

（常量） ScreenshotError：ScreenshotErrorCode

ScreenshotError 代码枚举。

类型：

（常量） WebcamError：WebcamErrorCode

WebcamError 代码枚举。

类型：

类型和回调定义

AudioErrorCode

模块中可用的 AudioError 代码枚举 DCV

类型：

authenticationCallbacks

身份验证回调

类型：

属性：

AuthenticationErrorCode

模块中可用的 AuthenticationError 代码枚举 DCV

类型：

authErrorCallback（身份验证，错误）

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

参数：

authPromptCredentials回调（身份验证、质询）

在询问用户凭证时调用的回调函数。用户必须提供请求的凭证以回答质询。

参数：

authSuccessCallback（身份验证，authenticationData）

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

参数：

频道

可以指定的可用通道。

类型：

ChannelErrorCode

模块中可用的 ChannelError 代码枚举 DCV

类型：

clipboardEventCallback（事件）

在生成 clipboardEvent 时调用的回调函数。

参数：

ClosingReasonErrorCode

模块中可用的 ClosingReasonError 代码枚举 DCV

类型：

Colorspace

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

类型：

connectionCallbacks

在出现连接错误时可调用的回调。

类型：

属性：

ConnectionConfig

Amazon DCV 连接的配置。

类型：

属性：

ConnectionErrorCode

模块中可用的 ConnectionError 代码枚举 DCV

类型：

createDirectory（路径）

参数：

CustomChannelErrorCode

模块中可用的 CustomChannelError 代码枚举 DCV

类型：

dataChannelCallback（信息）

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

参数：

deleteFile（路径）

参数：

deviceChangeEvent回调 ()

在触发 deviceChange 事件时调用的回调函数。

disconnectCallback（原因）

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

参数：

displayAvailabilityCallback（状态，displayId）

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

参数：

DisplayConfigErrorCode

模块中可用的 DisplayConfigError 代码枚举 DCV

类型：

displayLayoutCallback(serverWidth,serverHeight, 头)

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

参数：

feature

功能值。

类型：

featuresUpdateCallback(featuresList)

在功能状态发生变化时调用的回调函数。

参数：

fileDownloadCallback(fileResource)

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

参数：

filePrintedCallback(printResource)

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

参数：

filestorage

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

类型：

属性：

filestorageEnabledCallback（已启用）

在启用文件存储时调用的回调函数。仅 Internet Explorer 11 上的延迟通道。

参数：

FileStorageErrorCode

模块中可用的 FileStorageError 代码枚举 DCV

类型：

firstFrameCallback(resizeEnabled， relativeMouseMode已启用，displayId)

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

参数：

idleWarningNotification回调 (disconnectionDateTime)

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

参数：

collaboratorListCallback（合作者）

Amazon DCV 服务器发送合作者列表时要调用的回调函数。

参数：

licenseNotificationCallback（通知）

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

参数：

list(path)

参数：

LogLevel

可用的SDK日志级别。

类型：

监控

类型：

属性：

MultiMonitorErrorCode

模块中可用的 MultiMonitorError 代码枚举 DCV

类型：

qualityIndicatorState回调（状态）

在连接质量指标改变状态时调用的回调函数。

参数：

renameDirectory（src，dest）

参数：

renameFile（src，dest）

参数：

ResolutionErrorCode

模块中可用的 ResolutionError 代码枚举 DCV

类型：

retrieveFile（路径）

参数：

screenshotCallback（屏幕截图）

在屏幕截图可用时调用的回调函数。

参数：

ScreenshotErrorCode

模块中可用的 ScreenshotError 代码枚举 DCV

类型：

serverInfo

类型：

属性：

stats

类型：

属性：

storeFile（文件，目录）

参数：

TimezoneRedirectionErrorCode

模块中可用的 TimezoneRedirectionError 代码枚举 DCV

类型：

TimezoneRedirectionSettingCode

模块中可用的 TimezoneRedirectionSetting 代码枚举 DCV

类型：

TimezoneRedirectionStatusCode

模块中可用的 TimezoneRedirectionStatus 代码枚举 DCV

类型：

WebcamErrorCode

模块中可用的 WebcamError 代码枚举 DCV

类型：