API 개요
TRTCCloud @ TXLiteAVSDK
Tencent Cloud 영상 통화 기능의 주요 인터페이스.
주요 문서 주소: TRTC Electron SDK
인스턴스 코드 주소: TRTC Electron Demo
TRTC 객체 생성
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);
TRTCCloud 싱글톤 생성 및 폐기
API | 설명 |
TRTCCloud 싱글톤 객체를 릴리스하고 리소스를 정리 |
방 관련 API
API | 설명 |
방 입장. 방이 없으면 시스템에서 자동으로 생성. | |
방 퇴장 | |
방 전환 | |
역할 전환. 라이브 방송 시나리오(TRTCAppSceneLIVE 및 TRTCAppSceneVoiceChatRoom)에만 적용. | |
크로스 룸 마이크 연결(호스트 크로스 룸 PK) 요청 | |
크로스 룸 마이크 연결(호스트 크로스 룸 PK) 비활성화 | |
오디오 및 비디오 데이터 수신 모드를 설정합니다(방 입장 전 설정 시 적용됨). |
CDN 관련 인터페이스 함수
API | 설명 |
Tencent Cloud 라이브 방송 CDN에 푸시 스트림 시작 | |
Tencent Cloud 라이브 방송 CDN에 푸시 스트림 중지 | |
Tencent Cloud 이외의 라이브 스트리밍 CDN에 게시 시작 | |
Tencent Cloud 이외의 라이브 스트리밍 CDN에 게시 중지 | |
클라우드 혼합 스트림 트랜스 코딩 매개변수 설정 |
비디오 관련 인터페이스 함수
API | 설명 |
로컬 카메라 캡처 및 미리보기 시작 | |
로컬 카메라 캡처 및 미리보기 중지 | |
사용자 영상 화면 차단 여부 확인 | |
원격 비디오 화면 표시 시작 | |
원격 영상 화면 표시 중지 및 원격 사용자의 비디오 데이터 스트림 풀링 중지 | |
모든 영상 화면 표시 중지 및 원격 사용자의 비디오 데이터 스트림 풀링 중지 | |
지정 원격 비디오 스트림 수신 일시 중지 | |
모든 원격 비디오 스트림 수신 중지 | |
비디오 인코더 관련 매개변수 설정 | |
네트워크 트래픽 제어 관련 매개변수 설정 | |
로컬 이미지(메인 스트림)의 렌더링 매개변수 설정 | |
폐기된 인터페이스: 로컬 이미지 렌더링 모드 설정 | |
원격 이미지의 렌더링 매개변수 설정 | |
폐기된 인터페이스: 원격 이미지 렌더링 모드 설정 | |
폐기된 인터페이스: 로컬 이미지의 시계 방향 회전 각도 설정 | |
폐기된 인터페이스: 원격 이미지의 시계 방향 회전 각도 설정 | |
비디오 인코딩 출력(원격 사용자가 시청하고 서버에 녹화된) 화면 방향 설정 | |
폐기된 인터페이스: 로컬 카메라 화면 미리보기 이미지 모드 설정 | |
인코더로 출력된 화면의 이미지 모드 설정 | |
크고 작은 이미지의 이중 채널 인코딩 모드 활성화 | |
지정 userId의 화면(큰 이미지/작은 이미지) 선택 | |
폐기된 인터페이스: 시청자 비디오 품질 우선 순위 설정 | |
영상 화면 캡처 |
오디오 관련 인터페이스 함수
API | 설명 |
로컬 오디오 수집 및 업스트림 활성화 | |
로컬 오디오 수집 및 업스트림 비활성화 | |
로컬 오디오 음소거 | |
특정 사용자의 오디오를 음소거하고 해당 원격 사용자의 오디오 데이터 스트림 풀링 중지 | |
모든 사용자의 오디오를 음소거하고 원격 사용자의 오디오 데이터 스트림 풀링 중지 | |
SDK 수집 볼륨 설정 | |
SDK 수집 볼륨 가져오기 | |
SDK 재생 볼륨 설정 | |
SDK 재생 볼륨 가져오기 | |
볼륨 크기 알람 활성화/비활성화 | |
녹음 시작 | |
녹음 중지 | |
폐기된 인터페이스: 볼륨 품질 설정 | |
원격 사용자의 재생 볼륨 설정 |
카메라 관련 인터페이스 함수
API | 설명 |
카메라 디바이스 리스트 가져오기 | |
사용할 카메라 설정 | |
현재 사용하는 카메라 가져오기 |
오디오 디바이스 관련 인터페이스 함수
API | 설명 |
마이크 디바이스 리스트 가져오기 | |
현재 선택한 마이크 가져오기 | |
사용할 마이크 설정 | |
시스템의 현재 마이크 디바이스 볼륨 가져오기 | |
시스템의 현재 마이크 디바이스 볼륨 설정 | |
시스템의 현재 마이크 디바이스 음소거 상태 설정 | |
시스템의 현재 마이크 디바이스 음소거 여부 가져오기 | |
스피커 디바이스 리스트 가져오기 | |
현재 스피커 디바이스 가져오기 | |
사용할 스피커 설정 | |
시스템의 현재 스피커 디바이스 볼륨 가져오기 | |
시스템의 현재 스피커 디바이스 볼륨 설정 | |
시스템의 현재 스피커 디바이스 음소거 상태 설정 | |
시스템의 현재 스피커 디바이스 음소거 여부 가져오기 |
뷰티 필터 관련 인터페이스 함수
API | 설명 |
뷰티 필터, 미백, 안색 보정 효과 레벨 설정 | |
워터마크 설정 |
서브스트림 관련 인터페이스 함수
API | 설명 |
폐기된 인터페이스: 원격 사용자의 서브스트림(화면 공유) 화면 렌더링 시작 | |
폐기된 인터페이스: 원격 사용자의 서브스트림(화면 공유) 화면 렌더링 중지 | |
폐기된 인터페이스: 서브스트림(화면 공유) 화면의 렌더링 모드 설정 | |
폐기된 인터페이스: 서브스트림(화면 공유) 화면의 시계 방향 회전 각도 설정 | |
공유할 수 있는 창 목록 열거 | |
화면 공유 매개변수 설정. 화면 공유 과정 중에도 호출 가능. | |
화면 공유 실행 | |
화면 공유 일시 중지 | |
화면 공유 재개 | |
화면 공유 중지 | |
서브스트림(화면 공유)의 인코더 매개변수 설정 | |
서브스트림(화면 공유)의 오디오 믹싱 볼륨 크기 설정 | |
지정 창을 화면 공유 제외 리스트에 추가. 제외 리스트에 추가된 창은 공유되지 않음. | |
지정 창을 화면 공유 제외 리스트에서 제거 | |
모든 창을 화면 공유 제외 리스트에서 제거 |
사용자 정의 메시지 발송
API | 설명 |
사용자 정의 메세지를 방 안에 있는 모든 사용자에게 전송 | |
적은 양의 사용자 정의 데이터를 비디오 프레임에 삽입 |
배경 오디오 믹싱 관련 인터페이스 함수
API | 설명 |
폐기된 인터페이스: 배경 음악 재생 실행 | |
폐기된 인터페이스: 배경 음악 재생 중지 | |
폐기된 인터페이스: 배경 음악 재생 일시 중지 | |
폐기된 인터페이스: 배경 음악 계속 재생 | |
폐기된 인터페이스: 배경 음악 파일 총 시간 가져오기. 단위: 밀리초. | |
폐기된 인터페이스: 배경 음악 재생 진행률 설정 | |
폐기된 인터페이스: 배경 음악 재생 볼륨 크기 설정 | |
폐기된 인터페이스: 배경 음악 로컬 재생 볼륨 크기 설정 | |
폐기된 인터페이스: 배경 음악 원격 재생 볼륨 크기 설정 | |
시스템 오디오 수집 활성화 | |
시스템 오디오 수집 비활성화 | |
시스템 오디오 수집 볼륨 설정 | |
배경 음악 재생 실행 | |
배경 음악 재생 정지 | |
배경 음악 재생 일시 중지 | |
배경 음악 재생 재개 | |
배경 음악 파일 총 시간 가져오기. 단위: 밀리초. | |
배경 음악 재생 진행률 설정 | |
배경 음악 믹싱 재생 시 배경음의 음량 조절에 사용되는 배경 음악의 음량 설정 | |
배경 음악의 로컬 재생 볼륨 설정 | |
배경 음악의 원격 재생 볼륨 설정 |
음향 효과 관련 인터페이스 함수
API | 설명 |
폐기된 인터페이스: 음향 효과 재생 | |
폐기된 인터페이스: 음향 효과 볼륨 설정 | |
폐기된 인터페이스: 음향 효과 중지 | |
폐기된 인터페이스: 모든 음향 효과 중지 | |
폐기된 인터페이스: 모든 음향 효과 볼륨 설정 | |
폐기된 인터페이스: 음향 효과를 일시 중지 | |
폐기된 인터페이스: 음향 효과 다시 재생 |
디바이스 및 네트워크 테스트
API | 설명 |
네트워크 속도 테스트 시작(통화 품질에 영향을 미칠 수 있으니 영상 통화 중에는 사용하지 마십시오) | |
네트워크 속도 테스트 중지 | |
카메라 테스트 시작 | |
카메라 테스트 중지 | |
마이크 테스트 시작 | |
마이크 테스트 중지 | |
스피커 테스트 시작 | |
스피커 테스트 중지 |
LOG 관련 인터페이스 함수
API | 설명 |
SDK 버전 정보 가져오기 | |
Log 출력 레벨 설정 | |
콘솔 로그 출력 활성화/비활성화 | |
Log의 로컬 압축 활성화/비활성화 | |
로그 저장 경로 설정 | |
로그 콜백 설정 | |
실험용 API 호출 |
사용하지 않는 인터페이스 함수
API | 설명 |
v6.9 버전부터 폐기 |
TRTCCallback @ TXLiteAVSDK
Tencent Cloud 영상 통화 기능의 콜백 인터페이스 유형.
오류 및 경고 이벤트 콜백 API
방 이벤트 콜백 API
API | 설명 |
방 입장 콜백 | |
방 퇴장 이벤트 콜백 | |
역할 전환 이벤트 콜백 | |
크로스 룸 통화(호스트 PK) 요청 결과 콜백 | |
크로스 룸 통화(호스트 PK) 종료 결과 콜백 | |
방 전환 |
사용자 이벤트 콜백 API
API | 설명 |
사용자가 현재 방에 입장함 | |
사용자가 현재 방에서 퇴장함 | |
사용자의 카메라 비디오 활성화 여부 | |
사용자의 화면 공유 활성화 여부 | |
사용자의 오디오 업스트림 활성화 여부 | |
로컬 또는 원격 사용자의 첫 번째 프레임 화면 렌더링 시작 | |
원격 사용자의 첫 번째 프레임 오디오(로컬 오디오는 공지 안 함) 재생 시작 | |
첫 번째 프레임 로컬 비디오 데이터 발송 완료 | |
첫 번째 프레임 로컬 오디오 데이터 발송 완료 | |
호스트가 현재 방에 입장함(폐기됨) | |
호스트가 현재 방에서 퇴장함(폐기됨) |
네트워크 품질 및 기술 메트릭에 대한 통계를 위한 콜백 API
API | 설명 |
네트워크 품질: 해당 콜백은 2초에 한 번 트리거되고 현재의 네트워크 업스트림/다운스트림 품질을 통계함 | |
기술 메트릭 통계 콜백 |
서버 이벤트 콜백 API
API | 설명 |
SDK와 서버 연결이 끊김 | |
SDK와 서버 다시 연결 중 | |
SDK와 서버가 다시 연결됨 | |
폐기 인터페이스: 서버 속도 테스트 콜백. SDK는 여러 서버 IP에 속도 테스트를 진행하며 모든 IP의 속도 테스트 결과는 해당 콜백을 통해 공지됨. | |
네트워크 속도 테스트 결과 콜백. |
하드웨어 이벤트 콜백 API
API | 설명 |
카메라 준비 완료 | |
마이크 준비 완료 | |
각 사용자(userId)의 볼륨과 총 원격 볼륨을 포함한 볼륨의 콜백. 로컬 사용자 userid: ’’. | |
로컬 디바이스 연결 상태 콜백 | |
마이크 테스트 볼륨 콜백 | |
스피커 테스트 볼륨 콜백 | |
현재 오디오 캡처 디바이스 볼륨 변경 콜백 | |
현재 오디오 재생 디바이스 볼륨 변경 콜백 |
사용자 정의 메시지 수신 콜백
API | 설명 |
사용자 정의 메세지 수신 콜백 | |
사용자 정의 메세지 손실 콜백 | |
SEI 메세지 수신 콜백 |
CDN 릴레이 푸시용 콜백 API
API | 설명 |
Tencent Cloud 라이브 방송 CDN에 푸시 스트림을 시작하는 콜백으로 TRTCCloud의 startPublishing() 인터페이스에 상응함 | |
Tencent Cloud 라이브 방송 CDN에 푸시 스트림을 중지하는 콜백으로 TRTCCloud의 stopPublishing() 인터페이스에 상응함 | |
CDN으로 릴레이 푸시 스트림 활성화 콜백 | |
CDN으로 릴레이 푸시 스트림 중지 콜백 | |
클라우드 혼합 스트림 트랜스 코딩 매개변수 설정 콜백으로 TRTCCloud의 setMixTranscodingConfig() 인터페이스에 상응함 |
시스템 볼륨 수집 콜백
API | 설명 |
시스템 볼륨 수집 상태 콜백(Mac만 해당됨) |
음향 효과 콜백
API | 설명 |
폐기된 인터페이스: 음향 효과 재생 종료 콜백 |
화면 공유 콜백
API | 설명 |
화면 공유 창이 차단되어 캡처가 불가능할 경우 SDK는 해당 콜백을 통해 사용자에게 차단된 창을 제거할 것을 공지 | |
화면 공유 시작 시, SDK에서 해당 콜백을 통해 공지 | |
화면 공유 일시 중지 시, SDK에서 해당 콜백을 통해 공지 | |
화면 공유 복구 시, SDK에서 해당 콜백을 통해 공지 | |
화면 공유 중지 시, SDK에서 해당 콜백을 통해 공지 |
화면 캡처 콜백
API | 설명 |
화면 캡처 완료 시, SDK에서 해당 콜백을 통해 공지 |
배경 오디오 믹싱 이벤트 콜백
API | 설명 |
배경 음악 재생 시작(폐기됨) | |
배경 음악 재생 진행률 콜백(폐기됨) | |
배경 음악 재생 종료(폐기됨) |
주요 클래스의 정의
주요 클래스
클래스 이름 | 설명 |
방 입장 관련 매개변수 | |
비디오 인코딩 매개변수 | |
네트워크 트래픽 제어 관련 매개변수 | |
비디오 품질 | |
볼륨 크기 | |
네트워크 속도 테스트 결과 | |
클라우드 혼합 스트림의 모든 서브 채널 위치 정보 | |
클라우드 혼합 스트림(트랜스 코딩) 설정 | |
CDN 릴레이 푸시 스트림 매개변수 | |
녹음 매개변수 | |
사용자 로컬 멀티미디어 통계 정보 | |
원격 구성원의 멀티미디어 통계 정보 | |
통계 데이터 |
열거 값
열거 | 설명 |
비디오 해상도 | |
비디오 해상도 모드 | |
비디오 스트림 유형 | |
화질 레벨 | |
영상 화면 채우기 모드 | |
뷰티 필터(피부 보정) 알고리즘 | |
응용 시나리오 | |
역할. 라이브 방송 시나리오(TRTCAppSceneLIVE)만 해당. | |
트래픽 제어 모드 | |
화질 선호도 | |
디바이스 작업 | |
디바이스 유형 | |
워터마크 이미지의 소스 유형 | |
혼합 스트림 매개변수 설정 모드 |