Client

Type

Promise.<RemoteVideoStatsMap>

(async) startPublishCDNStream(options) → {Promise}

Since:

• 4.10.0

Example

// example 1：“全局自动旁路”模式下，修改当前用户音视频流在腾讯云 CDN 对应的 StreamId
let options = { streamId: 'user_stream_001' }
client.startPublishCDNStream(options);
// example 2：“指定流旁路”模式下，以默认 streamId: ${sdkAppId}_${roomId}_${userId}_main 发布当前用户音视频流到腾讯云 CDN
client.startPublishCDNStream();
// example 3：“指定流旁路”模式下，以指定 streamId 发布当前用户音视频流到腾讯云 CDN
let options = { streamId: 'user_stream_001' }
client.startPublishCDNStream(options);
// example 4: 将当前用户音视频流发布到指定的 CDN 地址
// 说明：如有需要，example 4 可以和 example1，2，3 结合使用
let options = {
 appId: 0,
 bizId: 0,
 url: ''
}
client.startPublishCDNStream(options);

Parameters:

Returns:

Type

Promise

(async) stopPublishCDNStream() → {Promise}

Since:

• v4.10.0

Example

client.stopPublishCDNStream();

Returns:

Type

Promise

(async) startMixTranscode(config) → {Promise}

Since:

• v4.8.0

Examples

try {
 // 预排版模式，自 v4.9.0 版本开始支持
 const config = {
    mode: 'preset-layout',
    videoWidth: 1280,
    videoHeight: 720,
    videoBitrate: 1500,
    videoFramerate: 15,
    videoGOP: 2,
    audioSampleRate: 48000,
    audioBitrate: 64,
    audioChannels: 1,
    // 预设一路本地摄像头、一路本地屏幕分享、两路远端流的排版位置
    mixUsers: [
       {
         width: 960,
         height: 720,
         locationX: 0,
         locationY: 0,
         pureAudio: false,
         userId: 'share_123456', // 本地屏幕分享占位，填写用于推屏幕分享流的 client userId
         zOrder: 1
       },
       {
         width: 320,
         height: 240,
         locationX: 960,
         locationY: 0,
         pureAudio: false,
         userId: '123456', // 本地摄像头占位，填写用于推摄像头流的 client userId
         zOrder: 1
       },
       {
         width: 320,
         height: 240,
         locationX: 960,
         locationY: 240,
         pureAudio: false,
         userId: '$PLACE_HOLDER_REMOTE$', // 远端流占位
         zOrder: 1
       },
       {
         width: 320,
         height: 240,
         locationX: 960,
         locationY: 480,
         pureAudio: false,
         userId: '$PLACE_HOLDER_REMOTE$', // 远端流占位
         zOrder: 1
       },
       {
         width: 320,
         height: 240,
         locationX: 960,
         locationY: 720,
         pureAudio: false,
         userId: 'user_355624',
         roomId: 355624,  // roomId 字段自 v4.11.5 版本开始支持，支持跨房间混流
         zOrder: 1,
       },
     ];
  }
  await client.startMixTranscode(config);
} catch (e) {
  console.error('startMixTranscode failed ', e);
}

// 全手动模式 自 v4.8.0 版本开始支持
try {
  const config = {
    mode: 'manual',
    videoWidth: 1280,
    videoHeight: 720,
    videoBitrate: 1500,
    videoFramerate: 15,
    mixUsers: [
      {
        userId: 'user_1',
        roomId: 12345, // roomId 字段自 v4.11.5 版本开始支持，支持跨房间混流
        pureAudio: false,
        width: 640,
        height: 480,
        locationX: 0,
        locationY: 0,
        streamType: 'main', // 指明该配置为远端主流
        zOrder: 1
      },
      {
        userId: 'user_1',
        roomId: 12345, // roomId 字段自 v4.11.5 版本开始支持，支持跨房间混流
        pureAudio: false,
        width: 640,
        height: 480,
        locationX: 640,
        locationY: 0,
        streamType: 'auxiliary', // 指明该配置为远端辅流
        zOrder: 1
      },
    ]
  }
  await client.startMixTranscode(config);
} catch (error) {
  console.error('startMixTranscode failed: ', error);
}

Parameters:

Returns:

Type

Promise

(async) stopMixTranscode()

Since:

• v4.8.0

Example

// 停止混流转码
try {
 await client.stopMixTranscode();
} catch (e) {
 console.error('stopMixTranscode fail', e);
}

enableAudioVolumeEvaluation(intervalopt, enableInBackgroundopt)

Since:

• v4.9.0

Example

client.on('audio-volume', event => {
    event.result.forEach(({ userId, audioVolume, stream }) => {
        console.log(`userId: ${userId}, audioVolume: ${audioVolume}`);
    })
})
// Enable volume callback and set the SDK to trigger the volume callback event at an interval of 1000 ms
client.enableAudioVolumeEvaluation(1000);
// To disable volume callback, you only need to pass in a value less than or equal to 0 for `interval`
client.enableAudioVolumeEvaluation(-1);

Parameters:

(async) enableSmallStream() → {Promise}

Since:

• 4.11.0

Example

// Enable the small stream mode
await client.enableSmallStream();
// Local stream initialized successfully
await localStream.initialize();
// Publish a local stream
await client.publish(localStream);

Throws:

Returns:

Type

Promise

(async) disableSmallStream() → {Promise}

Since:

• 4.11.0

Example

await client.unpublish(localStream);
await client.disableSmallStream();

Throws:

Returns:

Type

Promise

setSmallStreamProfile(options)

Since:

• 4.11.0

Example

client.setSmallStreamProfile({
  width: 160,
  height: 120,
  bitrate: 100,
  frameRate: 15
});

Parameters:

setRemoteVideoStreamType(remoteStream, status)

Since:

• 4.11.0

Example

// Set the big/small stream attribute for the remote stream
client.setRemoteVideoStreamType(remoteStream, 'small');

Parameters:

Throws:

sendSEIMessage(buffer, optionsopt)

Since:

• v4.14.1

Example

// 1. enable SEI
const client = TRTC.createClient({
   sdkAppId: 24215236, // fake sdkAppId
   userId: 'test',
   userSig: 'fake',
   enableSEI: true // enable SEI
})
// 2. send SEI
try {
 const unit8Array = new Uint8Array([1, 2, 3]);
 client.sendSEIMessage(unit8Array.buffer);
 // SEI message will be sent along with next video frame.
} catch(error) {
 // Failed to send, reasons:
 // - not support on current browser.
 // - client has not publish localStream or localStream has no video.
 // - api call times or max buffer size in a second is over the limitation.
 // - without using H264 codec.
 // etc.
 console.warn(error);
}
// 3. received SEI message
client.on('sei-message', event => {
 console.warn(`received ${event.userId} sei message ${event.data}`);
})

Parameters:

setProxyServer(url)

Example

client.setProxyServer('wss://proxy.example.com:443');

Parameters:

setTurnServer(options)

Example

// For versions earlier than v4.8.5, this API can be used to set only one TURN server
client.setTurnServer({ url: '192.168.0.110:3478', username: 'bob', credential: 'bobspassword', credentialType: 'password' });
// For v4.8.5 and later versions, this API can be used to set multiple TURN servers
client.setTurnServer([{ url: '192.168.0.110:3478', username: 'bob', credential: 'bobspassword', credentialType: 'password' }]);

Parameters: