@tencentcloud/trtc-cloud-wx 1.0.8 → 1.0.9-beta.0

package/src/interface/index.ts

@@ -0,0 +1,45 @@
+import {
+  TRTCRoleType,
+  TRTCVideoFillMode,
+  TRTCVideoMirrorType,
+  TRTCVideoResolution,
+  TRTCVideoResolutionMode,
+  TRTCVideoRotation,
+  TRTCAudioRoute,
+} from './types'
+
+export interface TRTCParams {
+  sdkAppId: number;
+  userId: string;
+  userSig: string;
+  roomId: number;
+  strRoomId?: string;
+  role: TRTCRoleType;
+  privateMapKey?: string;
+}
+
+export interface TRTCVideoEncParam {
+  videoResolution: TRTCVideoResolution;
+  resMode: TRTCVideoResolutionMode;
+  videoFps: number;
+  videoBitrate: number;
+  minVideoBitrate: number;
+}
+
+export interface TRTCRenderParams {
+  rotation: TRTCVideoRotation;
+  fillMode: TRTCVideoFillMode;
+  mirrorType: TRTCVideoMirrorType;
+}
+
+export interface TRTCVolumeInfo {
+  userId: string;
+  volume: number;
+}
+
+export interface AudioMusicParam {
+  path: string;
+  startTimeMS: number;
+  endTimeMS: number;
+}
+export * from './types'

package/src/interface/types.ts

@@ -0,0 +1,95 @@
+export enum TRTCAppScene {
+  // web
+  // TRTCAppSceneVideoCall = 0,
+  // TRTCAppSceneLIVE = 1,
+  // TRTCAppSceneAudioCall = 2,
+  // TRTCAppSceneVoiceChatRoom = 3,
+
+  // miniprogram
+  // TRTCAppSceneVideoCall = 'videocall',
+  // TRTCAppSceneLIVE = 'live',
+  // TRTCAppSceneAudioCall = 'audiocall',
+  // TRTCAppSceneVoiceChatRoom = 'voicechatroom',
+  TRTCAppSceneVideoCall = 0,
+  TRTCAppSceneLIVE = 1, // live
+  TRTCAppSceneAudioCall = 2,
+  TRTCAppSceneVoiceChatRoom = 3,
+}
+
+export enum TRTCRoleType {
+  TRTCRoleAnchor = 20,
+  TRTCRoleAudience = 21,
+}
+
+export enum TRTCVideoStreamType {
+  TRTCVideoStreamTypeBig = 0,
+  TRTCVideoStreamTypeSmall = 1,
+  TRTCVideoStreamTypeSub = 2, // aux
+}
+
+export enum TRTCVideoResolution {
+  TRTCVideoResolution_120_120 = 1,
+  TRTCVideoResolution_160_160 = 3,
+  TRTCVideoResolution_270_270 = 5,
+  TRTCVideoResolution_480_480 = 7,
+  TRTCVideoResolution_160_120 = 50,
+  TRTCVideoResolution_240_180 = 52,
+  TRTCVideoResolution_280_210 = 54,
+  TRTCVideoResolution_320_240 = 56,
+  TRTCVideoResolution_400_300 = 58,
+  TRTCVideoResolution_480_360 = 60,
+  TRTCVideoResolution_640_480 = 62,
+  TRTCVideoResolution_960_720 = 64,
+  TRTCVideoResolution_160_90 = 100,
+  TRTCVideoResolution_256_144 = 102,
+  TRTCVideoResolution_320_180 = 104,
+  TRTCVideoResolution_480_270 = 106,
+  TRTCVideoResolution_640_360 = 108,
+  TRTCVideoResolution_960_540 = 110,
+  TRTCVideoResolution_1280_720 = 112,
+  TRTCVideoResolution_1920_1080 = 114,
+}
+
+export enum TRTCVideoResolutionMode {
+  TRTCVideoResolutionModeLandscape = 0,
+  TRTCVideoResolutionModePortrait = 1,
+}
+
+export enum TRTCVideoRotation {
+  TRTCVideoRotation0 = 0,
+  TRTCVideoRotation90 = 1,
+  TRTCVideoRotation180 = 2,
+  TRTCVideoRotation270 = 3,
+}
+
+export enum TRTCVideoFillMode {
+  TRTCVideoFillMode_Fill = 0,
+  TRTCVideoFillMode_Fit = 1,
+}
+
+export enum TRTCVideoMirrorType {
+  TRTCVideoMirrorType_Auto = 0,
+  TRTCVideoMirrorType_Enable = 1,
+  TRTCVideoMirrorType_Disable = 2,
+}
+
+export enum TRTCAudioQuality {
+  /** 语音模式：采样率：16k；单声道；音频裸码率：16kbps；适合语音通话为主的场景，比如在线会议，语音通话。 */
+  TRTCAudioQualitySpeech = 1,
+  /** 标准模式（或者默认模式）：采样率：48k；单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。 */
+  TRTCAudioQualityDefault = 2,
+  /** 音乐模式：采样率：48k；双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，比如K歌、音乐直播等。 */
+  TRTCAudioQualityMusic = 3,
+}
+
+export enum TRTCBeautyStyle {
+  TRTCBeautyStyleSmooth = 0,
+  TRTCBeautyStyleNature = 1,
+}
+
+export enum TRTCAudioRoute {
+  /** 扬声器模式 */
+  TRTC_AUDIO_ROUTE_SPEAKER = 0,
+  /** 听筒模式 */
+  TRTC_AUDIO_ROUTE_EARPIECE = 1,
+}

package/src/log/logger.ts

@@ -0,0 +1,80 @@
+import {formatTime} from '../utils/common'
+
+const LOGLEVEL = {
+  LOG: 0,
+  INFO: 1,
+  DEBUG: 2,
+  WARN: 3,
+  ERROR: 4, // 无日志记录级别，sdk将不打印任何日志
+  NON_LOGGING: 5, // 无日志记录级别，sdk将不打印任何日志
+}
+export class Logger {
+  private logLevel = 0
+
+  private sdkAppId
+
+  private userId
+
+  private roomId
+
+  private TAG_NAME = ''
+
+  constructor(tagName?: string) {
+    this.TAG_NAME = tagName || '[TRTCCloud-WX]'
+  }
+
+  setInfo(params: {
+    sdkAppId: number | string;
+    userId: string;
+    roomId: string | number;
+  }): void {
+    const {sdkAppId, userId, roomId} = params
+    this.sdkAppId = sdkAppId
+    this.userId = userId
+    this.roomId = roomId
+  }
+
+  setLogLevel(level: number): void {
+    this.logLevel = level
+  }
+
+  // 打印普通日志
+  log(...args: any): void {
+    if (this.logLevel === LOGLEVEL.LOG) {
+      console.log(this.TAG_NAME, formatTime(), ...args)
+    }
+  }
+
+  info(...args: any): void {
+    if (this.logLevel <= LOGLEVEL.INFO) {
+      console.info(this.TAG_NAME, formatTime(), ...args)
+    }
+  }
+
+  // 打印告警日志
+  warn(...args: any): void {
+    // SDK 上报的相关事件
+    if (this.logLevel <= LOGLEVEL.WARN) {
+      console.warn(this.TAG_NAME, formatTime(), ...args)
+    }
+  }
+
+  // 打印错误日志
+  error(...args: any): void {
+    // 状态机内部错误信息
+    if (this.logLevel <= LOGLEVEL.ERROR) {
+      console.error(this.TAG_NAME, formatTime(), ...args)
+    }
+  }
+
+  debug(...args: any): void {
+    // 状态机内部错误信息
+    if (this.logLevel <= LOGLEVEL.DEBUG) {
+      console.debug(this.TAG_NAME, formatTime(), ...args)
+    }
+  }
+}
+
+export const logger = new Logger()
+
+export default logger

package/src/types.d.ts

@@ -0,0 +1 @@
+declare const wx: any

package/src/utils/common.ts

@@ -0,0 +1,50 @@
+export const uniqueFunc = (arr, uniId) => {
+  const res = new Map()
+  return arr.filter((item) => !res.has(item[uniId]) && res.set(item[uniId], 1))
+}
+
+export const isFunction = (param: any) => typeof param === 'function'
+export const isUndefined = (param: any) => typeof param === 'undefined'
+export const isString = (param: any) => typeof param === 'string'
+export const isNumber = (param: any) => typeof param === 'number'
+export const isBoolean = (param: any) => typeof param === 'boolean'
+
+/**
+ * 安全执行 JSON.parse
+ * @param data
+ * @returns
+ */
+export function safelyParse(data: string) {
+  if (typeof data !== 'string') {
+    return data
+  }
+  let result
+  try {
+    const tempData = JSON.parse(data)
+    // 规避 JSON.parse('12345') 转化为 12345 的情况
+    if (typeof tempData === 'object' && tempData) {
+      result = tempData
+    } else {
+      result = data
+    }
+  } catch (error) {
+    result = data
+  }
+  return result
+}
+
+export const formatTime = (): string => {
+  const timestamp = new Date().getTime()
+  const date = new Date(timestamp)
+  // const year = date.getFullYear()
+  // const month = date.getMonth() + 1
+  // const day = date.getDate()
+  let hour = date.getHours() as any
+  let minute = date.getMinutes() as any
+  let second = date.getSeconds() as any
+  const millisecond = date.getMilliseconds()
+  hour = hour < 10 ? `0${hour}` : hour
+  minute = minute < 10 ? `0${minute}` : minute
+  second = second < 10 ? `0${second}` : second
+  return `${hour}:${minute}:${second}.${millisecond}`
+}

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './translate'
+export * from './common'

package/src/utils/translate.ts

@@ -0,0 +1,139 @@
+import {
+  TRTCAppScene,
+  TRTCBeautyStyle,
+  TRTCVideoFillMode,
+  TRTCVideoMirrorType,
+  TRTCVideoResolution,
+  TRTCVideoResolutionMode,
+  TRTCVideoRotation,
+  TRTCVideoStreamType,
+  TRTCAudioRoute,
+} from '../interface'
+
+export const translateTRTCAppScene = (scene: TRTCAppScene): string => {
+  switch (scene) {
+    case 0:
+      return 'videocall'
+    case 1:
+      return 'live'
+    case 2:
+      return 'audiocall'
+    case 3:
+      return 'voicechatroom'
+    default:
+      return ''
+  }
+}
+
+export const translateTRTCVideoStreamType = (
+  streamType: TRTCVideoStreamType
+): string => {
+  switch (streamType) {
+    case 0:
+      return 'main'
+    case 1:
+      return 'small'
+    case 2:
+      return 'aux'
+    default:
+      return ''
+  }
+}
+
+export const translateTRTCStreamId = (
+  userId: string,
+  streamType: TRTCVideoStreamType
+): string => `${userId}_${translateTRTCVideoStreamType(streamType)}`
+
+const TRTCVideoResolutionMap = {
+  [TRTCVideoResolution.TRTCVideoResolution_120_120]: [120, 120],
+  [TRTCVideoResolution.TRTCVideoResolution_160_160]: [160, 160],
+  [TRTCVideoResolution.TRTCVideoResolution_270_270]: [270, 270],
+  [TRTCVideoResolution.TRTCVideoResolution_480_480]: [480, 480],
+  [TRTCVideoResolution.TRTCVideoResolution_160_120]: [160, 120],
+  [TRTCVideoResolution.TRTCVideoResolution_240_180]: [240, 180],
+  [TRTCVideoResolution.TRTCVideoResolution_280_210]: [280, 210],
+  [TRTCVideoResolution.TRTCVideoResolution_320_240]: [320, 240],
+  [TRTCVideoResolution.TRTCVideoResolution_400_300]: [400, 300],
+  [TRTCVideoResolution.TRTCVideoResolution_480_360]: [480, 360],
+  [TRTCVideoResolution.TRTCVideoResolution_640_480]: [640, 480],
+  [TRTCVideoResolution.TRTCVideoResolution_960_720]: [960, 720],
+  [TRTCVideoResolution.TRTCVideoResolution_160_90]: [160, 90],
+  [TRTCVideoResolution.TRTCVideoResolution_256_144]: [256, 144],
+  [TRTCVideoResolution.TRTCVideoResolution_320_180]: [320, 180],
+  [TRTCVideoResolution.TRTCVideoResolution_480_270]: [480, 270],
+  [TRTCVideoResolution.TRTCVideoResolution_640_360]: [640, 360],
+  [TRTCVideoResolution.TRTCVideoResolution_960_540]: [960, 540],
+  [TRTCVideoResolution.TRTCVideoResolution_1280_720]: [1280, 720],
+  [TRTCVideoResolution.TRTCVideoResolution_1920_1080]: [1920, 1080],
+}
+export const translateTRTCVideoResolution = (
+  resolution: TRTCVideoResolution
+): Record<'videoWidth' | 'videoHeight', number> => {
+  const [videoWidth = 0, videoHeight = 0] = TRTCVideoResolutionMap[resolution]
+  return {videoWidth, videoHeight}
+}
+
+export const translateTRTCVideoResolutionMode = (
+  resolutionMode: TRTCVideoResolutionMode
+): string => {
+  switch (resolutionMode) {
+    case TRTCVideoResolutionMode.TRTCVideoResolutionModeLandscape:
+      return 'horizontal'
+    case TRTCVideoResolutionMode.TRTCVideoResolutionModePortrait:
+      return 'vertical'
+    default:
+      return ''
+  }
+}
+
+export const translateTRTCVideoRotation = (rotation: TRTCVideoRotation): string => {
+  switch (rotation) {
+    case TRTCVideoRotation.TRTCVideoRotation0:
+      return 'vertical'
+    case TRTCVideoRotation.TRTCVideoRotation90:
+      return 'horizontal'
+    default:
+      return ''
+  }
+}
+
+export const translateTRTCVideoMirrorType = (
+  mirrorType: TRTCVideoMirrorType
+): string => {
+  switch (mirrorType) {
+    case TRTCVideoMirrorType.TRTCVideoMirrorType_Auto:
+      return 'auto'
+    case TRTCVideoMirrorType.TRTCVideoMirrorType_Enable:
+      return 'enable'
+    case TRTCVideoMirrorType.TRTCVideoMirrorType_Disable:
+      return 'disable'
+    default:
+      return ''
+  }
+}
+
+export const translateTRTCAudioRoute = (
+  route: TRTCAudioRoute
+): string => {
+  switch (route) {
+    case TRTCAudioRoute.TRTC_AUDIO_ROUTE_SPEAKER:
+      return 'speaker'
+    case TRTCAudioRoute.TRTC_AUDIO_ROUTE_EARPIECE:
+      return 'ear'
+    default:
+      return ''
+  }
+}
+
+const TRTCBeautyStyleMap = {
+  [TRTCBeautyStyle.TRTCBeautyStyleSmooth]: 'smooth',
+  [TRTCBeautyStyle.TRTCBeautyStyleNature]: 'nature'
+}
+export const translateBeautyStyle = (beautyStyle: TRTCBeautyStyle): string => TRTCBeautyStyleMap[beautyStyle]
+
+const TRTCVideoFillModeMap = {
+  [TRTCVideoFillMode.TRTCVideoFillMode_Fill]: 'fillCrop',
+  [TRTCVideoFillMode.TRTCVideoFillMode_Fit]: 'contain'
+}
+export const translateVideoFillMod = (videoFillMod: TRTCVideoFillMode): string => TRTCVideoFillModeMap[videoFillMod]

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2015",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "moduleResolution": "node",
+    "lib": ["dom", "ES2015", "ES2015.Promise"],
+    "resolveJsonModule": true,
+    "experimentalDecorators": true
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": ["node_moudles"]
+}

package/typedoc.json

@@ -0,0 +1,21 @@
+{
+    // 输入选项 - 入口文件/文件夹
+    "entryPoints": [
+      "src/index.ts"
+    ],
+    // 输入选项 - 排除文件/文件夹
+    "exclude": [
+      "node_moudles",
+    ],
+    "tsconfig": "./tsconfig.json",
+    "entryPointStrategy": "expand",
+    // 输出选项 - 将软件包package.json中的版本version添加到项目名称中
+    "includeVersion": true,
+    // 输出选项 - 设置将在模板标题中使用的项目的名称。默认为package.json中的name
+    "name": "TRTCCloud",
+    // 输出选项 - 不在页面末尾打印TypeDoc链接
+    "hideGenerator": true,
+    // 输出选项 - 禁用描述代码位置
+    "disableSources": true,
+    "categoryOrder": ["Base", "房间", "视频", "*"]
+  }