Client

Methods

setProxyServer(url)

Example

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

Parameters:

setTurnServer(options)

Example

// v4.8.5 之前版本，仅支持设置一个 turn server
client.setTurnServer({ url: '192.168.0.110:3478', username: 'bob', credential: 'bobspassword', credentialType: 'password' });
// 自 v4.8.5 支持设置多个 turn server
client.setTurnServer([{ url: '192.168.0.110:3478', username: 'bob', credential: 'bobspassword', credentialType: 'password' }]);

Parameters:

(async) join(options) → {Promise}

Example

const client = TRTC.createClient({ mode: 'live', sdkAppId, userId, userSig });
client.join({ roomId: 8888, role: 'anchor' }).then(() => {
  // join room success
}).catch(error => {
  console.error('Join room failed: ' + error);
});

Parameters:

Throws:

Returns:

Type

Promise

(async) leave() → {Promise}

Example

client.leave().then(() => {
  // leaving room success
}).catch(error => {
  console.error('leaving room failed: ' + error);
});

Returns:

Type

Promise

publish(stream) → {Promise}

Example

localStream.initialize().then(() => {
  // 本地流初始化成功，发布本地流
  client.publish(localStream).then(() => {
    // 本地流发布成功
  });
});

Parameters:

Throws:

Returns:

Type

Promise

unpublish(stream) → {Promise}

Example

// 取消发布本地流
client.unpublish(localStream).then(() => {
  // 取消发布本地流成功
});

Parameters:

Throws:

Returns:

Type

Promise

(async) subscribe(stream, optionsopt)

Example

// 监听远端流订阅成功事件
client.on('stream-subscribed', event => {
  const remoteStream = event.stream;
  // 远端流订阅成功，播放远端音视频流
  remoteStream.play('remote_stream');
});
// 监听远端流增加事件
client.on('stream-added', event => {
  const remoteStream = event.stream;
  // 订阅远端音频和视频流
  client.subscribe(remoteStream, { audio: true, video: true }).catch(e => {
    console.error('failed to subscribe remoteStream');
  });

  // 仅订阅音频数据
  // client.subscribe(remoteStream, { audio: true, video: false }).catch(e => {
  //  console.error('failed to subscribe remoteStream');
  // });
});

Parameters:

Fires:

• ClientEvent.event:STREAM_SUBSCRIBED 订阅成功事件通知

Throws:

(async) unsubscribe(stream)

Example

client.on('stream-added', event => {
  const remoteStream = event.stream;
  // 拒绝接收该远端流所包含的任何音视频数据
  client.unsubscribe(remoteStream).catch(e => {
    console.error('failed to unsubscribe remoteStream');
  });
});

Parameters:

Throws:

(async) switchRole(role) → {Promise}

Example

// live 互动直播模式下，观众切换为主播
await client.switchRole('anchor');
// 观众角色切换为主播，开始推流
await client.publish(localStream);

// live 互动直播模式下，主播切换为观众
await client.switchRole('audience');

Parameters:

Throws:

Returns:

Type

Promise

on(eventName, handler, context)

Example

client.on('stream-added', event => {
  // stream-added event handler
});

Parameters:

off(eventName, handler, context)

Example

client.on('peer-join', function peerJoinHandler(event) {
  // peer-join event handler
  console.log('peer joined');

  client.off('peer-join', peerJoinHandler);
});

// 解除所有事件绑定
client.off('*');

Parameters:

getRemoteMutedState() → {Array.<RemoteMutedState>}

Returns:

Type

Array.<RemoteMutedState>

(async) getTransportStats() → {Promise.<TransportStats>}

Example

const stats = await client.getTransportStats();
console.log('uplink rtt: ' + stats.rtt);

// v4.10.1 版本开始支持获取下行 rtt
for (let userId in stats.downlinksRTT) {
   console.log('downlink rtt:' + stats.downlinksRTT[userId]);
}

Returns:

Type

Promise.<TransportStats>

(async) getLocalAudioStats() → {Promise.<LocalAudioStatsMap>}

Example

client.getLocalAudioStats().then(stats => {
  for (let userId in stats) {
    console.log('userId: ' + userId +
                ' bytesSent: ' + stats[userId].bytesSent +
                ' packetsSent: ' + stats[userId].packetsSent);
  }
});

Returns:

Type

Promise.<LocalAudioStatsMap>

(async) getLocalVideoStats() → {Promise.<LocalVideoStatsMap>}

Example

client.getLocalVideoStats().then(stats => {
  for (let userId in stats) {
    console.log('userId: ' + userId +
                'bytesSent: ' + stats[userId].bytesSent +
                'packetsSent: ' + stats[userId].packetsSent +
                'framesEncoded: ' + stats[userId].framesEncoded +
                'framesSent: ' + stats[userId].framesSent +
                'frameWidth: ' + stats[userId].frameWidth +
                'frameHeight: ' + stats[userId].frameHeight);
  }
});

Returns:

Type

Promise.<LocalVideoStatsMap>

(async) getRemoteAudioStats() → {Promise.<RemoteAudioStatsMap>}

Example

client.getRemoteAudioStats().then(stats => {
  for (let userId in stats) {
    console.log('userId: ' + userId +
                ' bytesReceived: ' + stats[userId].bytesReceived +
                ' packetsReceived: ' + stats[userId].packetsReceived +
                ' packetsLost: ' + stats[userId].packetsLost);
  }
});

Returns:

Type

Promise.<RemoteAudioStatsMap>

(async) getRemoteVideoStats(typeopt) → {Promise.<RemoteVideoStatsMap>}

Example

// 获取主流中摄像头视频的统计数据
const stats = await client.getRemoteVideoStats('main');

// 获取辅流中的屏幕分享的统计数据
const stats = await client.getRemoteVideoStats('auxiliary');

Parameters:

Returns:

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
       }
     ];
  }
  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',
        pureAudio: false,
        width: 640,
        height: 480,
        locationX: 0,
        locationY: 0,
        streamType: 'main', // 指明该配置为远端主流
        zOrder: 1
      },
      {
        userId: 'user_1',
        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}`);
    })
})

// 开启音量回调，并设置每 1000ms 触发一次事件
client.enableAudioVolumeEvaluation(1000);

// 如需关闭音量回调，传入 interval 值小于等于0即可
client.enableAudioVolumeEvaluation(-1);

Parameters: