View a markdown version of this page

Amazon DCV Web UI SDK - Amazon DCV

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

Amazon DCV Web UI SDK

一个 JavaScript React 组件库,目前正在导出一个名为的 React 组件,DCVViewer该组件连接到 Amazon DCV 服务器并呈现工具栏以与远程流进行交互。

公开

组件

列表

DCVViewer

React 组件,渲染工具栏及其所有可用于与远程流交互的功能。

属性:

dcv
Name Type 必需 说明
dcv 对象 是 该对象定义建立到 Amazon DCV 服务器的连接所需的属性,并设置日志级别以及从中加载 Amazon DCV Web Client SDK 资产和访问 DCV 资源的 URL。
Name Type 必需 描述
sessionId 字符串 是 Amazon DCV 会话 ID。
authToken 字符串 是 在连接到服务器时使用的身份验证令牌。
serverUrl 字符串 是 运行的 Amazon DCV 服务器的主机名和端口,格式如下所示:https://dcv_host_address:port。例如:https: //: 8443 my-dcv-server。
baseUrl 字符串 是 从中加载 SDK 文件的绝对或相对 URL。
resourceBaseUrl 字符串 否(默认值:"") 从中访问 DCV 资源的绝对或相对 URL。
onDisconnect 函数 否(默认值:() => {}) 从 Amazon DCV 服务器断开并关闭连接时调用的回调函数。
logLevel LogLevel 否(默认值:LogLevel.INFO) 查看器中使用的日志级别
observers 对象 否(默认:{}) 要包含 C httpExtraHeaders allback httpExtraSearch ParamsCallback 并定义其实现的对象。
Name Type 必需 说明
httpExtraSearchParams 函数 否(默认值:() => {}) 在身份验证和建立连接 URLs 期间要调用的回调函数,用于向其中注入自定义查询参数。
httpExtraHeaders 函数 否(默认值:() => {}) 要在连接建立期间调用的回调函数,用于向 HTTP 请求添加自定义标头。
uiConfig
Name Type 必需 说明
uiConfig 对象 否(默认值:{}) 该对象定义属性以配置工具栏是否可见,以及是否在工具栏上显示全屏和多显示器按钮。
Name Type 必需 说明
toolbar 对象 否(默认值:{}) 该对象定义工具栏配置选项。
Name Type 必需 描述
visible 布尔值 否(默认值:true) 该选项定义是显示还是隐藏工具栏。
fullscreenButton 布尔值 否(默认值:true) 该选项定义是显示还是隐藏工具栏上的全屏按钮。
multimonitorButton 布尔值 否(默认值:true) 该选项定义是显示还是隐藏工具栏上的多显示器按钮。