TRTC

new TRTC()

The TRTC object is created using TRTC.create() and provides core real-time audio and video capabilities:

• Enter an audio and video room enterRoom()
• Exit the current audio and video room exitRoom()
• Preview/publish local video startLocalVideo()
• Capture/publish local audio startLocalAudio()
• Stop previewing/publishing local video stopLocalVideo()
• Stop capturing/publishing local audio stopLocalAudio()
• Watch remote video startRemoteVideo()
• Stop watching remote video stopRemoteVideo()
• Mute/unmute remote audio muteRemoteAudio()

The TRTC lifecycle is shown in the following figure:

Methods

(static) create() → {TRTC}

Example

// Create a TRTC object
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

// After entering the room successfully
// TRTC.TYPE.SCENE_LIVE interactive live streaming mode, audience switches to anchor
await trtc.switchRole(TRTC.TYPE.ROLE_ANCHOR);
// Switch from audience role to anchor role and start streaming
await trtc.startLocalVideo();
// TRTC.TYPE.SCENE_LIVE interactive live streaming mode, anchor switches to audience
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

// When the call is over
await trtc.exitRoom();
// If the trtc is no longer needed, destroy the trtc and release the reference.
trtc.destroy();
trtc = null;

Throws:

(async) startLocalAudio(configopt)

Examples

// Collect the default microphone and publish
await trtc.startLocalAudio();

// The following is a code example for testing microphone volume, which can be used for microphone volume detection.
trtc.enableAudioVolumeEvaluation();
trtc.on(TRTC.EVENT.AUDIO_VOLUME, event => { });
// No need to publish audio for testing microphone
await trtc.startLocalAudio({ publish: false });
// After the test is completed, turn off the microphone
await trtc.stopLocalAudio();

Parameters:

Throws:

(async) updateLocalAudio(configopt)

Example

// Switch microphone
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

// Preview and publish the camera
await trtc.startLocalVideo({
  view: document.getElementById('localVideo'), // Preview the video on the element with the DOM elementId of localVideo.
});

// Preview the camera without publishing. Can be used for camera testing.
const config = {
  view: document.getElementById('localVideo'), // Preview the video on the element with the DOM elementId of localVideo.
  publish: false // Do not publish the camera
}
await trtc.startLocalVideo(config);
// Call updateLocalVideo when you need to publish the video
await trtc.updateLocalVideo({ publish:true });

// Use a specified camera.
const cameraList = await TRTC.getCameraList();
if (cameraList[0]) {
  await trtc.startLocalVideo({
    view: document.getElementById('localVideo'), // Preview the video on the element with the DOM elementId of localVideo.
    option: {
      cameraId: cameraList[0].deviceId,
    }
  });
}
// use front camera on mobile device.
await trtc.startLocalVideo({ view, option: { useFrontCamera: true }});
// use rear camera on mobile device.
await trtc.startLocalVideo({ view, option: { useFrontCamera: false }});

Parameters:

Throws:

(async) updateLocalVideo(configopt)

Examples

// Switch camera
const cameraList = await TRTC.getCameraList();
if (cameraList[1]) {
  await trtc.updateLocalVideo({ option: { cameraId: cameraList[1].deviceId }});
}

// Stop publishing video, but keep local preview
await trtc.updateLocalVideo({ publish:false });

Parameters:

Throws:

(async) stopLocalVideo()

Example

await trtc.stopLocalVideo();

Throws:

(async) startScreenShare(configopt)

Example

// Start screen sharing
await trtc.startScreenShare();

Parameters:

Throws:

(async) updateScreenShare(configopt)

Example

// Stop screen sharing, but keep the local preview of screen sharing
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 }) => {
  // You need to place the video container in the DOM in advance, and it is recommended to use `${userId}_${streamType}` as the element id.
  trtc.startRemoteVideo({ userId, streamType, view: `${userId}_${streamType}` });
})

Parameters:

Throws:

(async) updateRemoteVideo(configopt)

Example

const config = {
 view: document.getElementById(userId),
 userId,
}
await trtc.updateRemoteVideo(config);

Parameters:

Throws:

(async) stopRemoteVideo(config)

Example

// Stop playing all remote users
await trtc.stopRemoteVideo({ userId: '*' });

Parameters:

Throws:

(async) muteRemoteAudio(userId, mute)

Example

// Mute all remote users
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, optionsopt) → {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 === ''; // When userId is an empty string, it represents the local microphone volume.
       if (isMe) {
           console.log(`my volume: ${volume}`);
       } else {
           console.log(`user: ${userId} volume: ${volume}`);
       }
   })
});
// Enable volume callback and trigger the event every 1000ms
trtc.enableAudioVolumeEvaluation(1000);
// To turn off the volume callback, pass in an interval value less than or equal to 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);
});
// Remove all event listeners
trtc.off('*');

Parameters:

getVideoTrack(configopt) → {MediaStreamTrack|null}

Example

// Get local camera videoTrack
const videoTrack = trtc.getVideoTrack();
// Get local screen sharing videoTrack
const screenVideoTrack = trtc.getVideoTrack({ streamType: TRTC.TYPE.STREAM_TYPE_SUB });
// Get remote user's main stream videoTrack
const remoteMainVideoTrack = trtc.getVideoTrack({ userId: 'test', streamType: TRTC.TYPE.STREAM_TYPE_MAIN });
// Get remote user's sub stream videoTrack
const remoteSubVideoTrack = trtc.getVideoTrack({ userId: 'test', streamType: TRTC.TYPE.STREAM_TYPE_SUB });

Parameters:

Returns:

Type

MediaStreamTrack | null

getAudioTrack(configopt) → (nullable) {MediaStreamTrack}

Example

// Version before v5.4.3
trtc.getAudioTrack(); // Get local microphone audioTrack, captured by trtc.startLocalAudio()
trtc.getAudioTrack('remoteUserId'); // Get remote audioTrack
// Since v5.4.3+, you can get local screen audioTrack by passing the streamType = TRTC.STREAM_TYPE_SUB
trtc.getAudioTrack({ streamType: TRTC.STREAM_TYPE_SUB });

Parameters:

Returns:

Type

MediaStreamTrack

sendSEIMessage(buffer, optionsopt)

Since:

• v5.3.0

See:

• TRTC.EVENT.SEI_MESSAGE

Example

// 1. enable SEI
const trtc = TRTC.create({
   enableSEI: true
})
// 2. send 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) {
 console.warn(error);
}
// 3. receive SEI
trtc.on(TRTC.EVENT.SEI_MESSAGE, event => {
 console.warn(`sei ${event.data} from ${event.userId}`);
})

Parameters:

getVideoSnapshot()

Since:

• 5.4.0

Example

// get self main stream video frame
trtc.getVideoSnapshot()
// get self sub stream video frame
trtc.getVideoSnapshot({streamType:TRTC.TYPE.STREAM_TYPE_SUB})
// get remote user main stream video frame
trtc.getVideoSnapshot({userId: 'remote userId', streamType:TRTC.TYPE.STREAM_TYPE_MAIN})

Parameters:

(static) setLogLevel(levelopt, enableUploadLogopt)

Example

// Output log levels above 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);
     // The SDK is not supported by the current browser, guide the user to use the latest version of Chrome browser.
  }
});

Returns:

Type

Promise.<object>

(static) getCameraList() → {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') {
      // front camera
    } else if (facingMode[0] === 'environment') {
      // rear camera
    }
  }
}

Returns:

Type

Promise.<Array.<MediaDeviceInfo>>

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

Example

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

Returns:

Type

Promise.<Array.<MediaDeviceInfo>>

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

Returns:

Type

Promise.<Array.<MediaDeviceInfo>>

(async, static) setCurrentSpeaker(speakerId)

Parameters: