v1.1.11

Author: ranpeng

README.md

@@ -39,6 +39,8 @@
 
 ## 说明文档
 
+[接口文档](https://ex.cloud-gaming.myqcloud.com/cloud_gaming_web/docs/index.html)
+
 [使用例子](samples/)
 
 [快速入门](https://cloud.tencent.com/document/product/1162/46135)

README_EN-US.md

@@ -39,6 +39,8 @@ For more information, see the mobile and PC demos in the `samples` folder.
 
 ## Documentation
 
+[Interface Documents](https://ex.cloud-gaming.myqcloud.com/cloud_gaming_web/docs_en/index.html)
+
 [Use Samples](samples/)
 
 [Getting Started](https://www.tencentcloud.com/document/product/1158/49612)

changelog.md

@@ -1,3 +1,17 @@
+### [1.1.11](https://github.com/tencentyun/cloudgame-js-sdk/releases/tag/v1.1.11)@2022.02.01
+
+**新增**
+
+- keyboard data 新增 location 表示左右按键
+
+**变更**
+
+- 重连优化
+
+**修复**
+
+- 重复多次开关麦，导致麦克风切换失败问题修复
+
 ### [1.1.10](https://github.com/tencentyun/cloudgame-js-sdk/releases/tag/v1.1.10)@2022.12.02
 
 **新增**

dist/tcg-sdk/index.d.ts

@@ -1332,7 +1332,7 @@ export class TCGSDK {
    * @example
    * const { sendMessage, code } = await TCGSDK.createCustomDataChannel({
    *   destPort: 6060,
-   *   onMessage: (res: any) => {
+   *   onMessage: (res) => {
    *     console.log('CustomDataChannel onMessage', res);
    *   },
    * });
@@ -1366,6 +1366,7 @@ export class TCGSDK {
    * @param {Object} param
    * @param {number} param.key - 对应的 code 码
    * @param {boolean} param.down - 是否是按下状态
+   * @param {number} param.location - 1 左键，2 右键
    *
    * @example
    * // 按下时
@@ -1374,7 +1375,7 @@ export class TCGSDK {
    * TCGSDK.sendKeyboardEvent({key: 32, down:  false});
    *
    */
-  sendKeyboardEvent({ key, down }: { key: number; down: boolean }): void;
+  sendKeyboardEvent({ key, down, location }: { key: number; down: boolean; location?: number }): void;
   /**
    * 发送鼠标事件
    * @param {Object} param
@@ -1490,6 +1491,9 @@ export class TCGSDK {
   // -------------- 音视频控制相关接口 ------------
   /**
    * 设置码流参数，该接口为设置建议码流参数，云端可能会根据游戏动态调整
+   *
+   * **如果CreateSession 参数中设置了 MinBitrate/MaxBitrate，参数 min_bitrate/max_bitrate 必须在前者设置范围内**
+   *
    * @param {Object} profile 目前可用参数如下：
    * @param {number} profile.fps - 帧率，范围[10,60]
    * @param {number} profile.max_bitrate - 最大码率，范围[1,15]，单位：Mbps
@@ -1649,6 +1653,8 @@ export class TCGSDK {
   /**
    * 获取页面尺寸
    *
+   * **可获取根据设备 window.devicePixelRatio 乘以固定比例保证显示画面分辨率足够清晰**
+   *
    * @returns {Object} { width: number; height: number };
    *
    * @example

dist/tcg-sdk/index.js

@@ -645,6 +645,12 @@ export interface InitConfig {
    * @default '正在启动云渲染'
    */
   loadingText?: string;
+  /**
+   * Restart button text
+   *
+   * @default '重新连接'
+   */
+  restartText?: string;
   /**
    * Whether to rotate the entire HTML view. Default value: `false.
    *
@@ -978,6 +984,14 @@ export interface InitConfig {
    * @param {('portrait' | 'landscape')} response.type - current screen status
    */
   onOrientationChange?: (response: { type: 'portrait' | 'landscape' }) => void;
+  /**
+   * Page visibility changes.
+   *
+   * @function
+   * @param {Object} response - onVisibilityChange response
+   * @param {('visible' | 'hidden')} response.status
+   */
+  onVisibilityChange?: (response: { status: 'visible' | 'hidden' }) => void;
   /**
    * Cloud config changed, only trigger when status changed.
    *
@@ -1029,7 +1043,7 @@ export interface InitConfig {
    *
    * @function
    * @param {Object} response - onConfigurationChange response
-   * @param {string} response.type - event type: 'idle' | 'noflow' | 'noflowcenter' | 'stats' | 'openurl' | 'latency'
+   * @param {string} response.type - event type: 'idle' | 'noflow' | 'noflowcenter' | 'stats' | 'openurl' | 'latency' | 'pointerlockerror'
    * @param {any} response.data
    */
   onEvent?: (response: OnEventResponse) => void;
@@ -1305,7 +1319,7 @@ export class TCGSDK {
    * @example
    * const { sendMessage, code } = await TCGSDK.createCustomDataChannel({
    *   destPort: 6060,
-   *   onMessage: (res: any) => {
+   *   onMessage: (res) => {
    *     console.log('CustomDataChannel onMessage', res);
    *   },
    * });

dist/tcg-sdk/index_en.d.ts

@@ -124,7 +124,16 @@ export interface JoystickOutputData {
  * @param {string} [params.joystickImage.frontPressed] - 按钮被按下后的图片， http/https 地址，不填采用默认图片
  * @param {boolean} [params.restJoystick=true] - touchend 后复位摇杆，默认值 `true`
  *
- * @example new Joystick({})
+ * @example
+ * // 如果是通过 Script 标签引入
+ * const j = new CloudGamingPlugin.joystick({
+ *  zone: document.querySelector('#plugin-point'),
+ * });
+ *
+ *
+ * // 如果是通过 ES module import
+ * const j = new Joystick({zone: document.querySelector('#plugin-point')})
+ *
  */
 declare class Joystick {
   constructor(params: JoystickConfig);

plugin/joystick/joystick.d.ts

@@ -122,7 +122,16 @@ export interface JoystickOutputData {
  * @param {string} [params.joystickImage.frontPressed] - The image of a pressed button, which is an HTTP/HTTPS address. If this parameter is not specified, the default image will be used.
  * @param {boolean} [params.restJoystick=true] - Whether to reset the stick after `touchend`. Default value: `true`.
  *
- * @example new Joystick({})
+ * @example
+ * // If import plugin from `Script tag`.
+ * const j = new CloudGamingPlugin.joystick({
+ *  zone: document.querySelector('#plugin-point'),
+ * });
+ *
+ *
+ * // If import plugin from `ES module import`
+ * const j = new Joystick({zone: document.querySelector('#plugin-point')})
+ *
  */
 declare class Joystick {
   constructor(params: JoystickConfig);

plugin/joystick/joystick.js

@@ -47,6 +47,7 @@ export interface KeyboardConfig {
  * 依赖 TCGSDK 使用，建议在 TCGSDK.init 内的回调函数 onConnectSuccess 中使用
  *
  * @param {Object} params
+ * @param {HTMLElement} [params.zone=TCGSDK init param `mount`] - 摇杆挂载节点，默认 TCGSDK init 参数传入的 mount 节点
  * @param {boolean} [params.sendData=true] - 自动发送键盘数据 默认值 true
  * @param {string} [params.keyBorderColor='#4a525a'] - 按键边框颜色 默认 '#4a525a'
  * @param {Object} [params.keyPressedBorderColor='#2684FF'] - 按下时边框颜色 默认 '#2684FF'