Docs Overview/
RTC Engine/
SDK/
Windows/
고객 인터페이스/
API 개요/

API 개요

C++ 전체 플랫폼 인터페이스 소개

8.0 버전부터 기존 Windows(C++) 인터페이스를 기반으로 Windows, iOS, Mac, Android 플랫폼에 적용되는 새로운 C++ 인터페이스를 제공합니다. C++ 인터페이스 통합 방법에 대한 자세한 내용은 각 플랫폼의 통합 가이드를 참고하십시오.
iOS C++ 인터페이스 통합 가이드
Android C++ 인터페이스 통합 가이드
Mac C++ 인터페이스 통합 가이드
Windows 통합 가이드
설명：
현재 C++ 인터페이스는 라이트 버전(TRTC)에서만 제공됩니다.
TRTC 헤더 파일은 Windows 플랫폼에서 'trtc' 네임스페이스를 자동으로 사용하고 있으므로 다시 지정할 필요가 없습니다.

ITRTCCloud @ TXLiteAVSDK

인스턴스 생성 및 이벤트 콜백

API
설명
TRTCCloud 인스턴스 생성(싱글톤 모드)
TRTCCloud 인스턴스 폐기(싱글톤 모드)
TRTC 이벤트 콜백 설정
TRTC 이벤트 콜백 제거

방 관련 API

API
설명
방 입장
방 퇴장
역할 전환
방 전환
크로스 룸 통화 요청
크로스 룸 통화 종료
구독 모드 설정(방에 입장하기 전에 설정해야 적용됨)
방 서브 인스턴스 생성(멀티 룸 동시 시청용)
방 서브 인스턴스 폐기

CDN 관련 인터페이스 함수

API
설명
Tencent Cloud CSS CDN에 멀티미디어 스트림 게시 시작
Tencent Cloud CSS CDN에 멀티미디어 스트림 게시 중지
Tencent Cloud CDN외에 멀티미디어 스트림 게시 시작
Tencent Cloud CDN외에 멀티미디어 스트림 게시 중지
클라우드 혼합 스트림 레이아웃 및 트랜스 코딩 매개변수 설정

비디오 관련 인터페이스 함수

API
설명
로컬 카메라 미리보기 이미지 활성화(모바일)
로컬 카메라의 미리보기 이미지 활성화(데스크톱)
로컬 카메라의 미리보기 이미지 업데이트
카메라 미리보기 중지
로컬 비디오 스트림 게시 일시 중지/재개
원격 사용자의 비디오 스트림 구독 및 비디오 렌더링 컨트롤러 바인딩
원격 사용자의 비디오 렌더링 컨트롤러 업데이트
원격 사용자의 비디오 스트림 구독 중지 및 렌더링 컨트롤러 해제
모든 원격 사용자의 비디오 스트림 구독 중지 및 모든 렌더링 리소스 해제
원격 사용자의 비디오 스트림 구독 일시 중지/재개
모든 원격 사용자의 비디오 스트림 구독 일시 중지/재개
비디오 인코더의 인코딩 매개변수 설정
네트워크 품질 관리 관련 매개변수 설정
로컬 비디오 이미지의 렌더링 매개변수 설정
원격 비디오 이미지의 렌더링 모드 설정
비디오 인코더에 의한 이미지 출력 방향 설정
인코더에서 출력되는 이미지의 미러 모드 설정
크고 작은 이미지 듀얼 채널 인코딩 모드 활성화
지정된 원격 사용자의 크고 작은 이미지 전환
영상 화면 캡처

오디오 관련 인터페이스 함수

API
설명
로컬 오디오 수집 및 게시 활성화
로컬 오디오 수집 및 게시 중지
로컬 오디오 스트림 게시 일시 중지/재개
원격 오디오 스트림 재생 일시 중지/재개
모든 원격 사용자의 오디오 스트림 재생 일시 중지/재개
원격 사용자의 오디오 재생 볼륨 설정
로컬 오디오 수집 볼륨 설정
로컬 오디오 수집 볼륨 가져오기
원격 오디오 재생 볼륨 설정
원격 오디오 재생 볼륨 가져오기
볼륨 알림 활성화
녹음 시작
오디오 녹음 중지
로컬 미디어 녹화 시작
로컬 미디어 녹화 중지
원격 오디오 스트림의 스마트 동시 재생 정책 설정

디바이스 관리 관련 인터페이스

API
설명
디바이스 관리 클래스 가져오기(TXDeviceManager)

뷰티 필터 특수 효과 및 이미지 워터마크

API
설명
뷰티 필터, 미백 효과, 안색 보정 등 특수 효과 설정
워터마크 추가

배경 음악 및 음향 효과

API
설명
음향 효과 관리 클래스 가져오기(TXAudioEffectManager)
시스템 오디오 수집 활성화(데스크톱 시스템만 해당)
시스템 오디오 수집 비활성화(데스크톱 시스템만 해당)
시스템 오디오 수집 볼륨 설정

화면 공유 관련 인터페이스

API
설명
데스크톱 화면 공유 시작(데스크톱 시스템만 해당)
화면 공유 중지
화면 공유 일시 중지
화면 공유 재개
공유 가능한 화면 및 창 열거(데스크톱 시스템만 지원)
공유할 화면 및 창 선택(데스크톱 시스템만 지원)
화면 공유(서브스트림)의 비디오 인코딩 매개변수 설정(데스크탑 및 모바일 시스템 모두 지원)
화면 공유의 오디오 믹싱 볼륨 설정(데스크톱 시스템만 지원)
화면 공유 제외 목록에 지정된 창 추가(데스크톱 시스템만 지원)
화면 공유 제외 목록에 지정된 창 제거(데스크톱 시스템만 지원)
화면 공유 제외 목록에서 모든 창 제거(데스크톱 시스템만 지원)
화면 공유 포함 목록에 지정된 창 추가(데스크톱 시스템만 지원)
화면 공유 포함 목록에서 지정된 창 제거(데스크톱 시스템만 지원)
화면 공유 포함 목록에서 모든 창 제거(데스크톱 시스템만 지원)

사용자 정의 수집 및 렌더링

API
설명
사용자 정의 비디오 수집 모드 활성화/비활성화
수집한 비디오 프레임을 SDK에 전달
사용자 정의 오디오 수집 모드 활성화
수집한 오디오 데이터를 SDK에 전달
사용자 정의 오디오 트랙 활성화/비활성화
사용자 정의 오디오 트랙을 SDK에 믹싱
푸시 스트림 시 믹싱된 외부 오디오 푸시 스트림 볼륨 및 재생 볼륨 설정
사용자 정의 수집 시 타임스탬프 생성
서드 파티 뷰티 필터에 대한 비디오 데이터 콜백 설정
로컬 비디오에 대한 사용자 정의 렌더링 콜백 설정
원격 비디오에 대한 사용자 정의 렌더링 콜백 설정
오디오 데이터 사용자 정의 콜백 설정
시스템에서 재생할 오디오 프레임의 콜백 형식 설정
사용자 정의 오디오 재생 활성화
재생 가능한 오디오 데이터 가져오기

사용자 정의 메시지 전송 인터페이스

API
설명
UDP 채널을 사용하여 방의 모든 사용자에게 사용자 정의 메시지 보내기
SEI 채널을 사용하여 방의 모든 사용자에게 사용자 정의 메시지 보내기

네트워크 테스트 인터페이스

API
설명
네트워크 속도 테스트 시작(방 입장 전 사용)
네트워크 속도 테스트 중지

디버깅 관련 인터페이스

API
설명
SDK 버전 정보 가져오기
Log 출력 레벨 설정
콘솔 로그 출력 활성화/비활성화
로컬 로그 압축 활성화/비활성화
로컬 로그 저장 경로 설정
로그 콜백 설정
대시보드 표시
실험용 API 호출

사용하지 않는 인터페이스

API
설명
사용자 정의 비디오 수집 모드 활성화
수집한 비디오 데이터 전송
로컬 비디오 스트림 게시 일시 중지/재개
원격 사용자 비디오 스트림 구독 일시 중지/재개
네트워크 속도 테스트 시작(방 입장 전 사용)

오류 및 경고 이벤트

API
설명
오류 이벤트 콜백
경고 이벤트 콜백

방 관련 이벤트 콜백

API
설명
방 입장 성공 여부 이벤트 콜백
방 퇴장 이벤트 콜백
역할 전환 이벤트 콜백
방 전환 결과 콜백
크로스 룸 통화 요청 결과 콜백
크로스 룸 통화 종료 결과 콜백

사용자 관련 이벤트 콜백

API
설명
사용자 방 입장
사용자 방 퇴장
원격 사용자가 메인 비디오 화면 게시/게시 취소함
원격 사용자가 서브 영상 화면을 게시/게시 취소함
원격 사용자가 오디오를 게시/게시 취소함
SDK가 로컬 또는 원격 사용자의 첫 번째 화면 프레임을 렌더링하기 시작함
SDK가 원격 사용자의 첫 번째 화면 프레임을 재생하기 시작함
첫 번째 로컬 비디오 프레임 게시
첫 번째 로컬 오디오 프레임 게시
원격 비디오 상태 변경 이벤트 콜백

네트워크 및 기술 메트릭에 대한 통계 콜백

API
설명
네트워크 품질 실시간 통계 콜백
멀티미디어 기술 메트릭에 대한 실시간 통계 콜백
네트워크 속도 테스트 결과 콜백

클라우드 연결 상태 이벤트 콜백

API
설명
SDK와 클라우드 연결이 끊김
SDK와 클라우드 다시 연결 중
SDK와 클라우드가 다시 연결됨

하드웨어 관련 이벤트 콜백

API
설명
카메라 준비 완료
마이크 준비 완료
볼륨
로컬의 상태가 변경됨(데스크톱 시스템만 해당)
현재 마이크 시스템의 수집 볼륨이 변경됨
현재 시스템의 재생 볼륨이 변경됨
시스템 오디오 수집 활성화 성공 여부 이벤트 콜백(Mac 시스템만 해당)
마이크 테스트 볼륨 콜백
스피커 테스트 볼륨 콜백

사용자 정의 메시지 수신 이벤트 콜백

API
설명
사용자 정의 메시지 수신 이벤트 콜백
사용자 정의 메시지 손실 이벤트 콜백
SEI 메시지 수신 콜백

CDN 관련 이벤트 콜백

API
설명
Tencent Cloud CSS CDN에 멀티미디어 스트림 게시 시작 이벤트 콜백
Tencent Cloud CSS CDN에 멀티미디어 스트림 게시 중지 이벤트 콜백
Tencent Cloud CSS CDN외에 멀티미디어 스트림 게시 시작 이벤트 콜백
Tencent Cloud CSS CDN외에 멀티미디어 스트림 게시 중지 이벤트 콜백
클라우드 혼합 스트리밍의 레이아웃 및 트랜스 코딩 매개변수 설정 이벤트 콜백

화면 공유 관련 이벤트 콜백

API
설명
화면 공유 활성화 이벤트 콜백
화면 공유 일시 중지 이벤트 콜백
화면 공유 재개 이벤트 콜백
화면 공유 중지 이벤트 콜백
화면 공유 창이 가려짐 이벤트 콜백(Windows만 해당)

로컬 녹화 및 화면 캡처 이벤트 콜백

API
설명
로컬 녹화 작업 시작 이벤트 콜백
로컬 녹화 작업 진행 중 이벤트 콜백
로컬 녹화 작업 종료 이벤트 콜백
로컬 화면 캡처 완료 이벤트 콜백

사용하지 않는 이벤트 콜백

API
설명
호스트가 현재 방에 입장함(폐기됨)
호스트가 현재 방에서 퇴장함(폐기됨)
음향 효과 종료(폐기됨)
배경 음악 재생 시작(폐기됨)
배경 음악 재생 진행률 콜백(폐기됨)
배경 음악 재생 종료(폐기됨)
서버 속도 테스트 결과 콜백(폐기됨)

비디오 데이터 사용자 정의 콜백

API
설명
사용자 정의 비디오 렌더링 콜백
타사 뷰티 필터 컴포넌트에 의한 비디오 처리 콜백

오디오 데이터 사용자 정의 콜백

API
설명
로컬에서 수집되고 오디오 모듈에서 전처리된 오디오 데이터 콜백
로컬에서 수집되고 오디오 모듈에서 전처리, 사운드 처리 및 BGM 믹싱된 오디오 데이터 콜백
각 원격 사용자의 오디오 믹싱 전 오디오 데이터
재생하기 위해 시스템에 제출되기 전 각 채널에서 믹싱된 오디오 데이터 콜백

기타 이벤트 콜백 인터페이스

API
설명
로컬 LOG 출력 콜백

비디오 관련 열거 값 정의

API
설명
비디오 해상도
비디오 종횡비 모드
비디오 스트림 유형
영상 화면 채우기 모드
영상 화면 회전 방향
뷰티 필터(피부 보정) 알고리즘
비디오 픽셀 형식
비디오 데이터 전송 방식
비디오 미러 이미지 유형
로컬 영상 화면 캡처 데이터 소스

네트워크 관련 열거 값 정의

API
설명
응용 시나리오
역할
QoS 제어 모드(폐기됨)
화질 선호도
네트워크 품질
비디오 상태 유형
비디오 상태 변동 원인

오디오 관련 열거 값 정의

API
설명
오디오 품질

기타 열거 값 정의

API
설명
Log 레벨
화면 공유 타깃 유형(데스크톱만 해당)
클라우드 혼합 스트리밍 레이아웃 모드
미디어 녹화 유형
혼합 스트림 입력 유형
디바이스 유형(데스크톱 플랫폼만 해당)
오디오 녹음 콘텐츠 유형

TRTC 핵심 유형 정의

API
설명
방 입장 매개변수
비디오 인코딩 매개변수
네트워크 트래픽 제어(Qos) 매개변수 세트
영상 화면 렌더링 매개변수
네트워크 품질
볼륨 크기
속도 테스트 매개변수
네트워크 속도 테스트 결과
비디오 프레임 정보
오디오 프레임 데이터
클라우드 혼합 스트리밍 각 채널 화면에 대한 설명 정보
클라우드 혼합 트래픽의 레이아웃 및 트랜스 코딩 매개변수
Tencent Cloud CDN외에 멀티미디어 스트림을 게시할 때 설정해야 하는 푸시 매개변수
로컬 오디오 파일 녹화 매개변수
로컬 미디어 파일 녹화 매개변수
음향 효과 매개변수(폐기됨)
방 전환 매개변수
오디오 사용자 정의 콜백 형식 매개변수
화면 공유 타깃 정보(데스크톱 시스템만 해당)
공유할 수 있는 화면 및 창 리스트