tencent cloud

Tencent Real-Time Communication

DocumentationTencent Real-Time Communication

TUIRoom API(iOS)

Download
Focus Mode
Font Size
Last updated: 2024-12-04 10:24:53
TUIRoom은 Tencent Real-Time Communication(TRTC)과 Instant Messaging(IM)을 기반으로 하며, 다음 기능을 지원합니다.
호스트가 방을 생성하고 방에 입장하는 사람이 방 번호를 입력한 후 참여.
방에 입장하는 사람들 간의 화면 공유.
다양한 텍스트 메시지 및 사용자 정의 메시지 발송 지원.
설명：
TUIKit 시리즈 컴포넌트는 Tencent Cloud의 두 가지 기본 PaaS 서비스, 즉 Tencent Real-Time Communication 및 Instant Messaging을 사용합니다. TRTC를 활성화하면 IM과 IM SDK 평가판(100 DAU만 지원)이 자동으로 활성화됩니다. IM 과금 규정은 요금 안내를 참고하십시오.
TUIRoom은 오픈 소스 Class로, Tencent Cloud의 두 가지 클로즈드 소스 SDK에 종속됩니다. 자세한 구현 방법은 TUIRoom (iOS) 통합을 참고하십시오.
TRTC SDK: TRTC SDK를 사용하는 저지연 멀티미디어 방 컴포넌트입니다.
IM SDK: IM SDK를 사용하여 채팅방 기능을 구현합니다(IM SDK는 iOS 버전 사용).

TUIRoom API 개요

TUIRoomCore 기본 함수

API
설명
싱글톤 객체 가져오기.
싱글톤 객체 폐기.
이벤트 콜백 설정.

방 관련 API

API
설명
방 생성(호스트 호출).
방 폐기(호스트 호출).
방 입장(참석자 호출).
방 퇴장(참석자 호출).
방 정보 가져오기.
방에 있는 모든 참석자 정보 가져오기.
특정 사용자 정보 가져오기.
호스트 권한 이전(호스트 호출).

로컬 멀티미디어 작업 인터페이스

API
설명
로컬 비디오 화면 미리보기 시작.
로컬 비디오 수집 및 미리보기 중지.
마이크 수집 활성화.
마이크 수집 정지.
로컬 화면 이미지 미리보기 모드 설정.
스피커 활성화 설정.

원격 사용자 관련 인터페이스

API
설명
지정된 참석자의 원격 비디오 화면 구독 및 재생.
구독 취소 및 원격 비디오 화면 재생 중지.

채팅 메시지 발송 인터페이스

API
설명
채팅 메시지 발송.
사용자 정의 메시지 발송.

필드 제어 관련 인터페이스

API
설명
사용자의 마이크 비활성화/복원.
모든 사용자의 마이크 비활성화/복원, 상태를 회의실 정보에 동기화.
사용자 카메라 비활성화/복원.
모든 사용자의 카메라 비활성화/복원, 상태를 방 정보에 동기화.
채팅방 음소거 활성화/비활성화(호스트 호출).
방에서 특정인 강제 퇴장(호스트 호출).
호스트 통화 시작.
호스트 지명 종료.
참석자가 호스트의 지명에 응답.
호스트의 참석자 발언 요청.
호스트의 참석자 발언 요청 취소.
참석자가 호스트의 발언 요청을 수락/거절.
참석자 발언 신청.
호스트가 참석자 발언 신청을 수락/거절.
호스트의 발언 신청 금지.
호스트의 참석자 발언 금지.
호스트의 전원 발언 금지.
참석자 발언 중지, 시청자로 전환.

화면 공유 인터페이스

API
설명
화면 공유 시작.
화면 수집 중지.

뷰티 필터 관련 API

API
설명
뷰티 필터 관리 객체 TXBeautyManager 가져오기.

관련 설정 인터페이스

API
설명
네트워크 트래픽 제어 관련 매개변수 설정.

SDK 버전 인터페이스 함수 가져오기

API
설명
SDK 버전 가져오기.

TUIRoomCoreDelegate API 개요

오류 이벤트 콜백

API
설명
오류 콜백.

기본 이벤트 콜백

API
설명
방 해산 콜백.
볼륨 크기 콜백 콜백.
호스트 변경 콜백.

원격 사용자 이벤트 콜백

API
설명
원격 사용자 방 입장 콜백.
원격 사용자 방 퇴장 콜백.
원격 사용자 카메라 활성화 여부 콜백.
원격 사용자 화면 공유 활성화 여부 콜백.
원격 사용자의 오디오 업스트림 활성화 여부 콜백.
원격 사용자 발언 시작 콜백.
원격 사용자가 발언 종료 콜백.

메시지 이벤트 콜백

API
설명
텍스트 메시지 수신 콜백.

필드 제어 이벤트 콜백

API
설명
사용자가 호스트의 발언 요청 수신 콜백.
사용자가 호스트의 발언 요청 취소 수신 콜백.
호스트가 사용자의 발언 요청 수신 콜백.
사용자의 발언 신청 취소 콜백.
사회자 발언 신청 금지 콜백.
참석자의 발언 중단 요청 수신 콜백.
호스트 지명 시작 시 참석자가 수신하는 콜백.
호스트 지명 종료 시 참석자가 수신하는 콜백.
참석자의 지명 응답 시 호스트가 수신하는 콜백.
호스트의 채팅방 음소거 상태 변경 콜백.
호스트의 마이크 비활성화 설정 콜백.
호스트의 카메라 비활성화 설정 콜백.
참석자가 수신하는 호스트의 내보내기 콜백.

네트워크 품질 및 기술 메트릭에 대한 통계를 위한 콜백 API

API
설명
기술 지표 통계 콜백.
네트워크 품질 콜백.

화면 공유 관련 콜백

API
설명
화면 공유 콜백 시작.
화면 공유 콜백 중지.

TUIRoomCore 기본 함수

getInstance

TUIRoomCore 싱글톤 객체 가져오기.
+ (instancetype)shareInstance;

destroyInstance

+ (void)destroyInstance;

setDelegate

TUIRoomCore 이벤트 콜백. TUIRoomCoreDelegate을 통해 TUIRoomCore 에서 다양한 상태 알림을 받을 수 있습니다.
- (void)setDelegate:(id<TUIRoomCoreDelegate>)delegate;
매개변수는 다음과 같습니다.
매개변수
유형
의미
delegate
TUIRoomCoreDelegate
이벤트 콜백 클래스 수신.

createRoom

방을 생성합니다(호스트 호출).
- (void)createRoom:(NSString *)roomId
        speechMode:(TUIRoomSpeechMode)speechMode
        callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
roomId
NSString
방 Id. 귀하가 직접 할당하고 통합 관리합니다.
speechMode
TUIRoomSpeechMode
발언 모드.
callback
TUIRoomActionCallback
방 생성 결과 콜백.
호스트 정상 호출 프로세스는 다음과 같습니다.
1. 호스트는 'createRoom()'을 호출하여 방을 만들고, 방 생성 성공 여부는 TUIRoomActionCallback을 통해 호스트에게 공지됩니다.
2. 호스트는 'startCameraPreview()'를 호출하여 카메라 캡처 및 미리보기를 시작합니다.
3. 호스트는 'startLocalAudio()'를 호출하여 로컬 마이크를 켭니다.

destroyRoom

방 폐기(호스트 호출). 호스트는 방 생성 후 해당 함수를 호출해 방을 폐기할 수 있습니다.
- (void)destroyRoom:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomActionCallback
방 폐기 결과 콜백.

enterRoom

방에 입장합니다(참석자 호출).
- (void)enterRoom:(NSString *)roomId
        callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
roomId
NSString
방 Id.
callback
TUIRoomActionCallback
결과 콜백.
참석자의 방 입장 정상 호출 프로세스는 다음과 같습니다.
1. 참석자는 'enterRoom'을 호출하고 roomId를 입력하여 방에 입장합니다.
2. 참석자는 startCameraPreview()를 호출하여 카메라 미리보기를 열고 startLocalAudio()를 호출하여 마이크 수집을 시작합니다.
3. 참석자는 onRemoteUserCameraAvailable 이벤트를 수신하고 startRemoteView()를 호출하여 비디오 재생을 시작합니다.

leaveRoom

방에서 퇴장합니다(참석자 호출).
 - (void)leaveRoom:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomActionCallback
결과 콜백.

getRoomInfo

방 정보 가져오기.
- (nullable TUIRoomInfo *)getRoomInfo;

getRoomUsers

방의 모든 구성원에 대한 정보를 가져옵니다.
 - (nullable NSArray<TUIRoomUserInfo *> *)getRoomUsers;

getUserInfo

참석자 정보를 가져옵니다.
- (void)getUserInfo:(NSString *)userId
           callback:(TUIRoomUserInfoCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 Id.
callback
TUIRoomUserInfoCallback
방 참석자 세부 정보 콜백.

setSelfProfile

사용자 정보를 설정합니다.
- (void)setSelfProfile:(NSString *)userName
        avatarURL:(NSString *)avatarURL
        callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userName
NSString
사용자 이름.
avatarURL
NSString
사용자 프로필 URL.
callback
TUIRoomActionCallback
성공적인 결과 콜백 설정 여부.

transferRoomMaster

그룹을 다른 사용자에게 이전합니다.
 - (void)transferRoomMaster:(NSString *)userId
                  callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 Id.
callback
TUIRoomActionCallback
결과 콜백.

로컬 푸시 스트림 인터페이스

startCameraPreview

로컬 카메라 미리보기를 시작합니다.
- (void)startCameraPreview:(BOOL)isFront
                      view:(UIView *)view;
매개변수는 다음과 같습니다.
매개변수
유형
의미
isFront
BOOL
YES: 전면 카메라, NO: 후면 카메라.
view
UIView
비디오 화면 컨트롤러.

stopCameraPreview

로컬 카메라 미리보기를 중지합니다.
- (void)stopCameraPreview;

startLocalAudio

마이크 수집을 시작합니다.
- (void)startLocalAudio:(TRTCAudioQuality)quality;
매개변수는 다음과 같습니다.
매개변수
유형
의미
quality
TRTCAudioQuality
수집된 사운드의 음질.

stopLocalAudio

마이크 수집 중지
- (void)stopLocalAudio;

setVideoMirror

로컬 화면 미리보기 모드를 설정합니다.
 - (void)setVideoMirror:(TRTCVideoMirrorType)type;
매개변수는 다음과 같습니다.
매개변수
유형
의미
type
TRTCVideoMirrorType
이미지 유형.

setSpeaker

스피커를 활성화합니다.
 - (void)setSpeaker:(BOOL)isUseSpeaker;
매개변수는 다음과 같습니다.
매개변수
유형
의미
isUseSpeaker
BOOL
YES: 스피커, NO: 헤드셋.

원격 사용자 관련 인터페이스

startRemoteView

원격 사용자의 비디오 스트림을 구독합니다.
- (void)startRemoteView:(NSString *)userId
                   view:(UIView *)view
             streamType:(TUIRoomStreamType)streamType
               callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
재생할 사용자 ID.
view
UIView
비디오 화면 view 컨트롤러.
streamType
TUIRoomStreamType
스트림 유형.
callback
TUIRoomActionCallback
결과 콜백.

stopRemoteView

구독을 취소하고 원격 영상 화면 재생을 중지합니다.
- (void)stopRemoteView:(NSString *)userId
            streamType:(TUIRoomStreamType)streamType
              callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
재생을 중지할 사용자 ID.
streamType
TUIRoomStreamType
스트림 유형.
callback
TUIRoomActionCallback
결과 콜백.

switchCamera

전면/후면 카메라를 전환합니다.
- (void)switchCamera:(BOOL)isFront;

매개변수는 다음과 같습니다.
매개변수
유형
의미
isFront
BOOL
YES: 전면 카메라, NO: 후면 카메라.

메시지 인터페이스 보내기

sendChatMessage

방 안에서 텍스트 메시지 발송, 일반적으로 텍스트 채팅에 사용됩니다.
- (void)sendChatMessage:(NSString *)message
               callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
message
NSString
메시지 내용.
callback
TUIRoomActionCallback
발송 결과 콜백.

필드 제어 관련 인터페이스

muteUserMicrophone

사용자의 마이크를 비활성화/복원합니다.
- (void)muteUserMicrophone:(NSString *)userId
                      mute:(BOOL)mute
                  callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
mute
BOOL
비활성화 여부.
callback
TUIRoomActionCallback
결과 콜백.

muteAllUsersMicrophone

모든 사용자의 마이크를 비활성화/복원합니다.
- (void)muteAllUsersMicrophone:(BOOL)mute
                      callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
mute
BOOL
비활성화 여부.
callback
TUIRoomActionCallback
결과 콜백.

muteUserCamera

사용자의 카메라를 비활성화/복원합니다.
- (void)muteUserCamera:(NSString *)userId
                  mute:(BOOL)mute
              callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
mute
BOOL
비활성화 여부.
callback
TUIRoomActionCallback
결과 콜백.

muteAllUsersCamera

모든 사용자의 카메라를 비활성화/복원합니다.
- (void)muteAllUsersCamera:(BOOL)mute
                  callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
mute
BOOL
비활성화 여부.
callback
TUIRoomActionCallback
결과 콜백.

muteChatRoom

텍스트 채팅을 비활성화/복원합니다.
- (void)muteChatRoom:(BOOL)mute
            callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
mute
BOOL
비활성화 여부.
callback
TUIRoomActionCallback
결과 콜백.

kickOffUser

호스트의 내보내기.
- (void)kickOffUser:(NSString *)userId
           callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
callback
TUIRoomActionCallback
결과 콜백.

startCallingRoll

호스트가 지명을 시작합니다.
 - (void)startCallingRoll:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomActionCallback
결과 콜백.

stopCallingRoll

호스트가 지명을 종료합니다.
- (void)stopCallingRoll:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomActionCallback
결과 콜백.

replyCallingRoll

참석자가 호스트의 지명에 응답합니다.
- (void)replyCallingRoll:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomActionCallback
결과 콜백.

sendSpeechInvitation

호스트가 참석자에게 발언을 요청합니다.
- (void)sendSpeechInvitation:(NSString *)userId
                    callback:(TUIRoomInviteeCallback)callback
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
callback
TUIRoomInviteeCallback
결과 콜백.

cancelSpeechInvitation

호스트가 참석자의 발언 요청을 취소합니다.
- (void)cancelSpeechInvitation:(NSString *)userId
                      callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
callback
TUIRoomActionCallback
결과 콜백.

replySpeechInvitation

참석자는 호스트의 발언 요청을 수락/거절합니다.
- (void)replySpeechInvitation:(BOOL)agree
                     callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
agree
BOOL
수락 여부.
callback
TUIRoomActionCallback
결과 콜백.

sendSpeechApplication

참석자가 발언을 신청합니다.
- (void)sendSpeechApplication:(TUIRoomInviteeCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomInviteeCallback
결과 콜백.

cancelSpeechApplication

참석자가 발언 신청을 취소합니다.
- (void)cancelSpeechApplication:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomActionCallback
결과 콜백.

replySpeechApplication

호스트가 참석자의 발언 신청을 수락/거절합니다.
- (void)replySpeechApplication:(BOOL)agree
                        userId:(NSString *)userId
                      callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
agree
BOOL
수락 여부
userId
NSString
사용자 ID.
callback
TUIRoomActionCallback
결과 콜백.

forbidSpeechApplication

호스트가 발언 신청을 금지합니다.
- (void)forbidSpeechApplication:(BOOL)forbid
                       callback:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
forbid
BOOL
금지 여부.
callback
TUIRoomActionCallback
결과 콜백.

sendOffSpeaker

호스트가 참석자의 발언을 금지합니다.
- (void)sendOffSpeaker:(NSString *)userId
              callback:(TUIRoomInviteeCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
callback
TUIRoomInviteeCallback
결과 콜백.

sendOffAllSpeakers

호스트가 모든 참석자의 발언을 금지합니다.
- (void)sendOffAllSpeakers:(TUIRoomInviteeCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomInviteeCallback
결과 콜백.

exitSpeechState

참석자가 발언을 중지하고 시청자로 전환합니다.
- (void)exitSpeechState:(TUIRoomActionCallback)callback;
매개변수는 다음과 같습니다.
매개변수
유형
의미
callback
TUIRoomActionCallback
결과 콜백.

화면 공유 인터페이스

startScreenCapture

화면 공유를 시작합니다.
- (void)startScreenCapture:(TRTCVideoEncParam *)encParam API_AVAILABLE(ios(11.0));
매개변수는 다음과 같습니다.
매개변수
유형
의미
encParams
TRTCVideoEncParam
화면 공유를 위한 인코딩 매개변수 설정.
설명：
자세한 내용은 TRTC SDK를 참고하십시오.

stopScreenCapture

화면 수집을 중지합니다.
- (void)stopScreenCapture API_AVAILABLE(ios(11.0));

뷰티 필터 관련 API

getBeautyManager

뷰티 필터 관리 객체 TXBeautyManager를 가져옵니다.
- (TXBeautyManager *)getBeautyManager;
뷰티 필터 관리를 통해 다음 기능을 사용할 수 있습니다.
'뷰티 필터 스타일', '미백', '안색 보정', '눈 크게', '갸름하게', 'V라인', '턱 조정', '얼굴 짧게', '코 작게', '반짝이는 눈', '치아 미백', '아래 눈꺼풀 조정', '주름 제거', '팔자 주름 제거' 등 뷰티 효과를 설정할 수 있습니다.
'헤어 라인', '눈 간격', '눈 각도', '입 모양', '콧볼', '코 위치', '입술 두께', '얼굴형'을 조정할 수 있습니다.
얼굴 효과(소재) 등 동적 효과를 설정할 수 있습니다.
메이크업 효과를 추가합니다.
손 동작을 인식합니다.

관련 설정 인터페이스

setVideoQosPreference

네트워크 트래픽 제어와 관련된 매개변수를 설정합니다.
- (void)setVideoQosPreference:(TRTCNetworkQosParam *)preference;
매개변수는 다음과 같습니다.
매개변수
유형
의미
preference
TRTCNetworkQosParam
네트워크 트래픽 제어 정책.

setAudioQuality

오디오 품질을 설정합니다.
- (void)setAudioQuality:(TRTCAudioQuality)quality;
매개변수는 다음과 같습니다.
매개변수
유형
의미
quality
TRTCAudioQuality
오디오 음질. 자세한 내용은 TRTC SDK를 참고하십시오.

setVideoResolution

해상도를 설정합니다.
- (void)setVideoResolution:(TRTCVideoResolution)resolution;
매개변수는 다음과 같습니다.
매개변수
유형
의미
resolution
TRTCVideoResolution
비디오 해상도. 자세한 내용은 TRTC SDK를 참고하십시오.

setVideoFps

프레임 레이트를 설정합니다.
- (void)setVideoFps:(int)fps;
매개변수는 다음과 같습니다.
매개변수
유형
의미
fps
int
비디오에서 수집하는 프레임 레이트.
설명：
권장 설정값: 15fps 또는 20fps를 권장합니다. 5fps는 랙이 심하게 발생하며, 10fps 이하는 약간의 랙이 발생하고, 20fps 이상은 너무 높습니다(영화 프레임 레이트 24fps).

setVideoBitrate

비트 레이트를 설정합니다.
- (void)setVideoBitrate:(int)bitrate;
매개변수는 다음과 같습니다.
매개변수
유형
의미
bitrate
int
비트 레이트, SDK는 타깃 비트 레이트에 따라 인코딩하며, 네트워크가 불안정한 상태에서만 자체적으로 비디오 비트 레이트를 줄입니다. 자세한 내용은 TRTC SDK를 참고하십시오.
설명：
권장 설정값: TRTCVideoResolution의 각 단계별 권장 최적 비트 레이트를 참고하고, 이를 기반으로 적합하게 높일 수 있습니다. 예를 들어 TRTC_VIDEO_RESOLUTION_1280_720의 권장 비트 레이트는 1200kbps이지만, 1500kbps로 설정하여 더 선명한 화면을 볼 수도 있습니다.

enableAudioEvaluation

볼륨 알림을 활성화합니다.
- (void)enableAudioEvaluation:(BOOL)enable;
매개변수는 다음과 같습니다.
매개변수
유형
의미
enable
BOOL
YES: 활성화, NO: 비활성화.
설명：
활성화하면 음량 크기값에 대한 SDK의 평가를 onUserVolumeUpdate에서 가져옵니다.

setAudioPlayVolume

재생 볼륨을 설정합니다.
- (void)setAudioPlayVolume:(NSInteger)volume;
매개변수는 다음과 같습니다.
매개변수
유형
의미
volume
int
재생 볼륨으로, 0-100으로 설정할 수 있으며 기본 값은 100입니다.

setAudioCaptureVolume

마이크 수집 볼륨을 설정합니다.
- (void)setAudioCaptureVolume:(NSInteger)volume;
매개변수는 다음과 같습니다.
매개변수
유형
의미
volume
int
수집 볼륨으로, 0-100으로 설정할 수 있으며 기본 값은 100입니다.

startFileDumping

녹음을 시작합니다.
- (void)startFileDumping:(TRTCAudioRecordingParams *)params;
매개변수는 다음과 같습니다.
매개변수
유형
의미
params
TRTCAudioRecordingParams
녹음 매개변수, 자세한 내용은 TRTC SDK를 참고하십시오.
설명：
해당 방법으로 호출하면 SDK에서 통화 중 모든 오디오(로컬 오디오, 원격 오디오, BGM 등 포함)를 하나의 파일로 녹음합니다. 방 입장 여부에 상관 없이 해당 인터페이스를 호출하면 모두 적용되며, leaveRoom 호출 시 녹음 중인 경우 녹음은 자동으로 중지됩니다.

stopFileDumping

녹음을 중지합니다.
- (void)stopFileDumping;

SDK 버전 인터페이스 가져오기

getSdkVersion

SDK 버전 정보를 가져옵니다.
- (NSInteger)getSdkVersion;

오류 이벤트 콜백

onError

- (void)onError:(NSInteger)code message:(NSString *)message;
매개변수는 다음과 같습니다.
매개변수
유형
의미
code
NSInteger
에러 코드.
message
NSString
오류 정보.

기본 이벤트 콜백

onDestroyRoom

방 해산 콜백입니다.
- (void)onDestroyRoom;

onUserVoiceVolume

사용자 볼륨 크기 콜백입니다.
- (void)onUserVoiceVolume:(NSString *)userId volume:(NSInteger)volume;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
volume
NSInteger
사용자의 볼륨 크기, 범위: 0 - 100.

onRoomMasterChanged

호스트 변경 콜백입니다.
- (void)onRoomMasterChanged:(NSString *)previousUserId
              currentUserId:(NSString *)currentUserId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
previousUserId
NSString
변경 전의 호스트 사용자 ID.
currentUserId
NSString
변경 후의 호스트 사용자 ID.

원격 사용자 콜백 이벤트

onRemoteUserEnter

원격 사용자 방 입장 콜백입니다.
- (void)onRemoteUserEnter:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.

onRemoteUserLeave

원격 사용자 방 퇴장 콜백입니다.
- (void)onRemoteUserLeave:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.

onRemoteUserCameraAvailable

원격 사용자 카메라 활성화 여부입니다.
- (void)onRemoteUserCameraAvailable:(NSString *)userId
                          available:(BOOL)available;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
available
BOOL
YES: 비디오 스트림 데이터 있음, NO: 비디오 스트림 데이터 없음.

onRemoteUserScreenVideoAvailable

참석자의 비디오 공유 알림을 활성화/비활성화합니다.
- (void)onRemoteUserScreenVideoAvailable:(NSString *)userId
                               available:(BOOL)available;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
available
BOOL
화면 공유 스트림 데이터가 있는지 여부.

onRemoteUserAudioAvailable

원격 사용자 오디오 업스트림 활성화 여부 콜백입니다.
- (void)onRemoteUserAudioAvailable:(NSString *)userId
                         available:(BOOL)available;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
available
BOOL
오디오 데이터 유무.

onRemoteUserEnterSpeechState

원격 사용자가 발언을 시작합니다.
- (void)onRemoteUserEnterSpeechState:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.

onRemoteUserExitSpeechState

원격 사용자가 발언을 종료합니다.
- (void)onRemoteUserExitSpeechState:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.

채팅방 메시지 이벤트 콜백

onReceiveChatMessage

텍스트 메시지를 수신합니다.
- (void)onReceiveChatMessage:(NSString *)userId message:(NSString *)message;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.
message
NSString
텍스트 메시지.

필드 제어 메시지 콜백

onReceiveSpeechInvitation

사용자가 호스트의 발언 요청 수신 콜백입니다.
- (void)onReceiveSpeechInvitation:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
호스트 사용자 ID.

onReceiveInvitationCancelled

사용자가 호스트의 발언 초대 취소 수신 콜백입니다.
- (void)onReceiveInvitationCancelled:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
호스트 사용자 ID.

OnReceiveSpeechApplication

호스트의 사용자 발언 요청 수신 콜백입니다.
void onReceiveSpeechApplication(String userId);
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.

onSpeechApplicationCancelled

사용자가 발언 신청을 취소하는 콜백입니다.
- (void)onSpeechApplicationCancelled:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.

onSpeechApplicationForbidden

호스트가 발언 신청을 금지하는 콜백입니다.
- (void)onSpeechApplicationForbidden:(BOOL)isForbidden userId:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
isForbidden
BOOL
금지 여부.
userId
NSString
사용자 ID.

onOrderedToExitSpeechState

참석자의 발언 중지 요청 수신 콜백입니다.
- (void)onOrderedToExitSpeechState:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
호스트 사용자 ID.

onCallingRollStarted

호스트가 지명을 시작하면 참석자가 수신하는 콜백입니다.
- (void)onCallingRollStarted:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
호스트 사용자 ID.

onCallingRollStopped

호스트가 지명을 종료하면 참석자가 수신하는 콜백입니다.
- (void)onCallingRollStopped:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
호스트 사용자 ID.

onMemberReplyCallingRoll

참석자가 지명에 응답하면 호스트가 수신하는 콜백입니다.
- (void)onMemberReplyCallingRoll:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
사용자 ID.

onChatRoomMuted

호스트의 채팅방 음소거 여부 변경에 대한 콜백입니다.
- (void)onChatRoomMuted:(BOOL)muted userId:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
muted
BOOL
음소거 여부.
userId
NSString
호스트 사용자 ID.

onMicrophoneMuted

호스트의 마이크 음소거 설정에 대한 콜백입니다.
- (void)onMicrophoneMuted:(BOOL)muted userId:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
muted
BOOL
음소거 여부.
userId
NSString
호스트 사용자 ID.

onCameraMuted

호스트의 카메라 음소거 설정에 대한 콜백입니다.
- (void)onCameraMuted:(BOOL)muted userId:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
muted
BOOL
음소거 여부.
userId
NSString
호스트 사용자 ID.

onReceiveKickedOff

호스트의 내보내기 콜백.
- (void)onReceiveKickedOff:(NSString *)userId;
매개변수는 다음과 같습니다.
매개변수
유형
의미
userId
NSString
호스트/관리자 사용자 ID.

통계 및 품질 콜백

onStatistics

기술 지표 통계 콜백입니다.
- (void)onStatistics:(TRTCStatistics *)statistics;
매개변수는 다음과 같습니다.
매개변수
유형
의미
statis
TRTCStatistics
통계 데이터.

onNetworkQuality

네트워크 상태 콜백입니다.
- (void)onNetworkQuality:(TRTCQualityInfo *)localQuality remoteQuality:(NSArray<TRTCQualityInfo *> *)remoteQuality;

매개변수는 다음과 같습니다.
매개변수
유형
의미
localQuality
TRTCQualityInfo
업스트림 네트워크 품질.
remoteQuality
NSArray<TRTCQualityInfo *>
다운스트림 네트워크 품질.
설명：
자세한 내용은 TRTC SDK를 참고하십시오.

화면 공유 이벤트 콜백

onScreenCaptureStarted

화면 공유 시작 콜백입니다.
 - (void)onScreenCaptureStarted;

onScreenCaptureStopped

화면 공유 중지 콜백입니다.
- (void)onScreenCaptureStopped:(NSInteger)reason;
매개변수는 다음과 같습니다.
매개변수
유형
의미
reason
NSInteger
중지 사유. 0: 사용자가 중지, 1: 다른 애플리케이션으로 인한 강제 중지.
Next Topic: Tencent Cloud 오디오/비디오 단말 SDK 재생 업그레이드 및 권한 부여 인증 추가

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback