TRTC

new TRTC()

TRTC对象 通过 TRTC.create() 创建，提供实时音视频的核心能力:

• 进入一个音视频房间 enterRoom()
• 退出当前音视频房间 exitRoom()
• 预览/发布 本地视频 startLocalVideo()
• 采集/发布 本地音频 startLocalAudio()
• 取消预览/发布 本地视频 stopLocalVideo()
• 取消采集/发布 本地音频 stopLocalAudio()
• 观看远端视频 startRemoteVideo()
• 取消观看远端视频 stopRemoteVideo()
• 静默/取消静默 远端音频 muteRemoteAudio()

TRTC 生命周期如图所示：

Methods

(static) create() → {TRTC}

Example

// 创建trtc对象
const trtc = TRTC.create();

Returns:

Type

TRTC

(async) enterRoom(options)

Example

const trtc = TRTC.create();
await trtc.enterRoom({ roomId: 8888, sdkAppId, userId, userSig });

Parameters:

Throws:

(async) exitRoom()

Example

await trtc.exitRoom();

Throws:

(async) switchRole(role, optionopt)

Examples

// 进房成功后
// TRTC.TYPE.SCENE_LIVE 互动直播模式下，观众切换为主播
await trtc.switchRole(TRTC.TYPE.ROLE_ANCHOR);
// 观众角色切换为主播，开始推流
await trtc.startLocalVideo();
// TRTC.TYPE.SCENE_LIVE 互动直播模式下，主播切换为观众
await trtc.switchRole(TRTC.TYPE.ROLE_AUDIENCE);

// Since v5.3.0+
await trtc.switchRole(TRTC.TYPE.ROLE_ANCHOR, { privateMapKey: 'your new privateMapKey' });

Parameters:

Throws:

destroy()

Example

// 通话结束时
await trtc.exitRoom();
// 若后续无需再使用该 trtc，则销毁 trtc，并释放引用。
trtc.destroy();
trtc = null;

Throws:

(async) startLocalAudio(configopt)

Examples

// 采集默认麦克风并发布
await trtc.startLocalAudio();

// 如下是测试麦克风音量的代码示例，可用于麦克风音量检测。
trtc.enableAudioVolumeEvaluation();
trtc.on(TRTC.EVENT.AUDIO_VOLUME, event => { });
// 测试麦克风无需发布音频
await trtc.startLocalAudio({ publish: false });
// 测试完毕后，关闭麦克风
await trtc.stopLocalAudio();

Parameters:

Throws:

(async) updateLocalAudio(configopt)

Example

// 切换麦克风
const microphoneList = await TRTC.getMicrophoneList();
if (microphoneList[1]) {
  await trtc.updateLocalAudio({ option: { microphoneId: microphoneList[1].deviceId }});
}

Parameters:

Throws:

(async) stopLocalAudio()

Example

await trtc.stopLocalAudio();

Throws:

(async) startLocalVideo(configopt)

Examples

示例 1：预览及发布摄像头

// 预览及发布摄像头
await trtc.startLocalVideo({
  view: document.getElementById('localVideo'), // 在 DOM 中的 elementId 为 localVideo 的标签上预览视频。
});

示例 2：测试摄像头——只预览不发布

// 只预览摄像头画面、不发布。可用于做摄像头测试。
const config = {
  view: document.getElementById('localVideo'), // 在 DOM 中的 elementId 为 localVideo 的标签上预览视频。
  publish: false // 不发布摄像头
}
await trtc.startLocalVideo(config);
// 当需要发布视频时调用 updateLocalVideo
await trtc.updateLocalVideo({ publish:true });

示例 3：预览及发布指定的摄像头

// 使用指定的摄像头。
// 在 DOM 中的 elementId 为 localVideo 的标签上预览视频。
const view = document.getElementById('localVideo');
const cameraList = await TRTC.getCameraList();
if (cameraList[0]) {
  await trtc.startLocalVideo({
    view,
    option: {
      cameraId: cameraList[0].deviceId,
    }
  });
}
// 在移动端指定使用前置摄像头
await trtc.startLocalVideo({ view, option: { useFrontCamera: true }});
// 在移动端指定使用后置摄像头
await trtc.startLocalVideo({ view, option: { useFrontCamera: false }});

Parameters:

Throws:

(async) updateLocalVideo(configopt)

Examples

示例 1：动态切换摄像头

// 切换摄像头
const cameraList = await TRTC.getCameraList();
if (cameraList[1]) {
  await trtc.updateLocalVideo({ option: { cameraId: cameraList[1].deviceId }});
}

示例 2：停止发布视频，但保持本地预览

// 停止发布视频，但保持本地预览
await trtc.updateLocalVideo({ publish:false });

Parameters:

Throws:

(async) stopLocalVideo()

Example

await trtc.stopLocalVideo();

Throws:

(async) startScreenShare(configopt)

Example

// 开始屏幕分享
await trtc.startScreenShare();

Parameters:

Throws:

(async) updateScreenShare(configopt)

Example

// 停止屏幕分享，但保持屏幕分享本地预览
await trtc.updateScreenShare({publish:false});

Parameters:

Throws:

(async) stopScreenShare()

Example

await trtc.stopScreenShare();

Throws:

(async) startRemoteVideo(configopt)

Example

trtc.on(TRTC.EVENT.REMOTE_VIDEO_AVAILABLE, ({ userId, streamType }) => {
  // 您需在 DOM 中提前放置视频容器，建议以 `${userId}_${streamType}` 作为 element id。
  trtc.startRemoteVideo({ userId, streamType, view: `${userId}_${streamType}` });
})

Parameters:

Throws:

(async) updateRemoteVideo(configopt)

Example

const config = {
 view: document.getElementById(userId), // 你可以传入新的 view 来更新 video 播放位置。
 userId,
 streamType: TRTC.TYPE.STREAM_TYPE_MAIN
}
await trtc.updateRemoteVideo(config);

Parameters:

Throws:

(async) stopRemoteVideo(config)

Example

// 停止播放所有远端用户
await trtc.stopRemoteVideo({ userId: '*' });

Parameters:

Throws:

(async) muteRemoteAudio(userId, mute)

Example

// 静音所有远端用户
await trtc.muteRemoteAudio('*', true);

Parameters:

Throws:

setRemoteAudioVolume(userId, volume)

Example

await trtc.setRemoteAudioVolume('123', 90);

Parameters:

(async) startPlugin(plugin, options) → {Promise.<void>}

Parameters:

Returns:

Type

Promise.<void>

(async) updatePlugin(plugin, options) → {Promise.<void>}

Parameters:

Returns:

Type

Promise.<void>

(async) stopPlugin(plugin, options) → {Promise.<void>}

Parameters:

Returns:

Type

Promise.<void>

enableAudioVolumeEvaluation(intervalopt, enableInBackgroundopt)

Example

trtc.on(TRTC.EVENT.AUDIO_VOLUME, event => {
   event.result.forEach(({ userId, volume }) => {
       const isMe = userId === ''; // 当 userId 为空串时，代表本地麦克风音量。
       if (isMe) {
           console.log(`my volume: ${volume}`);
       } else {
           console.log(`user: ${userId} volume: ${volume}`);
       }
   })
});
// 开启音量回调，并设置每 1000ms 触发一次事件
trtc.enableAudioVolumeEvaluation(1000);
// 如需关闭音量回调，传入 interval 值小于等于0即可
trtc.enableAudioVolumeEvaluation(-1);

Parameters:

on(eventName, handler, context)

Example

trtc.on(TRTC.EVENT.REMOTE_VIDEO_AVAILABLE, event => {
  // REMOTE_VIDEO_AVAILABLE event handler
});

Parameters:

off(eventName, handler, context)

Example

trtc.on(TRTC.EVENT.REMOTE_USER_ENTER, function peerJoinHandler(event) {
  // REMOTE_USER_ENTER event handler
  console.log('remote user enter');
  trtc.off(TRTC.EVENT.REMOTE_USER_ENTER, peerJoinHandler);
});
// 解除所有事件绑定
trtc.off('*');

Parameters:

getAudioTrack(configopt) → (nullable) {MediaStreamTrack}

Example

// Version before v5.4.3
trtc.getAudioTrack(); // 获取本地麦克风 audioTrack
trtc.getAudioTrack('remoteUserId'); // 获取远端 audioTrack
// Since v5.4.3+
trtc.getAudioTrack({ streamType: TRTC.STREAM_TYPE_SUB }); // 获取本地屏幕分享 audioTrack
// Since v5.8.2+
trtc.getAudioTrack({ processed: true }); // 获取处理后的 audioTrack

Parameters:

Returns:

Type

MediaStreamTrack

getVideoTrack(configopt) → {MediaStreamTrack|null}

Example

// 获取本地摄像头 videoTrack
const videoTrack = trtc.getVideoTrack();
// 获取本地屏幕分享 videoTrack
const screenVideoTrack = trtc.getVideoTrack({ streamType: TRTC.TYPE.STREAM_TYPE_SUB });
// 获取远端用户的主流 videoTrack
const remoteMainVideoTrack = trtc.getVideoTrack({ userId: 'test', streamType: TRTC.TYPE.STREAM_TYPE_MAIN });
// 获取远端用户的辅流 videoTrack
const remoteSubVideoTrack = trtc.getVideoTrack({ userId: 'test', streamType: TRTC.TYPE.STREAM_TYPE_SUB });
// Since v5.8.2+, 获取处理后的 videoTrack
const processedVideoTrack = trtc.getVideoTrack({ processed: true });

Parameters:

Returns:

Type

MediaStreamTrack | null

getVideoSnapshot()

Since:

• 5.4.0

Example

// 获取本地主流视频帧
trtc.getVideoSnapshot()
// 获取本地辅流视频帧
trtc.getVideoSnapshot({streamType:TRTC.TYPE.STREAM_TYPE_SUB})
// 获取远端主流视频帧
let frameData = trtc.getVideoSnapshot({userId: 'remote userId', streamType:TRTC.TYPE.STREAM_TYPE_MAIN})
// 显示视频帧
const img = document.createElement('img');
img.width = '640';
img.height = '480';
img.src = frameData;
document.body.appendChild(img);

Parameters:

sendSEIMessage(buffer, optionsopt)

Since:

• v5.3.0

See:

• TRTC.EVENT.SEI_MESSAGE

Example

// 1. 开启 SEI
const trtc = TRTC.create({
   enableSEI: true // 开启 SEI 收发功能
})
// 2. 推流端发送 SEI
try {
 await trtc.enterRoom({
  userId: 'user_1',
  roomId: 12345,
})
 await trtc.startLocalVideo();
 const unit8Array = new Uint8Array([1, 2, 3]);
 trtc.sendSEIMessage(unit8Array.buffer);
 // 消息已通过限制，等待后续视频帧发送。
} catch(error) {
 // 发送失败，可能原因：当前浏览器不支持、参数校验未通过、未推流、没推视频流、调用次数超出限制、使用非 H264 编码器等。
 console.warn(error);
}
// 3. 拉流端接收 SEI
trtc.on(TRTC.EVENT.SEI_MESSAGE, event => {
 console.warn(`收到 ${event.userId} 的 sei ${event.data}`);
})

Parameters:

sendCustomMessage(message)

Since:

• v5.6.0

See:

• TRTC.EVENT.CUSTOM_MESSAGE 监听该事件以接收消息

Example

// send custom message
trtc.sendCustomMessage({
  cmdId: 1,
  data: new TextEncoder().encode('hello').buffer
});
// receive custom message
trtc.on(TRTC.EVENT.CUSTOM_MESSAGE, event => {
   // event.userId: 远端发消息的 userId
   // event.cmdId: 您自定义的消息 Id
   // event.seq: 消息的序号
   // event.data: 消息内容，ArrayBuffer 类型
   console.log(`received custom msg from ${event.userId}, message: ${new TextDecoder().decode(event.data)}`)
})

Parameters:

(static) setLogLevel(levelopt, enableUploadLogopt)

Example

// 输出 DEBUG 以上日志等级
TRTC.setLogLevel(1);

Parameters:

(static) isSupported() → {Promise.<object>}

Example

TRTC.isSupported().then((checkResult) => {
  if(!checkResult.result) {
     console.log('checkResult', checkResult.result, 'checkDetail', checkResult.detail);
     // SDK 不支持当前浏览器，引导用户使用最新版的 Chrome 浏览器。
  }
});

Returns:

Type

Promise.<object>

(static) getCameraList(requestPermissionopt) → {Promise.<Array.<MediaDeviceInfo>>}

Example

const cameraList = await TRTC.getCameraList();
if (cameraList[0] && cameraList[0].getCapabilities) {
  const { width, height, frameRate, facingMode } = cameraList[0].getCapabilities();
  // 摄像头支持的最大分辨率、帧率。
  console.log(width.max, height.max, frameRate.max);
  // 在移动端区分该摄像头是前置还是后置。
  if (facingMode) {
    if (facingMode[0] === 'user') {
      // 前置摄像头
    } else if (facingMode[0] === 'environment') {
      // 后置摄像头
    }
  }
}

Parameters:

Returns:

Type

Promise.<Array.<MediaDeviceInfo>>

(static) getMicrophoneList(requestPermissionopt) → {Promise.<Array.<MediaDeviceInfo>>}

Example

const microphoneList = await TRTC.getMicrophoneList();
if (microphoneList[0] && microphoneList[0].getCapabilities) {
  const { channelCount } = microphoneList[0].getCapabilities();
  console.log(channelCount.max);
}

Parameters:

Returns:

Type

Promise.<Array.<MediaDeviceInfo>>

(static) getSpeakerList(requestPermissionopt) → {Promise.<Array.<MediaDeviceInfo>>}

Parameters:

Returns:

Type

Promise.<Array.<MediaDeviceInfo>>

(async, static) setCurrentSpeaker(speakerId)

Parameters: