本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # DCV 模块 DCV 模块 实施 DCV 协议客户端的模块。 **Topics** + [ ## 方法 ](#methods) + [ ## 成员 ](#members) + [ ## 类型和回调定义 ](#type-definitions) ## 方法 **Topics** + [ ### authenticate(authParams) → \$1[Authentication](authentication-class.md)\$1 ](#authenticate) + [ ### 连接（配置）→ \$1承诺。 < C [onnection](connection-class.md) >\$1承诺。 < \$1code: [ConnectionErrorCode](#ConnectionErrorCode)，消息：字符串\$1 >\$1 ](#connect) + [ ### setLogHandler（处理程序）→ \$1void\$1 ](#setLogHandler) + [ ### setLogLevel（等级）→ \$1无效\$1 ](#setLogLevel) ### authenticate(authParams) → \$1[Authentication](authentication-class.md)\$1 启动指定的 Amazon DCV 服务器端点的身份验证过程。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | url | 字符串 | 运行的 Amazon DCV 服务器的主机名和端口，格式如下所示：https://dcv\$1host\$1address:port。例如：https://my-dcv-server:8443。 | | authenticationToken | 字符串 | 用于身份验证的身份验证令牌。 | | callbacks | [authenticationCallbacks](#authenticationCallbacks) | 在身份验证过程中可调用的回调。 | #### 返回值: - Authentication 对象。 Type [身份验证](authentication-class.md) ### 连接（配置）→ \$1承诺。 < C [onnection](connection-class.md) >\$1承诺。 < \$1code: [ConnectionErrorCode](#ConnectionErrorCode)，消息：字符串\$1 >\$1 连接到指定的 Amazon DCV 服务器端点。如果连接成功，则返回一个 Connection 对象。如果连接失败，则返回一个错误对象。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | config | [ConnectionConfig](#ConnectionConfig) | ConnectionConfig 对象。 | #### 返回值: - Connection 对象或错误对象。 Type 承诺。 < [连接](connection-class.md) > \$1 承诺。 < \$1code: [ConnectionErrorCode](#ConnectionErrorCode)，消息：字符串\$1 > ### setLogHandler（处理程序）→ \$1void\$1 设置自定义日志处理函数。如果覆盖默认日志处理程序，在使用浏览器控制台调试时，原始日志条目位置将丢失。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | handler | 函数 | 自定义日志处理函数。处理函数包含 level（数字）、levelName（字符串）、domain（字符串）和 message（字符串）。 | #### 返回值: Type void ### setLogLevel（等级）→ \$1无效\$1 设置日志级别。只有在使用默认日志处理程序时，才需要使用该方法。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | level | [LogLevel](#LogLevel) | 要使用的日志级别。 | #### 返回值: Type void ## 成员 **Topics** + [ ### （常量） AudioError ：[AudioErrorCode](#AudioErrorCode) ](#AudioError) + [ ### （常量） AuthenticationError ：[AuthenticationErrorCode](#AuthenticationErrorCode) ](#AuthenticationError) + [ ### （常量） ChannelError ：[ChannelErrorCode](#ChannelErrorCode) ](#ChannelError) + [ ### （常量） ClosingReasonError ：[ClosingReasonErrorCode](#ClosingReasonErrorCode) ](#ClosingReasonError) + [ ### （常量） ConnectionError ：[ConnectionErrorCode](#ConnectionErrorCode) ](#ConnectionError) + [ ### （常量） CustomChannelError ：[CustomChannelErrorCode](#CustomChannelErrorCode) ](#CustomChannelError) + [ ### （常量） DisplayConfigError ：[DisplayConfigErrorCode](#DisplayConfigErrorCode) ](#DisplayConfigError) + [ ### （常量） FileStorageError ：[FileStorageErrorCode](#FileStorageErrorCode) ](#FileStorageError) + [ ### （常量） LogLevel ：[LogLevel](#LogLevel) ](#LogLevel_) + [ ### （常量） MultiMonitorError ：[MultiMonitorErrorCode](#MultiMonitorErrorCode) ](#MultiMonitorError) + [ ### （常量） ResolutionError ：[ResolutionErrorCode](#ResolutionErrorCode) ](#ResolutionError) + [ ### （常量） TimezoneRedirectionError ：[TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) ](#TimezoneRedirectionError) + [ ### （常量） TimezoneRedirectionSetting ：[TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) ](#TimezoneRedirectionSetting) + [ ### （常量） TimezoneRedirectionStatus ：[TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) ](#TimezoneRedirectionStatus) + [ ### (constant) version ](#version) + [ ### （常量） ScreenshotError ：[ScreenshotErrorCode](#ScreenshotErrorCode) ](#ScreenshotError) + [ ### （常量） WebcamError ：[WebcamErrorCode](#WebcamErrorCode) ](#WebcamError) ### （常量） AudioError ：[AudioErrorCode](#AudioErrorCode) AudioError 代码枚举。 #### 类型： + [AudioErrorCode](#AudioErrorCode) ### （常量） AuthenticationError ：[AuthenticationErrorCode](#AuthenticationErrorCode) AuthenticationError 代码枚举。 #### 类型： + [AuthenticationErrorCode](#AuthenticationErrorCode) ### （常量） ChannelError ：[ChannelErrorCode](#ChannelErrorCode) ChannelError 代码枚举。 #### 类型： + [ChannelErrorCode](#ChannelErrorCode) ### （常量） ClosingReasonError ：[ClosingReasonErrorCode](#ClosingReasonErrorCode) ClosingReasonError 代码枚举。 #### 类型： + [ClosingReasonErrorCode](#ClosingReasonErrorCode) ### （常量） ConnectionError ：[ConnectionErrorCode](#ConnectionErrorCode) ConnectionError 代码枚举。 #### 类型： + [ConnectionErrorCode](#ConnectionErrorCode) ### （常量） CustomChannelError ：[CustomChannelErrorCode](#CustomChannelErrorCode) CustomChannelError 代码枚举。 #### 类型： + [CustomChannelErrorCode](#CustomChannelErrorCode) ### （常量） DisplayConfigError ：[DisplayConfigErrorCode](#DisplayConfigErrorCode) DisplayConfigError 代码枚举。 #### 类型： + [DisplayConfigErrorCode](#DisplayConfigErrorCode) ### （常量） FileStorageError ：[FileStorageErrorCode](#FileStorageErrorCode) FileStorageError 代码枚举。 #### 类型： + [FileStorageErrorCode](#FileStorageErrorCode) ### （常量） LogLevel ：[LogLevel](#LogLevel) 可用的 SDK 日志级别。 #### 类型： + [LogLevel](#LogLevel) ### （常量） MultiMonitorError ：[MultiMonitorErrorCode](#MultiMonitorErrorCode) MultiMonitorError 代码枚举。 #### 类型： + [MultiMonitorErrorCode](#MultiMonitorErrorCode) ### （常量） ResolutionError ：[ResolutionErrorCode](#ResolutionErrorCode) ResolutionError 代码枚举。 #### 类型： + [ResolutionErrorCode](#ResolutionErrorCode) ### （常量） TimezoneRedirectionError ：[TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) TimezoneRedirectionError 代码枚举。 #### 类型： + [TimezoneRedirectionErrorCode](#TimezoneRedirectionErrorCode) ### （常量） TimezoneRedirectionSetting ：[TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) TimezoneRedirectionSetting 代码枚举。 #### 类型： + [TimezoneRedirectionSettingCode](#TimezoneRedirectionSettingCode) ### （常量） TimezoneRedirectionStatus ：[TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) TimezoneRedirectionStatus 代码枚举。 #### 类型： + [TimezoneRedirectionStatusCode](#TimezoneRedirectionStatusCode) ### (constant) version 带有 major、minor、patch、revision、extended 和 versionStr 的 Amazon DCV 版本。 #### 属性： | Name | Type | 说明 | | --- | --- | --- | | major | 整数 | 主要版本号。 | | minor | 整数 | 次要版本号。 | | patch | 整数 | 补丁版本号。 | | revision | 整数 | 修订号。 | | extended | 字符串 | 扩展的字符串。 | | versionStr | 字符串 | 串联的主要版本号、次要版本号、补丁号和修订号，形式为 major.minor.patch\$1build.revision。 | ### （常量） ScreenshotError ：[ScreenshotErrorCode](#ScreenshotErrorCode) ScreenshotError 代码枚举。 #### 类型： + [ScreenshotErrorCode](#ScreenshotErrorCode) ### （常量） WebcamError ：[WebcamErrorCode](#WebcamErrorCode) WebcamError 代码枚举。 #### 类型： + [WebcamErrorCode](#WebcamErrorCode) ## 类型和回调定义 **Topics** + [ ### AudioErrorCode ](#AudioErrorCode) + [ ### authenticationCallbacks ](#authenticationCallbacks) + [ ### AuthenticationErrorCode ](#AuthenticationErrorCode) + [ ### authErrorCallback（身份验证，错误） ](#authErrorCallback) + [ ### authPromptCredentials回调（身份验证、质询） ](#authPromptCredentialsCallback) + [ ### authSuccessCallback（身份验证、身份验证数据） ](#authSuccessCallback) + [ ### 频道 ](#Channel) + [ ### ChannelErrorCode ](#ChannelErrorCode) + [ ### clipboardEventCallback（事件） ](#clipboardEventCallback) + [ ### ClosingReasonErrorCode ](#ClosingReasonErrorCode) + [ ### Colorspace ](#Colorspace) + [ ### connectionCallbacks ](#connectionCallbacks) + [ ### ConnectionConfig ](#ConnectionConfig) + [ ### ConnectionErrorCode ](#ConnectionErrorCode) + [ ### createDirectory(path) ](#createDirectory) + [ ### CustomChannelErrorCode ](#CustomChannelErrorCode) + [ ### dataChannelCallback（信息） ](#dataChannelCallback) + [ ### deleteFile(path) ](#deleteFile) + [ ### deviceChangeEvent回调 () ](#deviceChangeEventCallback) + [ ### disconnectCallback(reason) ](#disconnectCallback) + [ ### displayAvailabilityCallback（状态，displayID） ](#displayAvailabilityCallback) + [ ### DisplayConfigErrorCode ](#DisplayConfigErrorCode) + [ ### displayLayoutCallback（服务器宽度、服务器高度、Heads） ](#displayLayoutCallback) + [ ### feature ](#feature) + [ ### featuresUpdateCallback（功能列表） ](#featuresUpdateCallback) + [ ### fileDownloadCallback（文件资源） ](#fileDownloadCallback) + [ ### filePrintedCallback（打印资源） ](#filePrintedCallback) + [ ### filestorage ](#filestorage) + [ ### filestorageEnabledCallback（已启用） ](#filestorageEnabledCallback) + [ ### FileStorageErrorCode ](#FileStorageErrorCode) + [ ### firstFrameCallback（启用调整大小、已启用、disp relativeMouseMode layID） ](#firstFrameCallback) + [ ### idleWarningNotification回调 (disconnectionDateTime) ](#idleWarningNotificationCallback) + [ ### collaboratorListCallback（合作者） ](#collaboratorListCallback) + [ ### licenseNotificationCallback（通知） ](#licenseNotificationCallback) + [ ### list(path) ](#list) + [ ### LogLevel ](#LogLevel) + [ ### 监控 ](#Monitor) + [ ### MultiMonitorErrorCode ](#MultiMonitorErrorCode) + [ ### qualityIndicatorState回调（状态） ](#qualityIndicatorStateCallback) + [ ### renameDirectory(src, dest) ](#renameDirectory) + [ ### renameFile(src, dest) ](#renameFile) + [ ### ResolutionErrorCode ](#ResolutionErrorCode) + [ ### retrieveFile(path) ](#retrieveFile) + [ ### screenshotCallback(screenshot) ](#screenshotCallback) + [ ### ScreenshotErrorCode ](#ScreenshotErrorCode) + [ ### serverInfo ](#serverInfo) + [ ### stats ](#stats) + [ ### storeFile(file, dir) ](#storeFile) + [ ### TimezoneRedirectionErrorCode ](#TimezoneRedirectionErrorCode) + [ ### TimezoneRedirectionSettingCode ](#TimezoneRedirectionSettingCode) + [ ### TimezoneRedirectionStatusCode ](#TimezoneRedirectionStatusCode) + [ ### WebcamErrorCode ](#WebcamErrorCode) + [ ### httpExtraSearchParamsCallback（方法、网址、正文） ](#httpExtraSearchParamsCallback) + [ ### httpExtraHeaders回调（方法、网址、正文） ](#httpExtraHeadersCallback) ### AudioErrorCode DCV 模块中可用的 AudioError 代码枚举 + `SETTING_AUDIO_FAILED` + `CHANNEL_NOT_AVAILABLE` #### 类型： + 数字 ### authenticationCallbacks 身份验证回调 #### 类型： + 对象 #### 属性： | Name | Type | 说明 | | --- | --- | --- | | promptCredentials | [authPromptCredentials回调](#authPromptCredentialsCallback) | 在询问用户凭证时调用的回调函数。 | | error | [authErrorCallback](#authErrorCallback) | 在身份验证失败时调用的回调函数。 | | success | [authSuccessCallback](#authSuccessCallback) | 在身份验证成功时调用的回调函数。 | | httpExtraSearchParamsCallback | [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback) | 要在 authenticate 方法中调用的回调函数，用于在发起请求之前将自定义查询参数注入身份验证 URL。它还可以在connect方法中用于自定义建立与 DCV 服务器的 WebSocket 连接时使用的 URL。 | ### 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` #### 类型： + 数字 ### authErrorCallback（身份验证，错误） 在身份验证失败时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | authentication | [身份验证](authentication-class.md) | Authentication 对象。 | | error | 对象 | 身份验证过程引发的错误对象。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | code | [AuthenticationErrorCode](#AuthenticationErrorCode) | 错误代码。 | | message | 字符串 | 错误消息。 | ### authPromptCredentials回调（身份验证、质询） 在询问用户凭证时调用的回调函数。用户必须提供请求的凭证以回答质询。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | authentication | [身份验证](authentication-class.md) | Authentication 对象。 | | challenge | 对象 | 质询。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | requiredCredentials | Array. | 请求的凭证对象的数组。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | name | 字符串 | 请求的凭证的名称。 | | type | 字符串 | 请求的凭证的类型。 | ### authSuccessCallback（身份验证、身份验证数据） 在身份验证成功时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | authentication | [身份验证](authentication-class.md) | Authentication 对象。 | | authenticationData | Array. | 包含 Amazon DCV 会话 IDs 和身份验证令牌的对象数组。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | sessionId | 字符串 | Amazon DCV 会话 ID。 | | authToken | 字符串 | Amazon DCV 会话的身份验证令牌。 | ### 频道 可以指定的可用通道。 #### 类型： + "clipboard" \$1 "display" \$1 "input" \$1 "audio" \$1 "filestorage" ### ChannelErrorCode DCV 模块中可用的 ChannelError 代码枚举 + `ALREADY_OPEN` + `INITIALIZATION_FAILED` + `REJECTED` #### 类型： + 数字 ### clipboardEventCallback（事件） 在生成 `clipboardEvent` 时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 属性 | 说明 | | --- | --- | --- | --- | | event | 对象 | 有关剪贴板事件的信息。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | name | 已建立 \$1 复制 \$1 粘贴 \$1 \$1 \$1 dataSizeAlert \$1 autoCopyDone newDataAvailable \$1 RemoteError autoPasteDone \$1 pasteAvailableData | | 始终存在。事件名称。 | | clipboardData | Object \$1 string | | 剪贴板中的数据。 | | autoCopy | 布尔值 | <可选> | 指示是否启用从会话剪贴板到本地客户端剪贴板的自动复制。 | | maxDataSize | 数字 | <可选> | 可以在剪贴板中放置的最大数据量。 | | error | 字符串 | <可选> | 错误信息（如果适用）。 | ### 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` + `EXTERNAL_PROTOCOL_CONNECTION_EVICTED` + `DISCONNECTION_REQUESTED` #### 类型： + 数字 ### Colorspace 可以指定的可用色彩空间。 #### 类型： + “RGB” \$1 “YUV\$1” \$1 “YUV\$1REC601” REC709 ### connectionCallbacks 在出现连接错误时可调用的回调。 #### 类型： + 对象 #### 属性： | Name | Type | 说明 | | --- | --- | --- | | disconnect | [disconnectCallback](#disconnectCallback) | 在连接结束时调用的回调函数。 | | displayLayout | [displayLayoutCallback](#displayLayoutCallback) | 在更改显示布局或分辨率时调用的回调函数。 | | displayAvailability | [displayAvailabilityCallback](#displayAvailabilityCallback) | 在显示器的可用性发生变化时调用的回调函数。 | | firstFrame | [firstFrameCallback](#firstFrameCallback) | 从 Amazon DCV 服务器收到第一帧时调用的回调函数。 | | filePrinted | [filePrintedCallback](#filePrintedCallback) | 在 Amazon DCV 服务器上打印文件时调用的回调函数。 | | fileDownload | [fileDownloadCallback](#fileDownloadCallback) | 在准备好从 Amazon DCV 服务器下载文件时调用的回调函数。 | | dataChannel | [dataChannelCallback](#dataChannelCallback) | 在 Amazon DCV 服务器发送有关数据通道可用性的通知时调用的回调函数。 | | licenseNotification | [licenseNotificationCallback](#licenseNotificationCallback) | 在 Amazon DCV 服务器发送有关许可证状态的通知时调用的回调函数。 | | idleWarningNotification | [idleWarningNotification回调](#idleWarningNotificationCallback) | 在 Amazon DCV 服务器发送空闲超时警告时调用的回调函数。 | | collaboratorList | [collaboratorListCallback](#collaboratorListCallback) | 在 Amazon DCV 服务器发送协作者列表时调用的回调函数（自 Amazon DCV Web Client SDK 版本 1.1.0 起）。 | | qualityIndicatorState | [qualityIndicatorState回调](#qualityIndicatorStateCallback) | 在连接质量指标改变状态时调用的回调函数。 | | filestorageEnabled | [filestorageEnabledCallback](#filestorageEnabledCallback) | 在启用或禁用文件存储时调用的回调函数。 | | featuresUpdate | [featuresUpdateCallback](#featuresUpdateCallback) | 在功能状态发生变化时调用的回调函数。 | | clipboardEvent | [clipboardEventCallback](#clipboardEventCallback) | 在生成 clipboardEvent 时调用的回调函数。 | | deviceChangeEvent | [deviceChangeEvent回调](#deviceChangeEventCallback) | 在触发 deviceChange 事件时调用的回调函数。 | | screenshot | [screenshotCallback](#screenshotCallback) | 在 screenshot 可用时调用的回调函数。 | | httpExtraSearchParamsCallback | [httpExtraSearchParamsCallback](#httpExtraSearchParamsCallback) | 建立与 Amazon DCV 服务器的 WebSocket 连接时，用于自定义 URL 的回调函数。请注意，此回调也可以与 authenticate 方法一起使用，以在 SDK 发送请求之前将查询参数动态附加到身份验证 URL。 | | httpExtraHeadersCallback | [httpExtraHeaders回调](#httpExtraHeadersCallback) | 要在连接建立期间调用的回调函数，用于向 HTTP 请求添加自定义标头。 | ### ConnectionConfig Amazon DCV 连接配置。 #### 类型： + 对象 #### 属性： | Name | Type | 说明 | | --- | --- | --- | | url | 字符串 | 运行的 Amazon DCV 服务器的主机名和端口，格式如下所示：https://dcv\$1host\$1address:port。例如：https://my-dcv-server:8443。 | | sessionId | 字符串 | Amazon DCV 会话 ID。 | | authToken | 字符串 | 在连接到服务器时使用的身份验证令牌。 | | baseUrl | 字符串 | 从中加载 SDK 文件的绝对或相对 URL。 | | resourceBaseUrl | 字符串 | 从中访问 DCV 资源的绝对或相对 URL。 | | enabledChannels | Array.<[Channel](#Channel)> | 指示可以启用的通道列表。如果未指定或提供空数组，它默认为所有可用的通道。 | | losslessColorspace | [Colorspace](#Colorspace) | 指示将使用的色彩空间。如果未指定，它默认为“RGB”。 | | divId | 字符串 | HTML DOM 中的 div 对象的 ID，SDK 应在其中使用远程流创建画布。 | | volumeLevel | 整数 | 首选的音量。有效范围是 0 到 100。 | | clipboardAutoSync | 布尔值 | 指示是否为兼容的 Web 浏览器启用从 Amazon DCV 会话剪贴板到本地客户端剪贴板的自动复制。 | | dynamicAudioTuning | 布尔值 | 指示在建立连接时是否根据 Amazon DCV 服务器音频设置动态调整音频。 | | clientHiDpiScaling | 布尔值 | 指示是否根据客户端的 DPI 缩放画布。 | | highColorAccuracy | 布尔值 | 指示是否应使用高色彩精度（如果可用）。如果未指定，它默认为 false。 | | enableWebCodecs | 布尔值 | 表示是否 WebCodecs 应使用（如果有）。如果未指定，则默认为 false。 | | observers | [connectionCallbacks](#connectionCallbacks) | 用于调用与连接相关的事件的回调函数。 | | callbacks | [connectionCallbacks](#connectionCallbacks) | 与 observers 属性相同，但每个回调都包含 [Connection](connection-class.md) 对象以作为第一个参数。 | ### ConnectionErrorCode DCV 模块中可用的 ConnectionError 代码枚举 + `ALREADY_OPEN` + `INVALID_CONFIG` + `INITIALIZATION_FAILED` + `REJECTED` + `MAIN_CHANNEL_ALREADY_OPEN` + `GENERIC_ERROR`（自 DCV Server 2021.0 起） + `INTERNAL_SERVER_ERROR`（自 DCV Server 2021.0 起） + `AUTHENTICATION_FAILED`（自 DCV Server 2021.0 起） + `PROTOCOL_ERROR`（自 DCV Server 2021.0 起） + `INVALID_SESSION_ID`（自 DCV Server 2021.0 起） + `INVALID_CONNECTION_ID`（自 DCV Server 2021.0 起） + `CONNECTION_LIMIT_REACHED`（自 DCV Server 2021.0 起） + `SERVER_UNREACHABLE`（自 DCV Server 2022.1 起） + `GATEWAY_BUSY` + `UNSUPPORTED_CREDENTIAL`（自 DCV Server 2022.2 起） + `TRANSPORT_ERROR` #### 类型： + 数字 ### createDirectory(path) #### 参数： | Name | Type | 说明 | | --- | --- | --- | | path | 字符串 | 我们要在其中创建目录的服务器上的绝对路径。它还应包括目标目录的名称。 | ### CustomChannelErrorCode DCV 模块中可用的 CustomChannelError 代码枚举 + `TRANSPORT_ERROR` #### 类型： + 数字 ### dataChannelCallback（信息） 在 Amazon DCV 服务器发送有关数据通道可用性的通知时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | info | 对象 | 有关数据通道的信息。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | name | 字符串 | 数据通道的名称。 | | token | 字符串 | 数据通道的身份验证令牌。 | ### deleteFile(path) #### 参数： | Name | Type | 说明 | | --- | --- | --- | | path | 字符串 | 服务器上的绝对路径，指定我们要删除的文件。 | ### deviceChangeEvent回调 () 在触发 `deviceChange` 事件时调用的回调函数。 ### disconnectCallback(reason) 在连接结束时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 描述 | | --- | --- | --- | | reason | 对象 | 断开连接原因。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | code | 数字 | 原因代码。 | | message | 字符串 | 原因消息。 | ### displayAvailabilityCallback（状态，displayID） 在显示器的可用性发生变化时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 描述 | | --- | --- | --- | | status | 对象 | 显示器的状态。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | displayId | 数字 | 显示器的标识符。 | | enabled | 布尔值 | 指示是否启用显示器。 | | closed | 布尔值 | 指示显示器是否关闭。 | ### DisplayConfigErrorCode DCV 模块中可用的 DisplayConfigError 代码枚举 + `INVALID_ARGUMENT` + `UNSUPPORTED_OPERATION` + `NO_CHANNEL` #### 类型： + 数字 ### displayLayoutCallback（服务器宽度、服务器高度、Heads） 在更改显示布局或分辨率时调用的回调函数。 #### 参数： | Name | Type | 描述 | | --- | --- | --- | | serverWidth | 数字 | 主显示器的宽度（以像素为单位）。 | | serverHeight | 数字 | 主显示器的高度（以像素为单位）。 | | heads | Array.<[Monitor](#Monitor)> | Amazon DCV 服务器支持的显示头。 | ### feature 功能值。 + `display` - 指示单显示器视频流的可用性。 + `display-multi` - 指示多显示器视频流的可用性。 + `high-color-accuracy` - 指示高色彩精度的可用性（自 Amazon DCV Web Client SDK 版本 1.1.0 起）。 + `mouse` - 指示鼠标功能的可用性。 + `keyboard` - 指示键盘功能的可用性。 + `keyboard-sas` - 指示 SAS 序列（Control \$1 Alt \$1 Delete）功能的可用性。 + `relative-mouse` - 指示相对鼠标模式的可用性。 + `clipboard-copy` - 指示从 Amazon DCV 服务器到客户端的剪贴板复制功能的可用性。 + `clipboard-paste` - 指示从客户端到 Amazon DCV 服务器的剪贴板粘贴功能的可用性。 + `audio-in` - 指示使用麦克风的音频输入功能的可用性。 + `audio-out` - 指示音频播放功能的可用性。 + `webcam` - 指示网络摄像头流功能的可用性。 + `file-download` - 指示从 Amazon DCV 服务器到客户端的文件下载功能的可用性。 + `file-upload` - 指示从客户端到 Amazon DCV 服务器的文件上传功能的可用性。 + `timezone-redirection` - 指示时区重定向功能的可用性（自 Amazon DCV Web Client SDK 版本 1.3.0 起）。 #### 类型： + 字符串 ### featuresUpdateCallback（功能列表） 在功能状态发生变化时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | featuresList | Array.<[feature](#feature)> | 一系列已更改的功能。 | ### fileDownloadCallback（文件资源） 在准备好从 Amazon DCV 服务器下载文件时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | fileResource | 对象 | 有关准备好下载的文件的信息。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | id | 字符串 | 文件的标识符。 | | url | 字符串 | 用于下载文件的 URL。 | | domain | 字符串 | 资源域。 | | token | 字符串 | 用于下载文件的身份验证令牌。该令牌还包含在 URL 中。 | ### filePrintedCallback（打印资源） 在 Amazon DCV 服务器上打印文件时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | printResource | 对象 | 有关打印的文件的信息。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | id | 字符串 | 打印的文件的标识符。 | | url | 字符串 | 用于下载打印的文件的 URL。 | | domain | 字符串 | 资源域。此处为 printer。 | | token | 字符串 | 用于下载打印的文件的身份验证令牌。该令牌还包含在 URL 中。 | ### filestorage 允许在文件系统上浏览和执行操作的对象。 #### 类型： + 对象 #### 属性： | Name | Type | 说明 | | --- | --- | --- | | list | [list](#list) | 该函数允许列出服务器上的提供路径中存在的项目（文件和目录）。 | | createDirectory | [createDirectory](#createDirectory) | 该函数允许在服务器上的指定路径中创建目录。 | | retrieveFile | [retrieveFile](#retrieveFile) | 该函数允许将文件下载到服务器上的指定路径本地。 | | deleteFile | [deleteFile](#deleteFile) | 该函数允许删除服务器上的指定路径中的文件。 | | renameFile | [renameFile](#renameFile) | 该函数允许将文件从指定源路径重命名为指定目标路径。 | | renameDirectory | [renameDirectory](#renameDirectory) | 该函数允许将目录从指定源路径重命名为绝对目标路径。 | | storeFile | [storeFile](#storeFile) | 该函数允许将本地文件上传到服务器上的提供路径。 | ### filestorageEnabledCallback（已启用） 在启用文件存储时调用的回调函数。仅 Internet Explorer 11 上的延迟通道。 #### 参数： | Name | Type | 描述 | | --- | --- | --- | | enabled | 布尔值 | 指示是否启用了文件存储。 | ### FileStorageErrorCode DCV 模块中可用的 FileStorageError 代码枚举 + `CANCELLED` + `ABORTED` + `INVALID_ARGUMENT` + `NOT_IMPLEMENTED` + `ERROR` + `ALREADY_EXIST` + `NOT_FOUND` #### 类型： + 数字 ### firstFrameCallback（启用调整大小、已启用、disp relativeMouseMode layID） 从 Amazon DCV 服务器收到第一帧时调用的回调函数。为每个显示器发出。 #### 参数： | Name | Type | 描述 | | --- | --- | --- | | resizeEnabled | 布尔值 | 指示服务器是否支持调整客户端显示布局的大小。 | | relativeMouseModeEnabled | 布尔值 | 指示服务器是否支持相对鼠标模式。 | | displayId | 数字 | 显示器的标识符。 | ### idleWarningNotification回调 (disconnectionDateTime) 在 Amazon DCV 服务器发送空闲超时警告时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | disconnectionDateTime | 日期 | 断开连接日期和时间。 | ### collaboratorListCallback（合作者） 在 Amazon DCV 服务器发送协作者列表时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | collaborators | Array. | 包含有关协作者的信息的对象列表。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | username | 字符串 | 协作者的用户名。 | | owner | 布尔值 | 指示协作者是否为会话所有者。 | | connectionId | 数字 | 指示服务器为连接分配的 ID。 | ### licenseNotificationCallback（通知） 在 Amazon DCV 服务器发送有关许可证状态的通知时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | notification | 对象 | 通知。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | product | 字符串 | DCV 产品。 | | status | 字符串 | 许可证的状态。 | | message | 字符串 | 消息。 | | leftDays | 数字 | 许可证过期前的天数。 | | isDemo | 布尔值 | 指示许可证是否为演示许可证。 | | numUnlicensed | 数字 | 未许可的连接数。 | | licensingMode | 字符串 | 许可模式。 | | documentationUrl | 字符串 | 文档的 URL。 | ### list(path) #### 参数： | Name | Type | 说明 | | --- | --- | --- | | path | 字符串 | 我们要列出内容的服务器上的绝对路径。 | ### LogLevel 可用的 SDK 日志级别。 #### 类型： + TRACE \$1 DEBUG \$1 INFO \$1 WARN \$1 ERROR \$1 SILENT ### 监控 #### 类型： + 对象 #### 属性： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 描述 | | --- | --- | --- | | name | 字符串 | 显示头的名称。 | | rect | 对象 | 有关显示头的信息。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | primary | 布尔值 | 指示显示头是否为主显示头。这是从远程操作系统（如果可用）中确定的。 | | dpi | 数字 | 显示头的 DPI。 | | x | 数字 | 显示头的初始 x 坐标。 | | y | 数字 | 显示头的初始 y 坐标。 | | width | 数字 | 显示头的宽度（以像素为单位）。 | | height | 数字 | 显示头的高度（以像素为单位）。 | ### MultiMonitorErrorCode DCV 模块中可用的 MultiMonitorError 代码枚举 + `NO_DISPLAY_CHANNEL` + `MAX_DISPLAY_NUMBER_REACHED` + `INVALID_ARGUMENT` + `DISPLAY_NOT_OPENED_BY_SERVER` + `REQUEST_TIMEOUT` + `GENERIC_ERROR` + `NO_ERROR` #### 类型： + 数字 ### qualityIndicatorState回调（状态） 在连接质量指标改变状态时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 说明 | | --- | --- | --- | | state | Array. | 有关连接质量的信息。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | name | 字符串 | 指标的名称。 | | status | NORMAL \$1 WARNING \$1 CRITICAL | 状态描述。 | | changed | 布尔值 | 指示状态是否发生变化。 | ### renameDirectory(src, dest) #### 参数： | Name | Type | 说明 | | --- | --- | --- | | src | 字符串 | 服务器上的绝对源路径，指定我们要重命名的目录。 | | dest | 字符串 | 服务器上的绝对目标路径，指定目标路径和目录名。 | ### renameFile(src, dest) #### 参数： | Name | Type | 说明 | | --- | --- | --- | | src | 字符串 | 服务器上的绝对源路径，指定我们要重命名的文件。 | | dest | 字符串 | 服务器上的绝对目标路径，指定目标路径和文件名。 | ### ResolutionErrorCode DCV 模块中可用的 ResolutionError 代码枚举 + `INVALID_ARGUMENT` + `NO_CHANNEL` + `NOT_IMPLEMENTED` #### 类型： + 数字 ### retrieveFile(path) #### 参数： | Name | Type | 说明 | | --- | --- | --- | | path | 字符串 | 服务器上的绝对路径，指定我们要下载到本地的文件。 | ### screenshotCallback(screenshot) 在屏幕截图可用时调用的回调函数。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | screenshot | byte[] | PNG 格式的屏幕截图缓冲区或 null（如果屏幕截图检索失败）。 | ### ScreenshotErrorCode DCV 模块中可用的 ScreenshotError 代码枚举 + `NO_CHANNEL` + `GENERIC_ERROR` #### 类型： + 数字 ### serverInfo #### 类型： + 对象 #### 属性： | Name | Type | 说明 | | --- | --- | --- | | Name | Type | 描述 | | --- | --- | --- | | name | 字符串 | 软件的名称。 | | version | 对象 | 软件版本号。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_cn/dcv/latest/websdkguide/dcv-module.html) | | os | 字符串 | 操作系统。 | | arch | 字符串 | 架构。 | | hostname | 字符串 | 主机名。 | | major | 数字 | 主要版本号。 | | minor | 数字 | 次要版本号。 | | revision | 数字 | 修订版本号。 | ### stats #### 类型： + 对象 #### 属性： | Name | Type | 描述 | | --- | --- | --- | | fps | 数字 | 当前的每秒帧数。 | | traffic | 数字 | 当前的流量（以位/秒为单位）。 | | peakTraffic | 数字 | 自建立连接以 bit/s 来的流量峰值。 | | latency | 数字 | 当前的延迟（以毫秒为单位）。 | | currentChannels | 数字 | 自建立连接以来打开的通道数。 | | openedChannels | 数字 | 当前打开的通道数。 | | channelErrors | 数字 | 报告错误的通道数。 | ### storeFile(file, dir) #### 参数： | Name | Type | 说明 | | --- | --- | --- | | file | 文件 | 文件对象（欲了解更多信息，请参阅 https://developer.mozilla。 org/en-US/docs/Web/API/File) 我们要上传到服务器。 | | dir | 字符串 | 我们要将文件上传到的服务器上的绝对路径。 | ### TimezoneRedirectionErrorCode DCV 模块中可用的 TimezoneRedirectionError 代码枚举 + `INVALID_ARGUMENT` + `NO_CHANNEL` + `USER_CANNOT_CHANGE` #### 类型： + 数字 ### TimezoneRedirectionSettingCode DCV 模块中可用的 TimezoneRedirectionSetting 代码枚举 + `ALWAYS_OFF` + `ALWAYS_ON` + `CLIENT_DECIDES` #### 类型： + 数字 ### TimezoneRedirectionStatusCode DCV 模块中可用的 TimezoneRedirectionStatus 代码枚举 + `SUCCESS` + `PERMISSION_ERROR` + `GENERIC_ERROR` #### 类型： + 数字 ### WebcamErrorCode DCV 模块中可用的 WebcamError 代码枚举 + `SETTING_WEBCAM_FAILED` + `CHANNEL_NOT_AVAILABLE` #### 类型： + 数字 ### httpExtraSearchParamsCallback（方法、网址、正文） 在身份验证和建立连接 URLs 期间要调用的回调函数，用于向其中注入自定义查询参数。这支持高级集成方案，包括能够附加自定义查询参数和添加 AWS 签名版本 4 (Sigv4) 签名值，以保护和授权通过外部系统的连接。 此回调还用于自定义在建立与 Amazon DCV 服务器的 WebSocket 连接时使用的 URL。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | method | 字符串 | 用于请求的 HTTP 方法。 | | url | 字符串 | 将用于请求的 URL。 | | body | 字符串 | 请求正文内容。 | #### 返回值: 包含要附加到 URL 的自定义查询参数的 `URLSearchParams` 对象。 Type URLSearchParams ### httpExtraHeaders回调（方法、网址、正文） 要在连接建立期间调用的回调函数，用于将自定义标头（如 `Authorization`）插入 HTTP 请求。 #### 参数： | Name | Type | 说明 | | --- | --- | --- | | method | 字符串 | 用于请求的 HTTP 方法。 | | url | 字符串 | 将用于请求的 URL。 | | body | 字符串 | 请求正文内容。 | #### 返回值: 包含键值对的对象，表示要添加到 HTTP 请求的自定义标头。 Type 对象