trtc-cloud-js-sdk 1.0.13 → 2.0.0

package/.eslintrc.js

@@ -0,0 +1,88 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: ['eslint-config-tencent'],
+  rules: {
+    indent: ['error', 2, { SwitchCase: 1 }], // 缩进
+    semi: ['error', 'always'],
+    'no-unused-vars': [
+      // 禁止出现未使用过的变量
+      'error',
+      {
+        args: 'none', // 不检查参数
+      },
+    ],
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "argsIgnorePattern": "^_" }
+    ],
+    // 要求构造函数首字母大写 （要求调用 new 操作符时有首字母大小的函数，允许调用首字母大写的函数时没有 new 操作符。）
+    'new-cap': [
+      2,
+      {
+        newIsCap: true, // 要求调用 `new` 操作符时有首字母大小的函数
+        capIsNew: false, // 允许调用首字母大写的函数时没有 `new` 操作符
+      },
+    ],
+    'no-console': 'off', // 禁用 console
+    'no-empty': 'warn', // 禁止出现空语句块
+    'linebreak-style': 'off', // 强制使用一致的换行风格
+    'require-jsdoc': 'off',
+    'max-len': [
+      'warn',
+      {
+        code: 160,
+        ignoreComments: true, // 忽略所有拖尾注释和行内注释
+        ignoreUrls: true, // 忽略含有链接的行
+      },
+    ],
+    'valid-jsdoc': [
+      'warn',
+      {
+        prefer: {
+          return: 'returns', // instead of @return use @returns
+        },
+        requireReturn: false, // if and only if the function or method has a return statement or returns a value e.g.
+        requireReturnDescription: false, // allows missing description in return tags
+      },
+    ],
+    'object-curly-spacing': [
+      'error',
+      'always', // 要求花括号内有空格
+    ],
+    eqeqeq: [
+      'error',
+      'always', // enforces the use of === and !== in every situation
+    ],
+    'no-alert': 'error', // 禁止使用alert confirm prompt
+    'no-nested-ternary': 'error', // 禁止使用嵌套的三目运算
+    'space-unary-ops': [
+      'error',
+      {
+        words: true, // 一元操作符，例如：new、delete、typeof、void、yield 后需要有空格
+        nonwords: false, // 一元操作符: -、+、--、++、!、!! 前不能有空格
+      },
+    ],
+    'key-spacing': [
+      'error',
+      {
+        mode: 'strict', // enforces exactly one space before or after colons in object literals. 禁止对齐
+        beforeColon: false, // disallows spaces between the key and the colon in object literals
+        afterColon: true, // requires at least one space between the colon and the value in object literals
+      },
+    ],
+    'space-infix-ops': 'error', // 中缀操作符周围有空格
+    'no-else-return': [
+      'error',
+      {
+        allowElseIf: false, // disallows else if blocks after a return
+      },
+    ],
+    'prefer-rest-params': 'off', // 用arguments没什么不好的
+    'guard-for-in': 'error', // for in时需检测hasOwnProperty，避免遍历到继承来的属性方法
+    'prefer-spread': 'off', // 用apply也挺好的，es2015的spread syntax不是个必选项
+    'no-underscore-dangle': 'off', // 允许使用悬空下划线, 主要用来表示对象中的 "私有" 成员. ref: https://eslint.bootcss.com/docs/rules/no-underscore-dangle
+    'no-param-reassign': 'off', // 赋值给声明为函数参数的变量可能会引起误解，并导致混淆行为, TODO: 后续删除 ref: https://cloud.tencent.com/developer/section/1135734
+    'no-multi-spaces': 'error',
+    'camelcase': 'off',
+  },
+};

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 200,
+  "trailingComma": "all",
+  "singleQuote": true
+}

package/CHANGELOG.md

@@ -0,0 +1,58 @@
+## [1.0.7] (2023-04-18)
+
+#### 修复
+- 修复没有本地流情况下切换设备报错的问题。
+- 修复发布流时没有本地流的时候设置 isPublished 为 true 的问题。
+- 修复本地播放流没有设置 videoProfile 的问题。
+- 修复摄像头拔出时本地播放流没有切换摄像头的问题。
+
+
+## [1.0.5] (2023-02-06)
+
+#### 修复
+- 修复主播切换至观众时，未设置推流状态问题。
+- http + ip 环境时，navigator.mediaDeices 为 undefined，无法监听设备切换。
+
+
+## [1.0.4] (2022-09-22)
+
+#### 优化
+- 进房支持额外参数，[WebRTC](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-01-info-changelog.html) 必须要 ≥ v4.15.2。
+
+
+## [1.0.3] (2022-12-08)
+
+#### 新增
+- 增加 onFirstVideoFrame, onMicDidReady 事件。
+- 为 onNetworkQuality 事件增加 remoteQuality 参数。
+- mute 操作增加状态变量，用于记录用户的操作记录。
+- 辅流推屏幕分享, 不向下兼容。WebRTC ≥ 4.15.0。
+- 屏幕分享接口增加参数: 本地预览/编码参数设置。
+
+#### 修复
+- 停止预览时，将本地预览流设置为 null。
+- 观众切换为主播推流后, 没有设置推流状态问题修复。
+- muteAudio --> enterRoom --> startLocalPreview --> startLocalAudio 后会将 audio 推出去问题修复。
+- muteAudio&muteVideo -> 进房 -> startLocalPreview&startLocalAuido -> unmuteAuido&unmuteVideo -> stopLocalPreview -> muteVideo -> startLocalPreview -> unmuteVideo。此时远端收不到 onUserVideoAvailable hasVideo 为 1 问题修复。
+- muteAudio&muteVideo -> 进房 -> startLocalPreview&startLocalAuido -> unmuteAuido&unmuteVideo 抛出的 onUserAudioAvailable 错误问题修复。
+- setVideoProfile 没有设置本地预览流问题修复。
+
+#### 优化
+- muteLocalVideo/muteLocalAudio 方法对其 [Electron SDK API](https://web.sdk.qcloud.com/trtc/electron/doc/zh-cn/trtc_electron_sdk/TRTCCloud.html#muteLocalVideo)。
+- 开发进房不上行时, 将本地预览和推出去的流分成了 2 个,导致 audio-volume 中没有本地音量. 因为推出去的流没有进行播放. 因此需要将本地流播放, 只是不展示。
+- 设置本地预览播放本地流，而不是推出去的视频流。
+- TRTCAudioQuality 对齐 [Electron SDK API](https://web.sdk.qcloud.com/trtc/electron/doc/zh-cn/trtc_electron_sdk/TRTCCloud.html#muteLocalVideo)。
+- 本地预览流中可能会产生不必要的流初始化。
+- 对外暴露 TRTCVideoResolutionMode。
+
+
+## [1.0.2] (2022-09-22)
+
+#### 新增
+- startScreenShare 屏幕分享增加 screenAudio 参数，用于是否开启系统声音。
+
+
+## [1.0.1] (2022-09-13)
+
+#### 修复
+- [setLocalRenderParams]() 问题处理。

package/build/jsdoc/clean-doc.js

@@ -0,0 +1,12 @@
+const path = require('path');
+const apiPath = path.join(__dirname, '../../', 'docs', 'api');
+const fs = require('fs');
+var files = fs.readdirSync(apiPath);
+
+files.forEach(file => {
+  if (path.extname(file) === '.html') {
+    var htmlPath = path.join(apiPath, file);
+    console.log('delete file', htmlPath);
+    fs.unlinkSync(htmlPath);
+  }
+});

package/build/jsdoc/fix-doc.js

@@ -0,0 +1,141 @@
+const replace = require('replace');
+const path = require('path');
+const apiPath = path.join(__dirname, '../../', 'docs', 'api');
+const pretty = require('pretty');
+const fs = require('fs');
+
+var files = fs.readdirSync(apiPath);
+var replacements = [
+  {
+    find: '<header>',
+    replace: '<header style="display:none">',
+  },
+  // {
+  //   find: '<h4 class="name" id="Client">',
+  //   replace: '<h4 class="name" style="display:none" id="Client">'
+  // },
+  // {
+  //   find: '<h4 class="name" id="Stream">',
+  //   replace: '<h4 class="name" style="display:none" id="Stream">'
+  // },
+  // {
+  //   find: '<h4 class="name" id="LocalStream">',
+  //   replace: '<h4 class="name" style="display:none" id="LocalStream">'
+  // },
+  // {
+  //   find: '<h4 class="name" id="RemoteStream">',
+  //   replace: '<h4 class="name" style="display:none" id="RemoteStream">'
+  // },
+  {
+    find: `<p>!</p>`,
+    replace: `<p>注意：</p>`,
+  },
+  {
+    find: '<blockquote',
+    replace: '<blockquote style="border-left: 6px solid #00a4ff;margin: 0 0 24px;padding: 12px;background: #dcf4ff;"',
+  },
+  // {
+  //   find: '<li><a href="tutorial-00-info-update-guideline.html">SDK 升级指引</a>',
+  //   replace:
+  //     '<ul><li style="margin:10px 0 5px 0">相关信息</li><li><a href="tutorial-00-info-update-guideline.html">SDK 升级指引</a>'
+  // },
+  // {
+  //   find: '<li><a href="tutorial-10-basic-get-started-with-demo.html">快速跑通 Demo</a>',
+  //   replace:
+  //     '</ul><ul><li style="margin:10px 0 5px 0">基础教程</li><li><a href="tutorial-10-basic-get-started-with-demo.html">快速跑通 Demo</a>'
+  // },
+  // {
+  //   find: '<a href="tutorial-07-basic-detect-volume.html">音量大小检测</a></li>',
+  //   replace: '<a href="tutorial-07-basic-detect-volume.html">音量大小检测</a></li><ul/>'
+  // },
+  // {
+  //   find:
+  //     '<li><a href="tutorial-20-advanced-customized-capture-rendering.html">自定义采集与自定义播放渲染</a>',
+  //   replace:
+  //     '<ul><li style="margin:10px 0 5px 0">进阶教程</li><li><a href="tutorial-20-advanced-customized-capture-rendering.html">自定义采集与自定义播放渲染</a>'
+  // },
+  // {
+  //   find: '<a href="tutorial-25-advanced-device-change.html">检测设备插拔行为</a></li>',
+  //   replace: '<a href="tutorial-25-advanced-device-change.html">检测设备插拔行为</a></li></ul>'
+  // },
+  {
+    find: '<pre class="prettyprint',
+    replace: '<pre class="highlight lang-javascript',
+  },
+  {
+    find: '<html lang="en">',
+    replace: '<html lang="zh-cmn-Hans">',
+  },
+  /* ,
+  {
+    find: '<pre class="prettyprint source',
+    replace: '<pre class="prettyprint source linenums'
+  },
+  {
+    find: 'class="prettyprint"><code>',
+    replace: 'class="prettyprint source linenums"><code>'
+  } */
+  {
+    find: '_HACK_JSDOC',
+    replace: '',
+  },
+];
+
+files.forEach((file) => {
+  if (path.extname(file) === '.html') {
+    // console.log(__dirname, file, path.join(apiPath, file));
+    // console.log(fs.readFileSync(path.join(apiPath, file)).toString());
+    var htmlPath = path.join(apiPath, file);
+    let htmlContent = fs.readFileSync(htmlPath).toString();
+
+    if (file === 'index.html' || file === 'TRTCCloud.html') {
+      htmlContent = htmlContent.replace(/#.Audio/g, '');
+      htmlContent = htmlContent.replace(/Audio#/g, '');
+
+      htmlContent = htmlContent.replace(/#.Beauty/g, '');
+      htmlContent = htmlContent.replace(/Beauty#/g, '');
+
+      htmlContent = htmlContent.replace(/#.Camera/g, '');
+      htmlContent = htmlContent.replace(/Camera#/g, '');
+
+      htmlContent = htmlContent.replace(/#.Mic/g, '');
+      htmlContent = htmlContent.replace(/Mic#/g, '');
+
+      htmlContent = htmlContent.replace(/#.MixCDN/g, '');
+      htmlContent = htmlContent.replace(/MixCDN#/g, '');
+
+      htmlContent = htmlContent.replace(/#.Video/g, '');
+      htmlContent = htmlContent.replace(/Video#/g, '');
+
+      htmlContent = htmlContent.replace(/#.Share/g, '');
+      htmlContent = htmlContent.replace(/Share#/g, '');
+    }
+    if (file.includes('.html')) {
+      htmlContent = htmlContent.replace(/TRTCCallback#/g, '');
+    }
+    if (file === 'TRTCCloud.html') {
+      // Audio、Video、Camera 等模块的方法加上了 static
+      htmlContent = htmlContent.replace(/\(static\) /g, '');
+      // 针对 getTRTCShareInstance、destroyTRTCShareInstance 需要再加上 static
+      htmlContent = htmlContent.replace('</span>getTRTCShareInstance', '(static) </span>getTRTCShareInstance');
+      htmlContent = htmlContent.replace('</span>destroyTRTCShareInstance', '(static) </span>destroyTRTCShareInstance');
+    }
+
+    fs.writeFile(htmlPath, pretty(htmlContent, { ocd: true }), function (err) {
+      if (err) {
+        return console.error(err);
+      }
+      console.log(htmlPath, '格式化成功！');
+
+      replacements.forEach(function (obj) {
+        replace({
+          regex: obj.find,
+          replacement: obj.replace,
+          paths: [htmlPath],
+          recursive: false,
+          silent: true,
+        });
+      });
+    });
+  }
+});

package/build/jsdoc/jsdoc.json

@@ -0,0 +1,42 @@
+{
+  "plugins": ["jsdoc-plugin-typescript", "plugins/markdown"],
+  "sourceType": "module",
+  "typescript": {
+    "moduleRoot": "src"
+  },
+  "source": {
+    "include": [
+      "./build/ts2js/src/index.js",
+      "./build/ts2js/src/Audio.js",
+      "./build/ts2js/src/Video.js",
+      "./build/ts2js/src/Camera.js",
+      "./build/ts2js/src/Mic.js",
+      "./build/ts2js/src/Share.js",
+      "./build/ts2js/src/MixCDN.js",
+      "./build/ts2js/src/common/trtc_define.js"
+    ],
+    "includePattern": ".+\\.js(doc)?$"
+  },
+  "opts": {
+    "access": "undefined, public",
+    "encoding": "utf8",
+    "recurse": true,
+    "verbose": true,
+    "readme": "./docs/main.md",
+    "template": "../../node_modules/docdash-blue",
+    "destination": "docs/api"
+  },
+  "docdash": {
+    "sort": false,
+    "search": true,
+    "collapse": true,
+    "static": true,
+    "sectionOrder": ["Namespaces", "Classes", "Modules", "Externals", "Events", "Mixins", "Tutorials", "Interfaces"]
+  },
+  "templates": {
+    "default": {
+      "outputSourceFiles": false,
+      "useLongnameInNav": true
+    }
+  }
+}

package/build/package-bundle.js

@@ -0,0 +1,29 @@
+const replace = require('replace');
+const fs = require('fs');
+const pkg = require('../package.json');
+
+var srcPaths = ['./build/template/npm-package/package.json', './build/template/npm-package/README.md'];
+var distPaths = ['./dist/npm-package/package.json', './dist/npm-package/README.md'];
+
+var replacements = [
+  {
+    find: '<@VERSION@>',
+    replace: pkg.version,
+  },
+];
+
+srcPaths.forEach((src, index) => {
+  console.log(src);
+  console.log(distPaths[index]);
+  fs.writeFile(distPaths[index], fs.readFileSync(src).toString(), function (err) {
+    replacements.forEach(function (obj) {
+      replace({
+        regex: obj.find,
+        replacement: obj.replace,
+        paths: [distPaths[index]],
+        recursive: true,
+        silent: true,
+      });
+    });
+  });
+});

package/build/rollup.config.dev.js

@@ -0,0 +1,88 @@
+import json from 'rollup-plugin-json';
+import progress from 'rollup-plugin-progress';
+import filesize from 'rollup-plugin-filesize';
+import commonjs from 'rollup-plugin-commonjs';
+import globals from 'rollup-plugin-node-globals';
+import resolve from 'rollup-plugin-node-resolve';
+import babel from 'rollup-plugin-babel';
+import replace from 'rollup-plugin-replace';
+import livereload from 'rollup-plugin-livereload';
+import typescript from 'rollup-plugin-typescript';
+import serve from 'rollup-plugin-serve';
+
+export default {
+  input: './src/index.ts',
+  output: [
+    // {
+    //   file: '../TUIRoomEngine/packages/roomEngine/node_modules/trtc-cloud-js-sdk/trtc-cloud-js-sdk.js',
+    //   format: 'umd',
+    //   name: 'TRTC',
+    // },
+    {
+      file: './dist/npm-package/trtc-cloud-sdk.js',
+      format: 'umd',
+      name: 'TRTC',
+    },
+    {
+      file: './examples/apiExample/node_modules/trtc-cloud-js-sdk/trtc-cloud-js-sdk.js',
+      format: 'umd',
+      name: 'TRTC',
+    },
+    // {
+    //   file: './examples/vueDemo/node_modules/trtc-cloud-js-sdk/trtc-cloud-js-sdk.js',
+    //   format: 'umd',
+    //   name: 'TRTC',
+    // },
+  ],
+  watch: {
+    exclude: /node_modules/,
+  },
+  plugins: [
+    json(),
+    progress({
+      clearLine: true, // default: true
+    }),
+    filesize(),
+    commonjs({
+      sourceMap: false,
+    }),
+    globals(),
+    // builtins(),
+    resolve({
+      browser: true,
+    }),
+    typescript(),
+    babel({
+      exclude: /node_modules/,
+      babelrc: false,
+      presets: [
+        [
+          '@babel/preset-env',
+          {
+            useBuiltIns: 'usage', // 开启后可以不用 plugin-transform-runtime, 按需转换新API
+            corejs: 3,
+            modules: false, //设置false 否则 Babel 会在 Rollup 做处理之前，将我们的模块转成 CommonJS，导致 Rollup 的一些处理失败
+          },
+        ],
+      ],
+    }),
+    replace({
+      ENV: JSON.stringify(process.env.NODE_ENV || 'development'), // 源码里可以使用 ENV 来做条件判断
+    }),
+    // serve({
+    //   open: true, // 是否打开浏览器
+    //   contentBase: ['../../packages/trtc-cloud/examples/jsExample'], // 入口html的文件位置
+    //   historyApiFallback: true, // Set to true to return index.html instead of 404
+    //   host: 'localhost',
+    //   port: 9900,
+    // }),
+    livereload({
+      watch: ['../../packages/trtc-cloud/examples/jsExample'],
+    }),
+  ],
+  onwarn(warning, rollupWarn) {
+    if (warning.code !== 'CIRCULAR_DEPENDENCY') {
+      rollupWarn(warning);
+    }
+  },
+};

package/build/rollup.config.prod.js

@@ -0,0 +1,93 @@
+import json from 'rollup-plugin-json';
+import progress from 'rollup-plugin-progress';
+import filesize from 'rollup-plugin-filesize';
+import commonjs from 'rollup-plugin-commonjs';
+import globals from 'rollup-plugin-node-globals';
+import resolve from 'rollup-plugin-node-resolve';
+import babel from 'rollup-plugin-babel';
+import { terser } from 'rollup-plugin-terser';
+import replace from 'rollup-plugin-replace';
+import typescript from 'rollup-plugin-typescript';
+
+export default {
+  input: './src/index.ts',
+  output: [
+    {
+      file: './dist/trtc-cloud.js',
+      format: 'umd',
+      name: 'TRTC',
+    },
+    {
+      file: './dist/npm-package/trtc-cloud-js-sdk.js',
+      format: 'umd',
+      name: 'TRTC',
+    },
+    // {
+    //   file: './examples/vueDemo/node_modules/trtc-cloud-js-sdk/trtc-cloud-js-sdk.js',
+    //   format: 'umd',
+    //   name: 'TRTC',
+    // },
+    {
+      file: './examples/apiExample/node_modules/trtc-cloud-js-sdk/trtc-cloud-js-sdk.js',
+      format: 'umd',
+      name: 'TRTC',
+    },
+    // {
+    //   file: '../TUIRoomEngine/packages/roomEngine/node_modules/trtc-cloud-js-sdk/trtc-cloud-js-sdk.js',
+    //   format: 'umd',
+    //   name: 'TRTC',
+    // },
+    // {
+    //   file: './examples/jsExample/dist/trtc-cloud.js',
+    //   format: 'umd',
+    //   name: 'TRTC'
+    // },
+  ],
+  watch: {
+    exclude: /node_modules/,
+  },
+  plugins: [
+    json(),
+    progress({
+      clearLine: true, // default: true
+    }),
+    filesize(),
+    commonjs({
+      sourceMap: false,
+    }),
+    globals(),
+    // builtins(),
+    resolve({
+      browser: true,
+    }),
+    typescript(),
+
+    babel({
+      exclude: /node_modules/,
+      babelrc: false,
+      presets: [
+        [
+          '@babel/preset-env',
+          {
+            modules: false,
+            useBuiltIns: 'usage',
+            corejs: 3,
+          },
+        ],
+      ],
+    }),
+    terser({
+      numWorkers: 4,
+      safari10: true, // work around Safari 10/11 bugs in loop scoping and await
+      compress: {
+        booleans_as_integers: false, // Turn booleans into 0 and 1, also makes comparisons with booleans use == and != instead of === and !==
+        keep_infinity: true, // prevent Infinity from being compressed into 1/0, which may cause performance issues on Chrome.
+        module: true,
+      },
+    }),
+    replace({
+      ENV: JSON.stringify(process.env.NODE_ENV || 'production'), // 源码里可以使用 ENV 来做条件判断
+    }),
+  ],
+  external: ['trtc-sdk-v5', 'rtc-beauty-plugin', 'axios'],
+};