Tencent Cloud 영상 통화 기능의 주요 인터페이스.
const TRTCCloud = require('trtc-electron-sdk').default;
// import TRTCCloud from 'trtc-electron-sdk';
this.rtcCloud = new TRTCCloud();
v7.9.348부터 TRTC Electron SDK에 typescript를 사용하는 개발자에게 편리한 trtc.d.ts 파일이 추가되었습니다.
import TRTCCloud from 'trtc-electron-sdk';
const rtcCloud: TRTCCloud = new TRTCCloud();
// SDK 버전 가져오기
rtcCloud.getSDKVersion();
subscribeEvents = (rtcCloud) => {
rtcCloud.on('onError', (errcode, errmsg) => {
console.info('trtc_demo: onError :' + errcode + " msg" + errmsg);
});
rtcCloud.on('onEnterRoom', (elapsed) => {
console.info('trtc_demo: onEnterRoom elapsed:' + elapsed);
});
rtcCloud.on('onExitRoom', (reason) => {
console.info('onExitRoom: userenter reason:' + reason);
});
};
subscribeEvents(this.rtcCloud);
API | 설명 |
---|---|
getTRTCShareInstance | dll 동적 로딩 시, TRTCCloud 객체 싱글톤 생성에 사용 |
destroyTRTCShareInstance | TRTCCloud 싱글톤 객체를 릴리스하고 리소스를 정리 |
API | 설명 |
---|---|
enterRoom | 방 입장. 방이 없으면 시스템에서 자동으로 생성. |
exitRoom | 방 퇴장 |
switchRoom | 방 전환 |
switchRole | 역할 전환. 라이브 방송 시나리오(TRTCAppSceneLIVE 및 TRTCAppSceneVoiceChatRoom)에만 적용. |
connectOtherRoom | 크로스 룸 마이크 연결(호스트 크로스 룸 PK) 요청 |
disconnectOtherRoom | 크로스 룸 마이크 연결(호스트 크로스 룸 PK) 비활성화 |
setDefaultStreamRecvMode | 오디오 및 비디오 데이터 수신 모드를 설정합니다(방 입장 전 설정 시 적용됨). |
API | 설명 |
---|---|
startPublishing | Tencent Cloud 라이브 방송 CDN에 푸시 스트림 시작 |
stopPublishing | Tencent Cloud 라이브 방송 CDN에 푸시 스트림 중지 |
startPublishCDNStream | Tencent Cloud 이외의 라이브 스트리밍 CDN에 게시 시작 |
stopPublishCDNStream | Tencent Cloud 이외의 라이브 스트리밍 CDN에 게시 중지 |
setMixTranscodingConfig | 클라우드 혼합 스트림 트랜스 코딩 매개변수 설정 |
API | 설명 |
---|---|
startLocalPreview | 로컬 카메라 캡처 및 미리보기 시작 |
stopLocalPreview | 로컬 카메라 캡처 및 미리보기 중지 |
muteLocalVideo | 사용자 영상 화면 차단 여부 확인 |
startRemoteView | 원격 비디오 화면 표시 시작 |
stopRemoteView | 원격 영상 화면 표시 중지 및 원격 사용자의 비디오 데이터 스트림 풀링 중지 |
stopAllRemoteView | 모든 영상 화면 표시 중지 및 원격 사용자의 비디오 데이터 스트림 풀링 중지 |
muteRemoteVideoStream | 지정 원격 비디오 스트림 수신 일시 중지 |
muteAllRemoteVideoStreams | 모든 원격 비디오 스트림 수신 중지 |
setVideoEncoderParam | 비디오 인코더 관련 매개변수 설정 |
setNetworkQosParam | 네트워크 트래픽 제어 관련 매개변수 설정 |
setLocalRenderParams | 로컬 이미지(메인 스트림)의 렌더링 매개변수 설정 |
setLocalViewFillMode | 폐기된 인터페이스: 로컬 이미지 렌더링 모드 설정 |
setRemoteRenderParams | 원격 이미지의 렌더링 매개변수 설정 |
setRemoteViewFillMode | 폐기된 인터페이스: 원격 이미지 렌더링 모드 설정 |
setLocalViewRotation | 폐기된 인터페이스: 로컬 이미지의 시계 방향 회전 각도 설정 |
setRemoteViewRotation | 폐기된 인터페이스: 원격 이미지의 시계 방향 회전 각도 설정 |
setVideoEncoderRotation | 비디오 인코딩 출력(원격 사용자가 시청하고 서버에 녹화된) 화면 방향 설정 |
setLocalViewMirror | 폐기된 인터페이스: 로컬 카메라 화면 미리보기 이미지 모드 설정 |
setVideoEncoderMirror | 인코더로 출력된 화면의 이미지 모드 설정 |
enableSmallVideoStream | 크고 작은 이미지의 이중 채널 인코딩 모드 활성화 |
setRemoteVideoStreamType | 지정 userId의 화면(큰 이미지/작은 이미지) 선택 |
setPriorRemoteVideoStreamType | 폐기된 인터페이스: 시청자 비디오 품질 우선 순위 설정 |
snapshotVideo | 영상 화면 캡처 |
API | 설명 |
---|---|
startLocalAudio | 로컬 오디오 수집 및 업스트림 활성화 |
stopLocalAudio | 로컬 오디오 수집 및 업스트림 비활성화 |
muteLocalAudio | 로컬 오디오 음소거 |
muteRemoteAudio | 특정 사용자의 오디오를 음소거하고 해당 원격 사용자의 오디오 데이터 스트림 풀링 중지 |
muteAllRemoteAudio | 모든 사용자의 오디오를 음소거하고 원격 사용자의 오디오 데이터 스트림 풀링 중지 |
setAudioCaptureVolume | SDK 수집 볼륨 설정 |
getAudioCaptureVolume | SDK 수집 볼륨 가져오기 |
setAudioPlayoutVolume | SDK 재생 볼륨 설정 |
getAudioPlayoutVolume | SDK 재생 볼륨 가져오기 |
enableAudioVolumeEvaluation | 볼륨 크기 알람 활성화/비활성화 |
startAudioRecording | 녹음 시작 |
stopAudioRecording | 녹음 중지 |
setAudioQuality | 폐기된 인터페이스: 볼륨 품질 설정 |
setRemoteAudioVolume | 원격 사용자의 재생 볼륨 설정 |
API | 설명 |
---|---|
getCameraDevicesList | 카메라 디바이스 리스트 가져오기 |
setCurrentCameraDevice | 사용할 카메라 설정 |
getCurrentCameraDevice | 현재 사용하는 카메라 가져오기 |
API | 설명 |
---|---|
getMicDevicesList | 마이크 디바이스 리스트 가져오기 |
getCurrentMicDevice | 현재 선택한 마이크 가져오기 |
setCurrentMicDevice | 사용할 마이크 설정 |
getCurrentMicDeviceVolume | 시스템의 현재 마이크 디바이스 볼륨 가져오기 |
setCurrentMicDeviceVolume | 시스템의 현재 마이크 디바이스 볼륨 설정 |
setCurrentMicDeviceMute | 시스템의 현재 마이크 디바이스 음소거 상태 설정 |
getCurrentMicDeviceMute | 시스템의 현재 마이크 디바이스 음소거 여부 가져오기 |
getSpeakerDevicesList | 스피커 디바이스 리스트 가져오기 |
getCurrentSpeakerDevice | 현재 스피커 디바이스 가져오기 |
setCurrentSpeakerDevice | 사용할 스피커 설정 |
getCurrentSpeakerVolume | 시스템의 현재 스피커 디바이스 볼륨 가져오기 |
setCurrentSpeakerVolume | 시스템의 현재 스피커 디바이스 볼륨 설정 |
setCurrentSpeakerDeviceMute | 시스템의 현재 스피커 디바이스 음소거 상태 설정 |
getCurrentSpeakerDeviceMute | 시스템의 현재 스피커 디바이스 음소거 여부 가져오기 |
API | 설명 |
---|---|
setBeautyStyle | 뷰티 필터, 미백, 안색 보정 효과 레벨 설정 |
setWaterMark | 워터마크 설정 |
API | 설명 |
---|---|
startRemoteSubStreamView | 폐기된 인터페이스: 원격 사용자의 서브스트림(화면 공유) 화면 렌더링 시작 |
stopRemoteSubStreamView | 폐기된 인터페이스: 원격 사용자의 서브스트림(화면 공유) 화면 렌더링 중지 |
setRemoteSubStreamViewFillMode | 폐기된 인터페이스: 서브스트림(화면 공유) 화면의 렌더링 모드 설정 |
setRemoteSubStreamViewRotation | 폐기된 인터페이스: 서브스트림(화면 공유) 화면의 시계 방향 회전 각도 설정 |
getScreenCaptureSources | 공유할 수 있는 창 목록 열거 |
selectScreenCaptureTarget | 화면 공유 매개변수 설정. 화면 공유 과정 중에도 호출 가능. |
startScreenCapture | 화면 공유 실행 |
pauseScreenCapture | 화면 공유 일시 중지 |
resumeScreenCapture | 화면 공유 재개 |
stopScreenCapture | 화면 공유 중지 |
setSubStreamEncoderParam | 서브스트림(화면 공유)의 인코더 매개변수 설정 |
setSubStreamMixVolume | 서브스트림(화면 공유)의 오디오 믹싱 볼륨 크기 설정 |
addExcludedShareWindow | 지정 창을 화면 공유 제외 리스트에 추가. 제외 리스트에 추가된 창은 공유되지 않음. |
removeExcludedShareWindow | 지정 창을 화면 공유 제외 리스트에서 제거 |
removeAllExcludedShareWindow | 모든 창을 화면 공유 제외 리스트에서 제거 |
API | 설명 |
---|---|
sendCustomCmdMsg | 사용자 정의 메세지를 방 안에 있는 모든 사용자에게 전송 |
sendSEIMsg | 적은 양의 사용자 정의 데이터를 비디오 프레임에 삽입 |
API | 설명 |
---|---|
playBGM | 폐기된 인터페이스: 배경 음악 재생 실행 |
stopBGM | 폐기된 인터페이스: 배경 음악 재생 중지 |
pauseBGM | 폐기된 인터페이스: 배경 음악 재생 일시 중지 |
resumeBGM | 폐기된 인터페이스: 배경 음악 계속 재생 |
getBGMDuration | 폐기된 인터페이스: 배경 음악 파일 총 시간 가져오기. 단위: 밀리초. |
setBGMPosition | 폐기된 인터페이스: 배경 음악 재생 진행률 설정 |
setBGMVolume | 폐기된 인터페이스: 배경 음악 재생 볼륨 크기 설정 |
setBGMPlayoutVolume | 폐기된 인터페이스: 배경 음악 로컬 재생 볼륨 크기 설정 |
setBGMPublishVolume | 폐기된 인터페이스: 배경 음악 원격 재생 볼륨 크기 설정 |
startSystemAudioLoopback | 시스템 오디오 수집 활성화 |
stopSystemAudioLoopback | 시스템 오디오 수집 비활성화 |
setSystemAudioLoopbackVolume | 시스템 오디오 수집 볼륨 설정 |
startPlayMusic | 배경 음악 재생 실행 |
stopPlayMusic | 배경 음악 재생 정지 |
pausePlayMusic | 배경 음악 재생 일시 중지 |
resumePlayMusic | 배경 음악 재생 재개 |
getMusicDurationInMS | 배경 음악 파일 총 시간 가져오기. 단위: 밀리초. |
seekMusicToPosInTime | 배경 음악 재생 진행률 설정 |
setAllMusicVolume | 배경 음악 믹싱 재생 시 배경음의 음량 조절에 사용되는 배경 음악의 음량 설정 |
setMusicPlayoutVolume | 배경 음악의 로컬 재생 볼륨 설정 |
setMusicPublishVolume | 배경 음악의 원격 재생 볼륨 설정 |
API | 설명 |
---|---|
playAudioEffect | 폐기된 인터페이스: 음향 효과 재생 |
setAudioEffectVolume | 폐기된 인터페이스: 음향 효과 볼륨 설정 |
stopAudioEffect | 폐기된 인터페이스: 음향 효과 중지 |
stopAllAudioEffects | 폐기된 인터페이스: 모든 음향 효과 중지 |
setAllAudioEffectsVolume | 폐기된 인터페이스: 모든 음향 효과 볼륨 설정 |
pauseAudioEffect | 폐기된 인터페이스: 음향 효과를 일시 중지 |
resumeAudioEffect | 폐기된 인터페이스: 음향 효과 다시 재생 |
API | 설명 |
---|---|
startSpeedTest | 네트워크 속도 테스트 시작(통화 품질에 영향을 미칠 수 있으니 영상 통화 중에는 사용하지 마십시오) |
stopSpeedTest | 네트워크 속도 테스트 중지 |
startCameraDeviceTest | 카메라 테스트 시작 |
stopCameraDeviceTest | 카메라 테스트 중지 |
startMicDeviceTest | 마이크 테스트 시작 |
stopMicDeviceTest | 마이크 테스트 중지 |
startSpeakerDeviceTest | 스피커 테스트 시작 |
stopSpeakerDeviceTest | 스피커 테스트 중지 |
API | 설명 |
---|---|
getSDKVersion | SDK 버전 정보 가져오기 |
setLogLevel | Log 출력 레벨 설정 |
setConsoleEnabled | 콘솔 로그 출력 활성화/비활성화 |
setLogCompressEnabled | Log의 로컬 압축 활성화/비활성화 |
setLogDirPath | 로그 저장 경로 설정 |
setLogCallback | 로그 콜백 설정 |
callExperimentalAPI | 실험용 API 호출 |
API | 설명 |
---|---|
setMicVolumeOnMixing | v6.9 버전부터 폐기 |
Tencent Cloud 영상 통화 기능의 콜백 인터페이스 유형.
API | 설명 |
---|---|
onError | 오류 콜백. SDK가 복구할 수 없는 오류는 반드시 수신하고 상황에 맞게 사용자에게 적절한 인터페이스 알림을 제공. |
onWarning | 경고 콜백: 랙 또는 복구 가능한 디코딩 실패 등 심각하지 않은 문제를 알릴 때 사용 |
API | 설명 |
---|---|
onEnterRoom | 방 입장 콜백 |
onExitRoom | 방 퇴장 이벤트 콜백 |
onSwitchRole | 역할 전환 이벤트 콜백 |
onConnectOtherRoom | 크로스 룸 통화(호스트 PK) 요청 결과 콜백 |
onDisconnectOtherRoom | 크로스 룸 통화(호스트 PK) 종료 결과 콜백 |
onSwitchRoom | 방 전환 |
API | 설명 |
---|---|
onRemoteUserEnterRoom | 사용자가 현재 방에 입장함 |
onRemoteUserLeaveRoom | 사용자가 현재 방에서 퇴장함 |
onUserVideoAvailable | 사용자의 카메라 비디오 활성화 여부 |
onUserSubStreamAvailable | 사용자의 화면 공유 활성화 여부 |
onUserAudioAvailable | 사용자의 오디오 업스트림 활성화 여부 |
onFirstVideoFrame | 로컬 또는 원격 사용자의 첫 번째 프레임 화면 렌더링 시작 |
onFirstAudioFrame | 원격 사용자의 첫 번째 프레임 오디오(로컬 오디오는 공지 안 함) 재생 시작 |
onSendFirstLocalVideoFrame | 첫 번째 프레임 로컬 비디오 데이터 발송 완료 |
onSendFirstLocalAudioFrame | 첫 번째 프레임 로컬 오디오 데이터 발송 완료 |
onUserEnter | 호스트가 현재 방에 입장함(폐기됨) |
onUserExit | 호스트가 현재 방에서 퇴장함(폐기됨) |
API | 설명 |
---|---|
onNetworkQuality | 네트워크 품질: 해당 콜백은 2초에 한 번 트리거되고 현재의 네트워크 업스트림/다운스트림 품질을 통계함 |
onStatistics | 기술 메트릭 통계 콜백 |
API | 설명 |
---|---|
onConnectionLost | SDK와 서버 연결이 끊김 |
onTryToReconnect | SDK와 서버 다시 연결 중 |
onConnectionRecovery | SDK와 서버가 다시 연결됨 |
onSpeedTest | 폐기 인터페이스: 서버 속도 테스트 콜백. SDK는 여러 서버 IP에 속도 테스트를 진행하며 모든 IP의 속도 테스트 결과는 해당 콜백을 통해 공지됨. |
onSpeedTestResult | 네트워크 속도 테스트 결과 콜백. |
API | 설명 |
---|---|
onCameraDidReady | 카메라 준비 완료 |
onMicDidReady | 마이크 준비 완료 |
onUserVoiceVolume | 각 사용자(userId)의 볼륨과 총 원격 볼륨을 포함한 볼륨의 콜백. 로컬 사용자 userid: ’’. |
onDeviceChange | 로컬 디바이스 연결 상태 콜백 |
onTestMicVolume | 마이크 테스트 볼륨 콜백 |
onTestSpeakerVolume | 스피커 테스트 볼륨 콜백 |
onAudioDeviceCaptureVolumeChanged | 현재 오디오 캡처 디바이스 볼륨 변경 콜백 |
onAudioDevicePlayoutVolumeChanged | 현재 오디오 재생 디바이스 볼륨 변경 콜백 |
API | 설명 |
---|---|
onRecvCustomCmdMsg | 사용자 정의 메세지 수신 콜백 |
onMissCustomCmdMsg | 사용자 정의 메세지 손실 콜백 |
onRecvSEIMsg | SEI 메세지 수신 콜백 |
API | 설명 |
---|---|
onStartPublishing | Tencent Cloud 라이브 방송 CDN에 푸시 스트림을 시작하는 콜백으로 TRTCCloud의 startPublishing() 인터페이스에 상응함 |
onStopPublishing | Tencent Cloud 라이브 방송 CDN에 푸시 스트림을 중지하는 콜백으로 TRTCCloud의 stopPublishing() 인터페이스에 상응함 |
onStartPublishCDNStream | CDN으로 릴레이 푸시 스트림 활성화 콜백 |
onStopPublishCDNStream | CDN으로 릴레이 푸시 스트림 중지 콜백 |
onSetMixTranscodingConfig | 클라우드 혼합 스트림 트랜스 코딩 매개변수 설정 콜백으로 TRTCCloud의 setMixTranscodingConfig() 인터페이스에 상응함 |
API | 설명 |
---|---|
onSystemAudioLoopbackError | 시스템 볼륨 수집 상태 콜백(Mac만 해당됨) |
API | 설명 |
---|---|
onAudioEffectFinished | 폐기된 인터페이스: 음향 효과 재생 종료 콜백 |
API | 설명 |
---|---|
onScreenCaptureCovered | 화면 공유 창이 차단되어 캡처가 불가능할 경우 SDK는 해당 콜백을 통해 사용자에게 차단된 창을 제거할 것을 공지 |
onScreenCaptureStarted | 화면 공유 시작 시, SDK에서 해당 콜백을 통해 공지 |
onScreenCapturePaused | 화면 공유 일시 중지 시, SDK에서 해당 콜백을 통해 공지 |
onScreenCaptureResumed | 화면 공유 복구 시, SDK에서 해당 콜백을 통해 공지 |
onScreenCaptureStopped | 화면 공유 중지 시, SDK에서 해당 콜백을 통해 공지 |
API | 설명 |
---|---|
onSnapshotComplete | 화면 캡처 완료 시, SDK에서 해당 콜백을 통해 공지 |
API | 설명 |
---|---|
onPlayBGMBegin | 배경 음악 재생 시작(폐기됨) |
onPlayBGMProgress | 배경 음악 재생 진행률 콜백(폐기됨) |
onPlayBGMComplete | 배경 음악 재생 종료(폐기됨) |
클래스 이름 | 설명 |
---|---|
TRTCParams | 방 입장 관련 매개변수 |
TRTCVideoEncParam | 비디오 인코딩 매개변수 |
TRTCNetworkQosParam | 네트워크 트래픽 제어 관련 매개변수 |
TRTCQualityInfo | 비디오 품질 |
TRTCVolumeInfo | 볼륨 크기 |
TRTCSpeedTestResult | 네트워크 속도 테스트 결과 |
TRTCMixUser | 클라우드 혼합 스트림의 모든 서브 채널 위치 정보 |
TRTCTranscodingConfig | 클라우드 혼합 스트림(트랜스 코딩) 설정 |
TRTCPublishCDNParam | CDN 릴레이 푸시 스트림 매개변수 |
TRTCAudioRecordingParams | 녹음 매개변수 |
TRTCLocalStatistics | 사용자 로컬 멀티미디어 통계 정보 |
TRTCRemoteStatistics | 원격 구성원의 멀티미디어 통계 정보 |
TRTCStatistics | 통계 데이터 |
열거 | 설명 |
---|---|
TRTCVideoResolution | 비디오 해상도 |
TRTCVideoResolutionMode | 비디오 해상도 모드 |
TRTCVideoStreamType | 비디오 스트림 유형 |
TRTCQuality | 화질 레벨 |
TRTCVideoFillMode | 영상 화면 채우기 모드 |
TRTCBeautyStyle | 뷰티 필터(피부 보정) 알고리즘 |
TRTCAppScene | 응용 시나리오 |
TRTCRoleType | 역할. 라이브 방송 시나리오(TRTCAppSceneLIVE)만 해당. |
TRTCQosControlMode | 트래픽 제어 모드 |
TRTCVideoQosPreference | 화질 선호도 |
TRTCDeviceState | 디바이스 작업 |
TRTCDeviceType | 디바이스 유형 |
TRTCWaterMarkSrcType | 워터마크 이미지의 소스 유형 |
TRTCTranscodingConfigMode | 혼합 스트림 매개변수 설정 모드 |
문제 해결에 도움이 되었나요?