tencent cloud

TUICallEngine API

TUICallEngine은 UI 요소를 포함하지 않는 오디오/비디오 통화 컴포넌트입니다. TUICallKit이 요구 사항을 충족하지 않는 경우 TUICallEngine의 API를 사용하여 프로젝트를 사용자 정의할 수 있습니다.

API 개요

API	설명
createInstance	TUICallEngine 인스턴스 생성(싱글톤 모드)
destroyInstance	TUICallEngine 인스턴스 종료(싱글톤 모드)
init	기본 음성/영상 통화 기능 인증
addObserver	이벤트 리스너 등록
removeObserver	이벤트 리스너 등록 취소
call	1v1 통화 호출
groupCall	그룹 통화 호출
accept	통화 수신
reject	통화 거절
hangup	통화 종료
ignore	통화 무시
inviteUser	현재 그룹 통화에 사용자 초대
joinInGroupCall	그룹 통화에 참여
switchCallMediaType	통화 유형 변경. 예를 들어, 화상 통화에서 음성 통화로 전환
startRemoteView	원격 사용자의 비디오 스트림 구독
stopRemoteView	원격 사용자의 비디오 스트림 구독 취소
openCamera	카메라를 켬
closeCamera	카메라를 끔
switchCamera	전면 및 후면 카메라 간 전환
openMicrophone	마이크를 켬
closeMicrophone	마이크를 끔
selectAudioPlaybackDevice	오디오 재생 장치(수신기 또는 스피커) 선택
setSelfInfo	대화명 및 프로필 사진 설정
enableMultiDeviceAbility	TUICallEngine에 대한 다중 장치 로그인 활성화 여부 설정(프리미엄 패키지에서 지원)

API 세부 정보

createInstance

이 API는 TUICallEngine 싱글톤을 생성하는 데 사용됩니다.

TUICallEngine createInstance(Context context)

destroyInstance

이 API는 TUICallEngine 싱글톤을 종료하는 데 사용됩니다.

void destroyInstance();

init

이 API는 TUICallEngine을 초기화하는 데 사용됩니다. 다른 API를 호출하기 전에 호출 서비스를 인증하고 다른 필수 작업을 수행하기 위해 호출합니다.

void init(int sdkAppId, String userId, String userSig, TUICommonDefine.Callback callback)

매개변수는 다음과 같습니다.

매개변수	유형	의미
sdkAppId	int	TRTC 콘솔 >애플리케이션 관리 > 애플리케이션 정보에서 SDKAppID를 확인할 수 있음
userId	String	현재의 사용자 ID. 문자열 유형은 영어 알파벳(a-z, A-Z), 숫자(0-9), 대시 부호(-), 언더바(_)만 허용
userSig	String	Tencent Cloud의 독점 보안 서명. 계산 및 사용 방법은 UserSig 참고
callback	TUICommonDefine.Callback	초기화 콜백, 'onSuccess'는 초기화가 성공했음을 표시

addObserver

이 API는 'TUICallObserver' 이벤트를 수신할 이벤트 리스너를 등록하는 데 사용됩니다.

void addObserver(TUICallObserver observer);

removeObserver

이 API는 이벤트 리스너를 등록 해제하는 데 사용됩니다.

void removeObserver(TUICallObserver observer);

call

이 API는 (1v1) 통화를 수행하는 데 사용됩니다.

void call(TUICommonDefine.RoomId roomId, String userId, TUICallDefine.MediaType callMediaType,
        TUICallDefine.CallParams params, TUICommonDefine.Callback callback);

매개변수는 다음과 같습니다.

매개변수	유형	의미
roomId	TUICommonDefine.RoomId	방 ID. 현재는 숫자로 된 방 ID만 사용할 수 있으며, 문자열 형식의 방 ID는 향후 지원될 예정임
userId	String	대상 userId
callMediaType	TUICallDefine.MediaType	비디오 또는 오디오일 수 있는 통화 유형
params	TUICallDefine.CallParams	추가 매개변수. 예를 들어 오프라인 알림을 사용자 지정하는 데 사용할 수 있음

groupCall

이 API는 그룹 통화를 하는 데 사용됩니다. 그룹 통화를 하기 전에 IM 그룹을 생성해야 합니다.

void groupCall(TUICommonDefine.RoomId roomId, String groupId, List<String> userIdList,    
             TUICallDefine.MediaType callMediaType, TUICallDefine.CallParams params,                               
             TUICommonDefine.Callback callback);

매개변수는 다음과 같습니다.

매개변수	유형	의미
roomId	TUICommonDefine.RoomId	방 ID. 현재는 숫자로 된 방 ID만 사용할 수 있으며, 문자열 형식의 방 ID는 향후 지원될 예정임
groupId	String	그룹 ID
userIdList	List	대상 userId
callMediaType	TUICallDefine.MediaType	비디오 또는 오디오일 수 있는 통화 유형
params	TUICallDefine.CallParams	추가 매개변수. 예를 들어 오프라인 알림을 사용자 지정하는 데 사용할 수 있음

accept

이 API는 통화를 수락하는 데 사용됩니다. 'onCallReceived()' 콜백을 수신한 후 이 API를 호출하여 통화를 수락할 수 있습니다.

void accept(TUICommonDefine.Callback callback);

reject

이 API는 통화를 거절하는 데 사용됩니다. 'onCallReceived()' 콜백을 수신한 후 이 API를 호출하여 통화를 거부할 수 있습니다.

void reject(TUICommonDefine.Callback callback);

ignore

이 API는 통화를 무시하는 데 사용됩니다. onCallReceived()를 수신한 후 이 API를 호출하여 통화를 무시할 수 있습니다. 호출자는 'onUserLineBusy' 콜백을 수신합니다.

참고: 프로젝트에 라이브 스트리밍 또는 회의가 포함된 경우 이 API를 사용하여 ‘회의 중’ 또는 ‘방송 중’ 기능을 구현할 수도 있습니다.

void ignore(TUICommonDefine.Callback callback);

hangup

이 API는 통화를 종료하는 데 사용됩니다.

void hangup(TUICommonDefine.Callback callback);

inviteUser

이 API는 현재 그룹 통화에 사용자를 초대하는 데 사용됩니다.

이 API는 그룹 통화의 참가자가 새 사용자를 초대하기 위해 호출합니다.

void inviteUser(List<String> userIdList, TUICallDefine.CallParams params, 
              TUICommonDefine.ValueCallback callback);

매개변수는 다음과 같습니다.

매개변수	유형	의미
userIdList	List	대상 userId
params	TUICallDefine.CallParams	추가 매개변수. 예를 들어 오프라인 알림을 사용자 지정하는 데 사용할 수 있음

joinInGroupCall

이 API는 그룹 통화에 참여하는 데 사용됩니다.

이 API는 그룹 구성원이 그룹 통화에 참여하기 위해 호출합니다.

void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, 
                   TUICallDefine.MediaType callMediaType, TUICommonDefine.Callback callback);

매개변수는 다음과 같습니다.

매개변수	유형	의미
roomId	TUICommonDefine.RoomId	방 ID. 현재는 숫자로 된 방 ID만 사용할 수 있으며, 문자열 형식의 방 ID는 향후 지원될 예정임
groupId	String	그룹 ID
callMediaType	TUICallDefine.MediaType	비디오 또는 오디오일 수 있는 통화 유형

switchCallMediaType

이 API는 통화 유형을 변경하는 데 사용됩니다.

void switchCallMediaType(TUICallDefine.MediaType callMediaType);

매개변수는 다음과 같습니다.

매개변수	유형	의미
callMediaType	TUICallDefine.MediaType	비디오 또는 오디오일 수 있는 통화 유형

startRemoteView

이 API는 원격 사용자의 비디오 스트림을 구독하는 데 사용됩니다. 작동하려면 setRenderView 다음에 호출해야 합니다.

void startRemoteView(String userId, TUIVideoView videoView, TUICommonDefine.PlayCallback callback);

매개변수는 다음과 같습니다.

매개변수	유형	의미
userId	String	대상 userId
videoView	TUIVideoView	렌더링할 뷰

stopRemoteView

이 API는 원격 사용자의 비디오 스트림 구독을 취소하는 데 사용됩니다.

void stopRemoteView(String userId);

매개변수는 다음과 같습니다.

매개변수	유형	의미
userId	String	대상 userId

openCamera

이 API는 카메라를 켜는 데 사용됩니다.

void openCamera(TUICommonDefine.Camera camera, TUIVideoView videoView, TUICommonDefine.Callback callback);

매개변수는 다음과 같습니다.

매개변수	유형	의미
camera	TUICommonDefine.Camera	전면/후면 카메라
videoView	TUIVideoView	렌더링할 뷰

closeCamera

이 API는 카메라를 끄는 데 사용됩니다.

void closeCamera();

switchCamera

이 API는 전면/후면 카메라 간에 전환하는 데 사용됩니다.

void switchCamera(TUICommonDefine.Camera camera);

매개변수는 다음과 같습니다.

매개변수	유형	의미
camera	TUICommonDefine.Camera	전면/후면 카메라

openMicrophone

이 API는 마이크를 켜는 데 사용됩니다.

void openMicrophone(TUICommonDefine.Callback callback);

closeMicrophone

이 API는 마이크를 끄는 데 사용됩니다.

void closeMicrophone();

selectAudioPlaybackDevice

이 API는 오디오 재생 장치(리시버 또는 스피커)를 선택하는 데 사용됩니다. 통화 시나리오에서 이 API를 사용하여 핸즈프리 모드를 켜고 끌 수 있습니다.

void selectAudioPlaybackDevice(TUICommonDefine.AudioPlaybackDevice device);

매개변수는 다음과 같습니다.

매개변수	유형	의미
device	TUICommonDefine.AudioPlaybackDevice	스피커/수신기

setSelfInfo

이 API는 대화명과 프로필 사진을 설정하는 데 사용됩니다. 대화명은 500바이트를 초과할 수 없으며 프로필 사진은 URL로 지정됩니다.

void setSelfInfo(String nickname, String avatar, TUICommonDefine.Callback callback);

매개변수는 다음과 같습니다.

매개변수	유형	의미
nickname	String	대화명
avatar	String	프로필 사진의 URL

enableMultiDeviceAbility

이 API는 TUICallEngine(프리미엄 패키지에서 지원)에 대한 다중 장치 로그인 활성화 여부를 설정하는 데 사용됩니다.

void enableMultiDeviceAbility(boolean enable, TUICommonDefine.Callback callback);