TRTCCalling

// 为了减小 trtc-calling-js.js 的体积，避免和接入侧已使用的 trtc-js-sdk 和 tim-js-sdk 以及 tsignaling 发生版本冲突
// trtc-js-sdk 和 tim-js-sdk 以及 tsignaling 不再被打包到 trtc-calling-js.js，在使用前您需要手动安装依赖。
npm i trtc-js-sdk --save
npm i tim-js-sdk --save
npm i tsignaling --save
npm i trtc-calling-js --save

// 如果您通过 script 方式使用 trtc-calling-js，需要按顺序先手动引入 trtc.js
<script src="./trtc.js"></script>

// 接着手动引入 tim-js.js
<script src="./tim-js.js"></script>

// 然后手动引入 tsignaling.js
<script src="./tsignaling.js"></script>

// 最后再手动引入 trtc-calling-js.js
<script src="./trtc-calling-js.js"></script>

let options = {
  SDKAppID: 0, // 接入时需要将0替换为您的云通信应用的 SDKAppID
  // 从v0.10.2起，新增 tim 参数
  // tim 参数适用于业务中已存在 TIM 实例，为保证 TIM 实例唯一性
  tim: tim
};
let trtcCalling = new TRTCCalling(options);

Methods

setLogLevel(level)

Example

trtcCalling.setLogLevel(0);

Parameters:

on(eventName, callback, context)

Example

let onError = function(error) {
  console.log(error);
};
trtcCalling.on(TRTCCalling.EVENT.ERROR, onError, this);

Parameters:

off(eventName, callback, context)

Example

let onError = function(error) {
  console.log(error)
};
trtcCalling.off(TRTCCalling.EVENT.ERROR, onError, this);

Parameters:

login(params) → {Promise}

Example

let promise = trtcCalling.login({userID: 'your userID', userSig: 'your userSig'});
promise.then(() => {
  //success
}).catch(error => {
  console.warn('login error:', error)
});

Parameters:

Returns:

Type

Promise

logout() → {Promise}

Example

let promise = trtcCalling.logout();
promise.then(() => {
  //success
}).catch(error => {
  console.warn('logout error:', error)
});

Returns:

Type

Promise

call(params) → {Promise}

Example

// v1.0.0 之前
let promise = trtcCalling.call({userID: 'user1', type: 1, timeout: 30});

// v1.0.0 版本及其之后
const offlinePushInfo = {
  title: '',
  description: '您有一个通话请求',
  extension: ''
}
let promise = trtcCalling.call({userID: 'user1', type: 1, offlinePushInfo: offlinePushInfo});


promise.then(() => {
  //success
}).catch(error => {
  console.warn('call error:', error)
});

Parameters:

Returns:

Type

Promise

groupCall(params) → {Promise}

Example

// v1.0.0之前
let promise = trtcCalling.groupCall({userIDList: ['user1', 'user2'], type: 1, groupID: 'IM群组 ID'});

// v1.0.0及其之后
const offlinePushInfo = {
  title: '',
  description: '您有一个通话请求',
  extension: ''
}
let promise = trtcCalling.groupCall({userIDList: ['user1', 'user2'], type: 1, groupID: 'IM群组 ID', offlinePushInfo: offlinePushInfo});


promise.then(() => {
  //success
}).catch(error => {
  console.warn('groupCall error:', error)
});

Parameters:

Returns:

Type

Promise

accept(params) → {Promise}

Example

trtcCalling.on(TrtcCalling.EVENT.INVITED, ({inviteID, sponsor, inviteData}) => {
  let roomID = inviteData.roomID
  // v1.0.0之前
  let promise = trtcCalling.accept({inviteID: '38897dbf-ecd4-4b59-a132-bc31529a2b18', roomID: roomID, callType: 1});
  // v1.0.0及其之后
  let promise = trtcCalling.accept();
  promise.then(() => {
    //success
  }).catch(error => {
    console.warn('accept error:', error);
  });
});

Parameters:

Returns:

Type

Promise

reject(params)

Example

trtcCalling.on(TrtcCalling.EVENT.INVITED, ({inviteID, sponsor, inviteData}) => {
  // v1.0.0之前
  trtcCalling.reject({inviteID: 'user1', isBusy: true, callType: 1});
  // v1.0.0及其以后
  trtcCalling.reject();
});

Parameters:

hangup()

Example

trtcCalling.hangup();

startRemoteView(params) → {Promise}

Example

let promise = trtcCalling.startRemoteView({userID: 'user1', videoViewDomID: 'video_1'});
promise.then(() => {
  //success
}).catch(error => {
  console.warn('startRemoteView error:', error)
});

Parameters:

Returns:

Type

Promise

stopRemoteView(params)

Example

// v1.0.0之前
trtcCalling.stopRemoteView({userID: 'user1', videoViewDomID: 'video_1'});
// v1.0.0及其之后
trtcCalling.stopRemoteView({userID: 'user1'});

Parameters:

startLocalView(params) → {Promise}

Example

let promise = trtcCalling.startLocalView({userID: 'user1', videoViewDomID: 'video_1'});
promise.then(() => {
  //success
}).catch(error => {
  console.warn('startLocalView error:', error)
});

Parameters:

Returns:

Type

Promise

stopLocalView(params)

Example

// v1.0.0之前
trtcCalling.stopLocalView({userID: 'user1', videoViewDomID: 'video_1'});
// v1.0.0及其之后
trtcCalling.stopLocalView({userID: 'user1'});

Parameters:

openCamera()

Example

trtcCalling.openCamera().then(() => {
  //success
}).catch(error => {
  console.warn('openCamera error:', error)
});

closeCamera()

Example

trtcCalling.closeCamera().then(() => {
  //success
}).catch(error => {
  console.warn('closeCamera error:', error)
});

setMicMute(isMute)

Example

trtcCalling.setMicMute(true).then(() => {
  //success
}).catch(error => {
  console.warn('setMicMute error:', error)
});  // 开启麦克风

Parameters:

setVideoQuality(profile)

Example

const profile = '720p';
trtcCalling.setVideoQuality(profile).then(() => {
  //success
}).catch(error => {
  console.warn('setVideoQuality error:', error)
});  // 设置视频质量为720p

Parameters:

switchToAudioCall()

Example

let promise = trtcCalling.switchToAudioCall() // 视频通话切换语音通话
promise.then(() => {
  //success
}).catch(error => {
  console.warn('switchToVideoCall error:', error)
});

switchToVideoCall()

Example

let promise = trtcCalling.switchToVideoCall() // 语音通话切换视频通话
promise.then(() => {
  //success
}).catch(error => {
  console.warn('switchToVideoCall error:', error)
});

getCameras()

Example

trtcCalling.getCameras().then((devices)=>{
 console.log(devices)
}) // 获取摄像头列表

getMicrophones()

Example

trtcCalling.getMicrophones().then((devices)=>{
 console.log(devices)
}) // 获取麦克风列表

switchDevice(params)

Example

let promise = trtcCalling.switchDevice({deviceType: 'video', deviceId: cameras[0].deviceId}) // 切换设备
promise.then(() => {
  //success
}).catch(error => {
  console.warn('switchDevice error:', error)
});

Parameters:

setSelfInfo(params)

Example

let promise = trtcCalling.setSelfInfo({nickName: 'video', avatar:'http(s)://url/to/image.jpg'})
promise.then(() => {
  //success
}).catch(error => {
  console.warn('setSelfInfo error:', error)
});

Parameters: