tencent cloud

피드백

API 개요

마지막 업데이트 시간:2022-02-21 17:01:28

    TRTCCloud @ TXLiteAVSDK

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

    API 설명
    sharedInstance TRTCCloud 인스턴스 생성(싱글톤 모드)
    destroySharedInstance TRTCCloud 인스턴스 폐기(싱글톤 모드)
    setListener TRTC 이벤트 콜백 설정
    setListenerHandler TRTCCloudDelegate 이벤트 콜백을 구동하는 큐 설정

    방 관련 API

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

    CDN 관련 인터페이스 함수

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

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

    API 설명
    startLocalPreview 로컬 카메라 미리보기 이미지 활성화(모바일)
    updateLocalView 로컬 카메라의 미리보기 이미지 업데이트
    stopLocalPreview 카메라 미리보기 중지
    muteLocalVideo 로컬 비디오 스트림 게시 일시 중지/재개
    setVideoMuteImage 로컬 비디오 일시 중지 교체 이미지 설정
    startRemoteView 원격 사용자의 비디오 스트림 구독 및 비디오 렌더링 컨트롤러 바인딩
    updateRemoteView 원격 사용자의 비디오 렌더링 컨트롤러 업데이트
    stopRemoteView 원격 사용자의 비디오 스트림 구독 중지 및 렌더링 컨트롤러 해제
    stopAllRemoteView 모든 원격 사용자의 비디오 스트림 구독 중지 및 모든 렌더링 리소스 해제
    muteRemoteVideoStream 원격 사용자의 비디오 스트림 구독 일시 중지/재개
    muteAllRemoteVideoStreams 모든 원격 사용자의 비디오 스트림 구독 일시 중지/재개
    setVideoEncoderParam 비디오 인코더의 인코딩 매개변수 설정
    setNetworkQosParam 네트워크 품질 관리 관련 매개변수 설정
    setLocalRenderParams 로컬 비디오 이미지의 렌더링 매개변수 설정
    setRemoteRenderParams 원격 비디오 이미지의 렌더링 모드 설정
    setVideoEncoderRotation 비디오 인코더 이미지 출력 방향 설정
    setVideoEncoderMirror 인코더에서 출력되는 이미지의 미러 모드 설정
    setGSensorMode G-센서 어댑티브 모드 설정
    enableEncSmallVideoStream 크고 작은 이미지 듀얼 채널 인코딩 모드 활성화
    setRemoteVideoStreamType 지정된 원격 사용자의 크고 작은 이미지 전환
    snapshotVideo 영상 화면 캡처

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

    API 설명
    startLocalAudio 로컬 오디오 수집 및 게시 활성화
    stopLocalAudio 로컬 오디오 수집 및 게시 중지
    muteLocalAudio 로컬 오디오 스트림 게시 일시 중지/재개
    muteRemoteAudio 원격 오디오 스트림 재생 일시 중지/재개
    muteAllRemoteAudio 모든 원격 사용자의 오디오 스트림 재생 일시 중지/재개
    setAudioRoute 오디오 경로 설정
    setRemoteAudioVolume 원격 사용자의 오디오 재생 볼륨 설정
    setAudioCaptureVolume 로컬 오디오 수집 볼륨 설정
    getAudioCaptureVolume 로컬 오디오 수집 볼륨 가져오기
    setAudioPlayoutVolume 원격 오디오 재생 볼륨 설정
    getAudioPlayoutVolume 원격 오디오 재생 볼륨 가져오기
    enableAudioVolumeEvaluation 볼륨 알림 활성화
    startAudioRecording 오디오 녹음 시작
    stopAudioRecording 오디오 녹음 중지
    startLocalRecording 로컬 미디어 녹화 시작
    stopLocalRecording 로컬 미디어 녹화 중지
    checkAudioCapabilitySupport 특정 오디오 기능 지원 여부 쿼리(Android만 해당)
    setRemoteAudioParallelParams 원격 오디오 스트림의 스마트 동시 재생 정책 설정

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

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

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

    API 설명
    getBeautyManager 뷰티 필터 관리 클래스 가져오기(TXBeautyManager)
    setWatermark 워터마크 추가

    배경 음악 및 음향 효과

    API 설명
    getAudioEffectManager 음향 효과 관리 클래스 가져오기(TXAudioEffectManager)

    화면 공유 관련 인터페이스

    API 설명
    startScreenCapture 화면 공유 시작
    stopScreenCapture 화면 공유 중지
    pauseScreenCapture 화면 공유 일시 중지
    resumeScreenCapture 화면 공유 재개
    setSubStreamEncoderParam 화면 공유(서브 스트림)의 비디오 인코딩 매개변수 설정(데스크톱 및 모바일 시스템 모두 지원)

    사용자 정의 수집 및 렌더링

    API 설명
    enableCustomVideoCapture 사용자 정의 비디오 수집 모드 활성화/비활성화
    sendCustomVideoData 수집한 비디오 프레임을 SDK에 전송
    enableCustomAudioCapture 사용자 정의 오디오 수집 모드 활성화
    sendCustomAudioData 수집한 오디오 데이터를 SDK에 전송
    enableMixExternalAudioFrame 사용자 정의 오디오 트랙 활성화/비활성화
    mixExternalAudioFrame 사용자 정의 오디오 트랙을 SDK에 믹싱
    setMixExternalAudioVolume 푸시 스트림 시 믹싱된 외부 오디오의 푸시 스트림 볼륨 및 재생 볼륨 설정
    generateCustomPTS 사용자 정의 수집 시 타임스탬프 생성
    setLocalVideoProcessListener 타사 뷰티 필터에 대한 비디오 데이터 콜백 설정
    setLocalVideoRenderListener 로컬 비디오에 대한 사용자 정의 렌더링 콜백 설정
    setRemoteVideoRenderListener 원격 비디오에 대한 사용자 정의 렌더링 콜백 설정
    setAudioFrameListener 오디오 데이터 사용자 정의 콜백 설정
    setCapturedRawAudioFrameCallbackFormat 로컬 마이크에서 수집한 원본 오디오 프레임의 콜백 형식 설정
    setLocalProcessedAudioFrameCallbackFormat 전처리된 로컬 오디오 프레임의 콜백 형식 설정
    setMixedPlayAudioFrameCallbackFormat 시스템에서 재생할 오디오 프레임의 콜백 형식 설정
    enableCustomAudioRendering 사용자 정의 오디오 재생 활성화
    getCustomAudioRenderingFrame 재생 가능한 오디오 데이터 가져오기

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

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

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

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

    디버깅 관련 인터페이스

    API 설명
    getSDKVersion SDK 버전 정보 가져오기
    setLogLevel Log 출력 레벨 설정
    setConsoleEnabled 콘솔 로그 출력 활성화/비활성화
    setLogCompressEnabled 로컬 로그 압축 활성화/비활성화
    setLogDirPath 로컬 로그 저장 경로 설정
    setLogListener 로그 콜백 설정
    showDebugView 대시보드 표시
    setDebugViewMargin 대시보드 여백 설정
    callExperimentalAPI 실험용 인터페이스 호출
    setNetEnv TRTC 백그라운드 클러스터 설정 (Tencent Cloud R&D 팀만 해당)

    사용하지 않는 인터페이스

    API 설명
    setMicVolumeOnMixing 마이크 볼륨 설정
    setBeautyStyle 뷰티 필터, 미백 효과, 안색 보정 효과 단계 설정
    setEyeScaleLevel 눈 확대 필터 강도 설정
    setFaceSlimLevel 갸름한 얼굴 필터 강도 설정
    setFaceVLevel V라인 필터 강도 설정
    setChinLevel 턱 늘이기/줄이기 필터 강도 설정
    setFaceShortLevel 얼굴 축소 필터 강도 설정
    setNoseSlimLevel 코 축소 필터 강도 설정
    selectMotionTmpl 애니메이션 스티커 설정
    setMotionMute 애니메이션 스티커 음소거 설정
    setFilter 컬러 필터 설정
    setFilterConcentration 컬러 필터 강도 설정
    setGreenScreenFile 그린 스크린 비디오 설정
    playBGM 배경 음악 재생
    stopBGM 배경 음악 재생 중지
    pauseBGM 배경 음악 재생 중지
    resumeBGM 배경 음악 재생 중지
    getBGMDuration 배경 음악의 총 길이(단위:ms) 가져오기
    setBGMPosition 배경 음악 재생 진행률 설정
    setBGMVolume 배경 음악 볼륨 설정
    setBGMPlayoutVolume 배경 음악 로컬 재생 볼륨 설정
    setBGMPublishVolume 배경 음악 원격 재생 볼륨 설정
    setReverbType 리버브 효과 설정
    setVoiceChangerType 음성 변조 유형 설정
    playAudioEffect 음향 효과 재생
    setAudioEffectVolume 음향 효과 볼륨 설정
    setAudioEffectVolume 음향 효과 재생 중지
    stopAllAudioEffects 모든 음향 효과 중지
    setAllAudioEffectsVolume 모든 음향 효과 볼륨 설정
    pauseAudioEffect 음향 효과 일시 중지
    resumeAudioEffect 음향 효과 일시 중지
    enableAudioEarMonitoring 인이어 모니터링 활성화(또는 비활성화)
    startRemoteView 원격 영상 화면 표시 시작
    stopRemoteView 원격 영상 화면 표시 중지 및 원격 사용자의 비디오 데이터 스트림 가져오기 중지
    setRemoteViewFillMode 원격 이미지 렌더링 모드 설정
    setRemoteViewRotation 원격 이미지 시계 방향 회전 각도 설정
    setLocalViewFillMode 로컬 이미지 렌더링 모드 설정
    setLocalViewRotation 로컬 이미지 시계 방향 회전 각도 설정
    setLocalViewMirror 로컬 카메라 미리보기 이미지의 미러 모드 설정
    startRemoteSubStreamView 원격 사용자 서브스트림 이미지 표시 시작
    stopRemoteSubStreamView 원격 사용자 서브스트림 이미지 표시 중지
    setRemoteSubStreamViewFillMode 서브스트림 이미지 채우기 모드 설정
    setRemoteSubStreamViewRotation 서브스트림 이미지 시계 방향 회전 각도 설정
    setPriorRemoteVideoStreamType 큰 화면/작은 화면 시청 우선순위 설정
    setAudioQuality 음질 설정
    startLocalAudio 음질 설정
    switchCamera 카메라 전환
    isCameraZoomSupported 현재 카메라의 줌 지원 여부 쿼리
    setZoom 카메라 줌 비율 설정(초점 거리)
    isCameraTorchSupported 플래시 지원 여부 쿼리
    enableTorch 플래시 켜기/끄기
    isCameraFocusPositionInPreviewSupported 카메라 초점 설정 지원 여부 쿼리
    setFocusPosition 카메라 초점 위치 설정
    isCameraAutoFocusFaceModeSupported 얼굴 위치 자동 인식 지원 여부 쿼리
    setSystemVolumeType 시스템 볼륨 유형 설정
    enableCustomVideoCapture 사용자 정의 비디오 수집 모드 활성화
    sendCustomVideoData 수집한 비디오 데이터 전송
    startScreenCapture 화면 공유 시작(Android)
    muteLocalVideo 로컬 비디오 스트림 게시 일시 중지/재개
    muteRemoteVideoStream 원격 사용자 비디오 스트림 구독 일시 중지/재개
    startSpeedTest 네트워크 속도 테스트 시작(방 입장 전 사용)

    오류 및 경고 이벤트

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

    방 관련 이벤트 콜백

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

    사용자 관련 이벤트 콜백

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

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

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

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

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

    하드웨어 관련 이벤트 콜백

    API 설명
    onCameraDidReady 카메라 준비 완료
    onMicDidReady 마이크 준비 완료
    onAudioRouteChanged 오디오 경로가 변경됨(모바일만 해당)
    onUserVoiceVolume 볼륨

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

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

    CDN 관련 이벤트 콜백

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

    화면 공유 관련 이벤트 콜백

    API 설명
    onScreenCaptureStarted 화면 공유 활성화 이벤트 콜백
    onScreenCapturePaused 화면 공유 일시중지 이벤트 콜백
    onScreenCaptureResumed 화면 공유 재개 이벤트 콜백
    onScreenCaptureStopped 화면 공유 중지 이벤트 콜백

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

    API 설명
    onLocalRecordBegin 로컬 녹화 작업 시작 이벤트 콜백
    onLocalRecording 로컬 녹화 작업 진행 중 이벤트 콜백
    onLocalRecordComplete 로컬 녹화 작업 종료 이벤트 콜백

    사용하지 않는 이벤트 콜백

    API 설명
    onUserEnter 호스트가 현재 방에 입장함(폐기됨)
    onUserExit 호스트가 현재 방에서 퇴장함(폐기됨)
    onAudioEffectFinished 음향 효과 종료(폐기됨)
    onSpeedTest 서버 속도 테스트 결과 콜백(폐기됨)

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

    API 설명
    onRenderVideoFrame 사용자 정의 비디오 렌더링 콜백
    onGLContextCreated SDK의 OpenGL 컨텍스트 생성 알림
    onProcessVideoFrame 타사 뷰티 필터 컴포넌트에 의한 비디오 처리 콜백
    onGLContextDestory SDK의 OpenGL 컨텍스트 폐기에 대한 알림

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

    API 설명
    onCapturedRawAudioFrame 로컬에서 수집되고 오디오 모듈에서 전처리된 오디오 데이터 콜백
    onLocalProcessedAudioFrame 로컬에서 수집되고 오디오 모듈에서 전처리, 사운드 처리 및 BGM 믹싱된 오디오 데이터 콜백
    onRemoteUserAudioFrame 각 원격 사용자의 오디오 믹싱 전 오디오 데이터
    onMixedPlayAudioFrame 재생하기 위해 시스템에 제출되기 전 각 채널에서 믹싱된 오디오 데이터 콜백
    onMixedAllAudioFrame SDK의 모든 믹싱된 오디오 데이터(수집 및 재생 대기 중 포함)

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

    API 설명
    onLog 로컬 LOG 출력 콜백

    비디오 관련 열거 값 정의

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

    네트워크 관련 열거 값 정의

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

    오디오 관련 열거 값 정의

    API 설명
    TRTCAudioSampleRate 오디오 샘플링 레이트
    TRTCAudioQuality 오디오 품질
    TRTCAudioRoute 오디오 경로(오디오 재생 모드)
    TRTCReverbType 오디오 리버브 모드
    TRTCVoiceChangerType 음성 변조 유형
    TRTCSystemVolumeType 시스템 볼륨 유형(모바일만 해당)
    TRTCAudioCapabilityType 시스템에서 지원하는 오디오 기능 유형(Android 장치만 해당)

    기타 열거 값 정의

    API 설명
    TRTCLogLevel Log 레벨
    TRTCGSensorMode G-센서 스위치(모바일만 해당)
    TRTCTranscodingConfigMode 클라우드 혼합 스트림 레이아웃 모드
    TRTCRecordType 미디어 녹화 유형
    TRTCMixInputType 혼합 스트림 입력 유형
    TRTCAudioRecordingContent 오디오 녹음 콘텐츠 유형

    TRTC 핵심 유형 정의

    API 설명
    TRTCParams 방 입장 매개변수
    TRTCVideoEncParam 비디오 인코딩 매개변수
    TRTCNetworkQosParam 네트워크 트래픽 제어(Qos) 매개변수 세트
    TRTCRenderParams 영상 화면 렌더링 매개변수
    TRTCQualityInfo 네트워크 품질
    TRTCVolumeInfo 볼륨 크기
    TRTCSpeedTestParams 속도 테스트 매개변수
    TRTCSpeedTestResult 네트워크 속도 테스트 결과
    TRTCTexture 비디오 텍스쳐 데이터(Android만 해당, 텍스처 ID 및 EGL 환경 포함)
    TRTCVideoFrame 비디오 프레임 정보
    TRTCAudioFrame 오디오 프레임 데이터
    TRTCMixUser 클라우드 혼합 스트림의 각 채널 화면에 대한 설명 정보
    TRTCTranscodingConfig 클라우드 혼합 스트림의 레이아웃 및 트랜스 코딩 매개변수
    TRTCPublishCDNParam Tencent Cloud CDN 외에 멀티미디어 스트림을 게시할 때 설정해야 하는 푸시 매개변수
    TRTCAudioRecordingParams 로컬 오디오 파일 녹음 매개변수
    TRTCLocalRecordingParams 로컬 미디어 파일 녹화 매개변수
    TRTCAudioEffectParam 음향 효과 매개변수(폐기됨)
    TRTCSwitchRoomConfig 방 전환 매개변수
    TRTCAudioFrameCallbackFormat 오디오 사용자 정의 콜백 형식 매개변수
    TRTCScreenShareParams 화면 공유 매개변수(Android 플랫폼만 적용)
    문의하기

    고객의 업무에 전용 서비스를 제공해드립니다.

    기술 지원

    더 많은 도움이 필요하시면, 티켓을 통해 연락 바랍니다. 티켓 서비스는 연중무휴 24시간 제공됩니다.

    연중무휴 24시간 전화 지원