TRTCCloud

// 创建/使用/销毁 TRTCCloud 对象的示例代码：
import TRTCCloud from 'trtc-electron-sdk';
const rtcCloud = TRTCCloud.getTRTCShareInstance();
// 获取 SDK 版本号
const version = rtcCloud.getSDKVersion();

Methods

(static) getTRTCShareInstance() → {TRTCCloud}

Returns:

Type

TRTCCloud

(static) destroyTRTCShareInstance()

createSubCloud() → {TRTCCloud}

Example

import TRTCCloud from 'trtc-electron-sdk';

const rtcCloud = TRTCCloud.getTRTCShareInstance();
rtcCloud.startLocalAudio(); // 主实例开启麦克风采集

const childRtcCloud = rtcCloud.createSubCloud();
childRtcCloud.startSystemAudioLoopback(); // 子实例开启系统音采集

Returns:

Type

TRTCCloud

getConfigObject() → {TRTCConfig}

Example

// Enable 'debug' mode
import TRTCCloud from 'trtc-electron-sdk';
const rtcCloud = TRTCCloud.getTRTCShareInstance();
rtcCloud.getConfigObject().setDebugMode(true);

Returns:

Type

TRTCConfig

destroy()

enterRoom(params, scene)

Parameters:

exitRoom()

switchRoom(params)

Parameters:

switchRole(role)

Parameters:

connectOtherRoom(params)

                房间 001                     房间 002
              -------------               ------------
 跨房连麦前：  | 主播 A      |             | 主播 B     |
             | 观众 U V W  |             | 观众 X Y Z |
              -------------               ------------

                房间 001                     房间 002
              -------------               ------------
 跨房连麦后：  | 主播 A B    |             | 主播 B A   |
             | 观众 U V W  |             | 观众 X Y Z |
              -------------               ------------

Example

let json = JSON.stringify({roomId: 2, userId: "userB"});
rtcCloud.connectOtherRoom(json);

Parameters:

disconnectOtherRoom()

setDefaultStreamRecvMode(autoRecvAudio, autoRecvVideo)

Parameters:

startPublishing(streamId, type)

Example

let trtcCloud = TRTCCloud.getTRTCShareInstance();
trtcCloud.enterRoom(params, TRTCAppScene.TRTCAppSceneLIVE);
trtcCloud.startLocalPreview(view);
trtcCloud.startLocalAudio(TRTCAudioQuality.TRTCAudioQualityDefault);
trtcCloud.startPublishing("user_stream_001", TRTCVideoStreamType.TRTCVideoStreamTypeBig);

Parameters:

stopPublishing()

startPublishCDNStream(param)

Parameters:

stopPublishCDNStream()

setMixTranscodingConfig(config)

【画面1】=> 解码 ====> \
                        \
【画面2】=> 解码 =>  画面混合 => 编码 => 【混合后的画面】
                        /
【画面3】=> 解码 ====> /

【声音1】=> 解码 ====> \
                        \
【声音2】=> 解码 =>  声音混合 => 编码 => 【混合后的声音】
                        /
【声音3】=> 解码 ====> /

Parameters:

startLocalPreview(views)

Parameters:

stopLocalPreview()

updateLocalView(views)

Parameters:

setCameraCaptureParams(params)

Parameters:

muteLocalVideo(mute, streamType)

Parameters:

setVideoMuteImage(imageBuffer, fps)

Parameters:

startRemoteView(userId, views, streamType)

Parameters:

stopRemoteView(userId, streamType)

Parameters:

updateRemoteView(userId, views, streamType)

Parameters:

stopAllRemoteView()

muteRemoteVideoStream(userId, mute, streamType)

Parameters:

muteAllRemoteVideoStreams(mute)

Parameters:

setVideoEncoderParam(params)

Parameters:

setNetworkQosParam(params)

Parameters:

setLocalRenderParams(params)

Parameters:

setLocalViewFillMode(mode)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setLocalRenderParams 接口替代。

Parameters:

setRemoteRenderParams(userId, streamType, params)

Parameters:

setRemoteViewFillMode(userId, mode)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setRemoteRenderParams 接口替代。

Parameters:

setLocalViewRotation(rotation)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setLocalRenderParams 接口替代。

Parameters:

setRemoteViewRotation(userId, rotation)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setRemoteRenderParams 接口替代。

Parameters:

setVideoEncoderRotation(rotation)

Parameters:

setLocalViewMirror(mirror)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setLocalRenderParams 接口替代。

Parameters:

setVideoEncoderMirror(mirror)

Parameters:

enableSmallVideoStream(enable, params)

Parameters:

setRemoteVideoStreamType(userId, streamType)

Parameters:

snapshotVideo(userId, streamType)

Parameters:

setPriorRemoteVideoStreamType(type)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 startRemoteView 接口设置视频流类型参数进行替代。

Parameters:

startLocalRecording(options)

Parameters:

stopLocalRecording()

startLocalAudio(quality)

Parameters:

stopLocalAudio()

muteLocalAudio(mute)

Parameters:

muteRemoteAudio(userId, mute)

Parameters:

muteAllRemoteAudio(mute)

Parameters:

setRemoteAudioVolume(userId, volume)

Parameters:

setAudioCaptureVolume(volume)

Parameters:

getAudioCaptureVolume() → {Number}

Returns:

Type

Number

setAudioPlayoutVolume(volume)

Parameters:

getAudioPlayoutVolume() → {Number}

Returns:

Type

Number

enableAudioVolumeEvaluation(interval)

Parameters:

startAudioRecording(params) → {Number}

Parameters:

Returns:

Type

Number

stopAudioRecording()

setRemoteAudioParallelParams(param)

Parameters:

setAudioQuality(quality)

Parameters:

setMicVolumeOnMixing(volume)

Deprecated:

• 从 TRTCSDK6.9 后该接口已被废弃，请使用 setAudioCaptureVolume 接口替代。

Parameters:

getCameraDevicesList() → {Array.<TRTCDeviceInfo>}

Example

var cameralist = rtcCloud.getCameraDevicesList();
for (i=0;i<cameralist.length;i++) {
   var camera = cameralist[i];
   console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
}

Returns:

Type

Array.<TRTCDeviceInfo>

setCurrentCameraDevice(deviceId)

Parameters:

getCurrentCameraDevice() → {TRTCDeviceInfo}

Returns:

Type

TRTCDeviceInfo

getMicDevicesList() → {Array.<TRTCDeviceInfo>}

Example

var miclist = rtcCloud.getMicDevicesList();
  for (i=0;i<miclist.length;i++) {
    var mic = miclist[i];
    console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
  }

Returns:

Type

Array.<TRTCDeviceInfo>

getCurrentMicDevice() → {TRTCDeviceInfo}

Returns:

Type

TRTCDeviceInfo

setCurrentMicDevice(micId)

Parameters:

getCurrentMicDeviceVolume() → {Number}

Returns:

Type

Number

setCurrentMicDeviceVolume(volume)

Parameters:

setCurrentMicDeviceMute(mute)

Parameters:

getCurrentMicDeviceMute() → {Boolean}

Returns:

Type

Boolean

getSpeakerDevicesList() → {Array.<TRTCDeviceInfo>}

Example

var speakerlist = rtcCloud.getSpeakerDevicesList();
  for (i=0;i<speakerlist.length;i++) {
    var speaker = speakerlist[i];
    console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
  }

Returns:

Type

Array.<TRTCDeviceInfo>

getCurrentSpeakerDevice() → {TRTCDeviceInfo}

Returns:

Type

TRTCDeviceInfo

setCurrentSpeakerDevice(speakerId)

Parameters:

getCurrentSpeakerVolume() → {Number}

Returns:

Type

Number

setCurrentSpeakerVolume(volume)

Parameters:

setCurrentSpeakerDeviceMute(mute)

Parameters:

getCurrentSpeakerDeviceMute() → {Boolean}

Returns:

Type

Boolean

enableFollowingDefaultAudioDevice(deviceType, enable)

Parameters:

setBeautyStyle(style, beauty, white, ruddiness)

Parameters:

setWaterMark(streamType, srcData, srcType, nWidth, nHeight, xOffset, yOffset, fWidthRatio)

Parameters:

startRemoteSubStreamView(userId, view)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 startRemoteView 接口替代。 注意：请在 onUserSubStreamAvailable 回调后再调用这个接口。

Parameters:

stopRemoteSubStreamView(userId)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 stopRemoteView 接口替代。

Parameters:

setRemoteSubStreamViewFillMode(userId, mode)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setRemoteRenderParams 接口替代。

Parameters:

setRemoteSubStreamViewRotation(userId, rotation)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setRemoteRenderParams 接口替代。

Parameters:

getScreenCaptureSources(thumbWidth, thumbHeight, iconWidth, iconHeight) → {Array.<TRTCScreenCaptureSourceInfo>}

Parameters:

Returns:

Type

Array.<TRTCScreenCaptureSourceInfo>

selectScreenCaptureTarget(source, captureRect, property)

Examples

// 示例1: 选择要分享的窗口或屏幕，9.3 以后版本推荐此方式
import TRTCCloud, {
 Rect,
 TRTCScreenCaptureProperty
} from 'trtc-electron-sdk';

const rtcCloud = TRTCCloud.getTRTCShareInstance();

const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);

const selectedScreenOrWindow = screenAndWindows[0];

const selectRect = new Rect(0, 0, 0, 0);

const captureProperty = new TRTCScreenCaptureProperty(
 true, // enable capture mouse
 true, // enable highlight
 true, // enable high performance
 0xFF66FF, // highlight color.
 8, // highlight width
 false // disable capture child window
);

rtcCloud.selectScreenCaptureTarget(
 selectedScreenOrWindow,
 selectRect,
 captureProperty
);

// 示例2: 选择要分享的窗口或屏幕，9.3 及之前版本只能使用此方式
import TRTCCloud, { Rect } from 'trtc-electron-sdk';

const rtcCloud = TRTCCloud.getTRTCShareInstance();

const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);

const selectedScreenOrWindow = screenAndWindows[0];

const selectRect = new Rect(0, 0, 0, 0);

rtcCloud.selectScreenCaptureTarget(
 selectedScreenOrWindow.type,
 selectedScreenOrWindow.sourceId,
 selectedScreenOrWindow.sourceName,
 selectRect,
 true, // enable capture mouse
 true // enable highlight
);

Parameters:

startScreenCapture(view, type, params)

Example

// 分享屏幕或窗口
import TRTCCloud, {
 TRTCVideoStreamType,
 TRTCVideoEncParam,
 TRTCVideoResolution,
 TRTCVideoResolutionMode
} from 'trtc-electron-sdk';

const rtcCloud = TRTCCloud.getTRTCShareInstance();

const screenAndWindows = rtcCloud.getScreenCaptureSources(320, 180, 32, 32);

const selectedScreenOrWindow = screenAndWindows[0];

const selectRect = new Rect(0, 0, 0, 0);

const captureProperty = new TRTCScreenCaptureProperty(
 true, // enable capture mouse
 true, // enable highlight
 true, // enable high performance
 0, // default highlight color
 0, // default highlight width
 false // disable capture child window
);

rtcCloud.selectScreenCaptureTarget(
 selectedScreenOrWindow,
 selectRect,
 captureProperty
);

const screenShareEncParam = new TRTCVideoEncParam(
 TRTCVideoResolution.TRTCVideoResolution_1280_720,
 TRTCVideoResolutionMode.TRTCVideoResolutionModeLandscape,
 15,
 1600,
 0,
 true,
);

rtcCloud.startScreenCapture(
 view, // HTML Element
 TRTCVideoStreamType.TRTCVideoStreamTypeSub,
 screenShareEncParam,
);

Parameters:

pauseScreenCapture()

resumeScreenCapture()

stopScreenCapture()

setSubStreamEncoderParam(params)

Parameters:

setSubStreamMixVolume(volume)

Parameters:

addExcludedShareWindow(win)

Parameters:

removeExcludedShareWindow(win)

Parameters:

removeAllExcludedShareWindow()

addIncludedShareWindow(win)

Parameters:

removeIncludedShareWindow(win)

Parameters:

removeAllIncludedShareWindow()

enableCustomAudioCapture(enable)

Parameters:

sendCustomAudioData(frame)

Parameters:

enableMixExternalAudioFrame(enablePublish, enablePlayout)

Parameters:

mixExternalAudioFrame(frame) → {Number}

Parameters:

Returns:

Type

Number

setMixExternalAudioVolume(publishVolume, playoutVolume)

Parameters:

generateCustomPTS() → {Number}

Returns:

Type

Number

setAudioFrameCallback(callback)

Example

import TRTCCloud from 'trtc-electron-sdk';

const rtcCloud = TRTCCloud.getTRTCShareInstance();

onCapturedAudioFrame(frame: TRTCAudioFrame) {}
onLocalProcessedAudioFrame(frame: TRTCAudioFrame) {}
onPlayAudioFrame(frame: TRTCAudioFrame, userId: string) {}
onMixedPlayAudioFrame(frame: TRTCAudioFrame) {}
onMixedAllAudioFrame(frame: TRTCAudioFrame) {}

// 设置音频数据自定义回调
rtcCloud.setAudioFrameCallback({
  onCapturedAudioFrame: onCapturedAudioFrame,
  onLocalProcessedAudioFrame: onLocalProcessedAudioFrame,
  onPlayAudioFrame: onPlayAudioFrame,
  onMixedPlayAudioFrame: onMixedPlayAudioFrame,
  onMixedAllAudioFrame: onMixedAllAudioFrame,
});

// 取消音频数据自定义回调
rtcCloud.setAudioFrameCallback({
  onCapturedAudioFrame: null,
  onLocalProcessedAudioFrame: null,
  onPlayAudioFrame: null,
  onMixedPlayAudioFrame: null,
  onMixedAllAudioFrame: null,
});

Parameters:

sendCustomCmdMsg(cmdId, msg, reliable, ordered) → {Boolean}

Parameters:

Returns:

Type

Boolean

sendSEIMsg(msg, repeatCount) → {Boolean}

Parameters:

Returns:

Type

Boolean

playBGM(path)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 startPlayMusic 接口替代。

Parameters:

stopBGM()

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 stopPlayMusic 接口替代。

pauseBGM()

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 pausePlayMusic 接口替代。

resumeBGM()

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 resumePlayMusic 接口替代。

getBGMDuration(path) → {Number}

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 getMusicDurationInMS 接口替代。

Parameters:

Returns:

Type

Number

setBGMPosition(pos)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 seekMusicToPosInTime 接口替代。

Parameters:

setBGMVolume(volume)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setAllMusicVolume 接口替代。

Parameters:

setBGMPlayoutVolume(volume)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setMusicPlayoutVolume 接口替代。

Parameters:

setBGMPublishVolume(volume)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setMusicPublishVolume 接口替代。

Parameters:

startSystemAudioLoopback(path)

Parameters:

stopSystemAudioLoopback()

setSystemAudioLoopbackVolume(volume)

Parameters:

setMusicObserver(observer)

Parameters:

startPlayMusic(musicParam, observeropt)

Example

import TRTCCloud, { AudioMusicParam } from 'trtc-electron-sdk';
const rtcCloud = TRTCCloud.getTRTCShareInstance();

// 设置背景音乐播放事件监听
rtcCloud.setMusicObserver({
     onStart: (id: number, errCode: number) => {
       console.log(`onStart, id: ${id}, errorCode: ${errCode}`);
     },
     onPlayProgress: (id: number, curPtsMS: number, durationMS: number) => {
       console.log(`onPlayProgress, id: ${id}, curPtsMS: ${curPtsMS}, durationMS: ${durationMS}`);
     },
     onComplete: (id: number, errCode: number) => {
         console.log(`onComplete, id: ${id}, errCode: ${errCode}`);
     }
});

// 开始播放背景音乐
const params = new AudioMusicParam();
params.id = 1;
params.path = 'path';
params.publish = true;
rtcCloud.startPlayMusic(params);

Parameters:

stopPlayMusic(id)

Parameters:

pausePlayMusic(id)

Parameters:

resumePlayMusic(id)

Parameters:

getMusicDurationInMS(path) → {Number}

Parameters:

Returns:

Type

Number

seekMusicToPosInTime(id, pts)

Parameters:

setAllMusicVolume(volume)

Parameters:

setMusicPlayoutVolume(id, volume)

Parameters:

setMusicPublishVolume(id, volume)

Parameters:

enableVoiceEarMonitor(enable)

Parameters:

setVoiceEarMonitorVolume(volumn)

Parameters:

setVoiceCaptureVolume(volume)

Parameters:

setVoicePitch(pitch)

Parameters:

setVoiceReverbType(type)

Parameters:

setVoiceChangerType(type)

Parameters:

playAudioEffect(effect)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 startPlayMusic 接口替代。

Parameters:

Throws:

setAudioEffectVolume(effectId, volume)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setMusicPublishVolume, setMusicPlayoutVolume 接口替代。

Parameters:

stopAudioEffect(effectId)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 stopPlayMusic 接口替代。

Parameters:

stopAllAudioEffects()

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃

setAllAudioEffectsVolume(volume)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 setAllMusicVolume 接口替代。

Parameters:

pauseAudioEffect(effectId)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 pausePlayMusic 接口替代。

Parameters:

resumeAudioEffect(effectId)

Deprecated:

• 从 TRTCSDK 8.0 后该接口已被废弃，请使用 resumePlayMusic 接口替代。

Parameters:

startSpeedTest(params)

Parameters:

Returns:

stopSpeedTest()

startCameraDeviceTest(view)

Parameters:

stopCameraDeviceTest()

startMicDeviceTest(interval, playbackopt)

Parameters:

stopMicDeviceTest()

startSpeakerDeviceTest(testAudioFilePath)

Parameters:

stopSpeakerDeviceTest()

getSDKVersion() → {String}

Returns:

Type

String

setLogLevel(level)

Parameters:

setConsoleEnabled(enabled)

Parameters:

setLogCompressEnabled(enabled)

Parameters:

setLogDirPath(path)

Parameters:

setLogCallback(callback)

Parameters:

callExperimentalAPI(jsonStr)

Parameters:

setRenderMode(mode)

Deprecated:

• 从 10.3.403 版本该接口被废弃。SDK 内部会根据视频流数据，自动选择合适的渲染方式，可能的渲染方式有 WebGL、Canvas 2D、video 标签。调用该接口不再修改视频的渲染方式。

Parameters:

setPluginParams(type, config)

Parameters:

addPlugin(options) → {TRTCPluginInfo}

Parameters:

Returns:

Type

TRTCPluginInfo

removePlugin(id, deviceIdopt)

Parameters:

setPluginCallback(pluginCb)

Parameters:

initPluginManager(optionsopt)

Deprecated:

• 请使用 setPluginParams 接口
  启动美颜插件管理器，并设置视频在美颜处理时的像素格式和数据传递方式。

Parameters:

destroyPluginManager()

Deprecated:

• 请使用 setPluginParams 接口