API | 描述 |
获取单例对象。 | |
销毁单例对象。 | |
设置事件回调。 | |
设置事件回调所在的线程。 | |
登录。 | |
登出。 | |
修改个人信息。 |
API | 描述 |
创建房间(房主调用),若房间不存在,系统将自动创建一个新房间。 | |
销毁房间(房主调用)。 | |
进入房间(听众调用)。 | |
退出房间(听众调用)。 | |
获取房间列表的详细信息。 | |
获取指定 userId 的用户信息,如果为 nil,则获取房间内所有人的信息。 |
API | 描述 |
开启麦克风采集。 | |
停止麦克风采集。 | |
设置音质。 | |
开启/关闭本地静音。 | |
设置开启扬声器。 | |
设置麦克风采集音量。 | |
设置播放音量。 | |
开启/关闭 耳返。 |
API | 描述 |
静音/解除静音指定成员。 | |
静音/解除静音所有成员。 |
API | 描述 |
API | 描述 |
在房间中广播文本消息,一般用于弹幕聊天。 | |
发送自定义文本消息。 |
API | 描述 |
向用户发送邀请。 | |
接受邀请。 | |
拒绝邀请。 | |
取消邀请。 |
API | 描述 |
错误回调。 | |
警告回调。 | |
Log 回调。 |
API | 描述 |
房间被销毁的回调。 | |
语聊房间信息变更回调。 | |
用户通话音量回调。 |
API | 描述 |
全量的麦位列表变化。 | |
有成员上麦(主动上麦/房主抱人上麦)。 | |
有成员下麦(主动下麦/房主踢人下麦)。 | |
房主禁麦。 | |
用户麦克风是否静音。 | |
房主封麦。 |
API | 描述 |
收到听众进房通知。 | |
收到听众退房通知。 |
API | 描述 |
收到文本消息。 | |
收到自定义消息。 |
API | 描述 |
收到新的邀请请求。 | |
被邀请人接受邀请。 | |
被邀请人拒绝邀请。 | |
邀请人取消邀请。 |
/*** 获取 TRTCVoiceRoom 单例对象** - returns: TRTCVoiceRoom 实例* - note: 可以调用 {@link TRTCVoiceRoom#destroySharedInstance()} 销毁单例对象*/+ (instancetype)sharedInstance NS_SWIFT_NAME(shared());
/*** 销毁 TRTCVoiceRoom 单例对象** - note: 销毁实例后,外部缓存的 TRTCVoiceRoom 实例不能再使用,需要重新调用 {@link TRTCVoiceRoom#sharedInstance()} 获取新实例*/+ (void)destroySharedInstance NS_SWIFT_NAME(destroyShared());
/*** 设置组件回调接口** 您可以通过 TRTCVoiceRoomDelegate 获得 TRTCVoiceRoom 的各种状态通知** - parameter delegate 回调接口* - note: TRTCVoiceRoom 中的回调事件,默认是在 Main Queue 中回调给您;如果您需要指定事件回调所在的队列,可使用 {@link TRTCVoiceRoom#setDelegateQueue(queue)}*/- (void)setDelegate:(id<TRTCVoiceRoomDelegate>)delegate NS_SWIFT_NAME(setDelegate(delegate:));
/*** 设置事件回调所在的队列** - parameter queue 队列,TRTCVoiceRoom 中的各种状态通知回调,会派发到您指定的queue。*/- (void)setDelegateQueue:(dispatch_queue_t)queue NS_SWIFT_NAME(setDelegateQueue(queue:));
参数 | 类型 | 含义 |
queue | dispatch_queue_t | TRTCVoiceRoom 中的各种状态通知,会派发到您指定的线程队列里去。 |
- (void)login:(int)sdkAppIDuserId:(NSString *)userIduserSig:(NSString *)userSigcallback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(login(sdkAppID:userId:userSig:callback:));
参数 | 类型 | 含义 |
sdkAppId | int | |
userId | NSString | 当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)。 |
userSig | NSString | |
callback | ActionCallback | 登录回调,成功时 code 为0。 |
- (void)logout:(ActionCallback _Nullable)callback NS_SWIFT_NAME(logout(callback:));
参数 | 类型 | 含义 |
callback | ActionCallback | 登出回调,成功时 code 为0。 |
- (void)setSelfProfile:(NSString *)userName avatarURL:(NSString *)avatarURL callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(setSelfProfile(userName:avatarURL:callback:));
参数 | 类型 | 含义 |
userName | NSString | 昵称。 |
avatarURL | NSString | 头像地址。 |
callback | ActionCallback | 个人信息设置回调,成功时 code 为0。 |
- (void)createRoom:(int)roomID roomParam:(VoiceRoomParam *)roomParam callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(createRoom(roomID:roomParam:callback:));
参数 | 类型 | 含义 |
roomId | int | 房间标识,需要由您分配并进行统一管理。多个 roomID 可以汇总成一个语聊房间列表,腾讯云暂不提供语聊房间列表的管理服务,请自行管理您的语聊房间列表。 |
roomParam | VoiceRoomParam | 房间信息,用于房间描述的信息。例如房间名称、麦位信息、封面信息等。如果需要麦位管理,必须要填入房间的麦位数。 |
callback | ActionCallback | 创建房间的结果回调,成功时 code 为0。 |
createRoom
创建新的语音聊天室,此时传入房间 ID、上麦是否需要房主确认、麦位数等房间属性信息。enterSeat
进入座位。onSeatListChange
麦位表变化事件通知,此时可以将麦位表变化刷新到 UI 界面上。onAnchorEnterSeat
的事件通知,此时会自动打开麦克风采集。- (void)destroyRoom:(ActionCallback _Nullable)callback NS_SWIFT_NAME(destroyRoom(callback:));
参数 | 类型 | 含义 |
callback | ActionCallback | 销毁房间的结果回调,成功时 code 为0。 |
- (void)enterRoom:(NSInteger)roomID callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(enterRoom(roomID:callback:));
参数 | 类型 | 含义 |
roomId | NSInteger | 房间标识。 |
callback | ActionCallback | 进入房间的结果回调,成功时 code 为0。 |
enterRoom
并传入房间号即可进入该房间。onRoomInfoChange
房间属性变化事件通知,此时可以记录房间属性并做相应改变,例如 UI 展示房间名、记录上麦是否需要请求房主同意等。onSeatListChange
麦位表变化事件通知,此时可以将麦位表变化刷新到 UI 界面上。onAnchorEnterSeat
的事件通知。- (void)exitRoom:(ActionCallback _Nullable)callback NS_SWIFT_NAME(exitRoom(callback:));
参数 | 类型 | 含义 |
callback | ActionCallback | 退出房间的结果回调,成功时 code 为0。 |
createRoom()
时通过 roomInfo 设置的。- (void)getRoomInfoList:(NSArray<NSNumber *> *)roomIdList callback:(VoiceRoomInfoCallback _Nullable)callback NS_SWIFT_NAME(getRoomInfoList(roomIdList:callback:));
参数 | 类型 | 含义 |
roomIdList | NSArray<NSNumber> | 房间号列表。 |
callback | RoomInfoCallback | 房间详细信息回调。 |
- (void)getUserInfoList:(NSArray<NSString *> * _Nullable)userIDList callback:(VoiceRoomUserListCallback _Nullable)callback NS_SWIFT_NAME(getUserInfoList(userIDList:callback:));
参数 | 类型 | 含义 |
userIdList | NSArray<NSString> | 需要获取的用户 ID 列表,如果为 null,则获取房间内所有人的信息。 |
userlistcallback | UserListCallback | 用户详细信息回调。 |
onSeatListChange
和 onAnchorEnterSeat
的事件通知。- (void)enterSeat:(NSInteger)seatIndex callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(enterSeat(seatIndex:callback:));
参数 | 类型 | 含义 |
seatIndex | NSInteger | 需要上麦的麦位序号。 |
callback | ActionCallback | 操作回调。 |
sendInvitation
向房主申请,收到 onInvitationAccept
后再调用该函数。onSeatListChange
、 onAnchorLeaveSeat
和 onAnchorEnterSeat
的事件通知。(主播调用后,只是修改麦位座位号信息,并不会切换该用户的主播身份。)- (NSInteger)moveSeat:(NSInteger)seatIndex callback:(ActionCallback _Nullable)callbackNS_SWIFT_NAME(moveSeat(seatIndex:callback:))
参数 | 类型 | 含义 |
seatIndex | NSInteger | 需要移动到的麦位序号。 |
callback | ActionCallback | 操作回调。 |
返回值 | 类型 | 含义 |
code | NSInteger | 移动麦位操作结果(0为成功,其它为失败,10001为接口调用限频)。 |
sendInvitation
向房主申请,收到 onInvitationAccept
后再调用该函数。onSeatListChange
和 onAnchorLeaveSeat
的事件通知。- (void)leaveSeat:(ActionCallback _Nullable)callback NS_SWIFT_NAME(leaveSeat(callback:));
参数 | 类型 | 含义 |
callback | ActionCallback | 操作回调。 |
onSeatListChange
和 onAnchorEnterSeat
的事件通知。- (void)pickSeat:(NSInteger)seatIndex userId:(NSString *)userId callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(pickSeat(seatIndex:userId:callback:));
参数 | 类型 | 含义 |
seatIndex | NSInteger | 需要抱上麦的麦位序号。 |
userId | NSString | 用户 ID。 |
callback | ActionCallback | 操作回调。 |
sendInvitation
向听众申请,收到 onInvitationAccept
后再调用该函数。onSeatListChange
和 onAnchorLeaveSeat
的事件通知。- (void)kickSeat:(NSInteger)seatIndex callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(kickSeat(seatIndex:callback:));
参数 | 类型 | 含义 |
seatIndex | NSInteger | 需要踢下麦的麦位序号。 |
callback | ActionCallback | 操作回调。 |
onSeatListChange
和 onSeatMute
的事件通知。- (void)muteSeat:(NSInteger)seatIndex isMute:(BOOL)isMute callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(muteSeat(seatIndex:isMute:callback:));
参数 | 类型 | 含义 |
seatIndex | NSInteger | 需要操作的麦位序号。 |
isMute | BOOL | YES:静音对应麦位;NO:解除静音对应麦位。 |
callback | ActionCallback | 操作回调。 |
onSeatListChange
和 onSeatClose
的事件通知。- (void)closeSeat:(NSInteger)seatIndex isClose:(BOOL)isClose callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(closeSeat(seatIndex:isClose:callback:));
参数 | 类型 | 含义 |
seatIndex | NSInteger | 需要操作的麦位序号。 |
isClose | BOOL | YES:封禁对应麦位; NO:解封对应麦位。 |
callback | ActionCallback | 操作回调。 |
- (void)startMicrophone;
- (void)stopMicrophone;
- (void)setAuidoQuality:(NSInteger)quality NS_SWIFT_NAME(setAuidoQuality(quality:));
参数 | 类型 | 含义 |
quality | NSInteger |
- (void)muteLocalAudio:(BOOL)mute NS_SWIFT_NAME(muteLocalAudio(mute:));
参数 | 类型 | 含义 |
mute | BOOL |
- (void)setSpeaker:(BOOL)userSpeaker NS_SWIFT_NAME(setSpeaker(userSpeaker:));
参数 | 类型 | 含义 |
useSpeaker | BOOL | YES:扬声器;NO:听筒。 |
- (void)setAudioCaptureVolume:(NSInteger)voluem NS_SWIFT_NAME(setAudioCaptureVolume(volume:));
参数 | 类型 | 含义 |
volume | NSInteger | 采集音量,0 - 100, 默认100。 |
- (void)setAudioPlayoutVolume:(NSInteger)volume NS_SWIFT_NAME(setAudioPlayoutVolume(volume:));
参数 | 类型 | 含义 |
volume | NSInteger | 播放音量,0 - 100, 默认100。 |
- (void)muteRemoteAudio:(NSString *)userId mute:(BOOL)mute NS_SWIFT_NAME(muteRemoteAudio(userId:mute:));
参数 | 类型 | 含义 |
userId | NSString | 指定的用户 ID。 |
mute | BOOL | YES:开启静音;NO:关闭静音。 |
- (void)muteAllRemoteAudio:(BOOL)isMute NS_SWIFT_NAME(muteAllRemoteAudio(isMute:));
参数 | 类型 | 含义 |
mute | BOOL | YES:开启静音;NO:关闭静音。 |
- (void)setVoiceEarMonitorEnable:(BOOL)enable NS_SWIFT_NAME(setVoiceEarMonitor(enable:));
参数 | 类型 | 含义 |
enable | BOOL | YES:开启耳返;NO:关闭耳返。 |
- (TXAudioEffectManager * _Nullable)getAudioEffectManager;
- (void)sendRoomTextMsg:(NSString *)message callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendRoomTextMsg(message:callback:));
参数 | 类型 | 含义 |
message | NSString | 文本消息。 |
callback | ActionCallback | 发送结果回调。 |
- (void)sendRoomCustomMsg:(NSString *)cmd message:(NSString *)message callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendRoomCustomMsg(cmd:message:callback:));
参数 | 类型 | 含义 |
cmd | NSString | 命令字,由开发者自定义,主要用于区分不同消息类型。 |
message | NSString | 文本消息。 |
callback | ActionCallback | 发送结果回调。 |
- (NSString *)sendInvitation:(NSString *)cmduserId:(NSString *)userIdcontent:(NSString *)contentcallback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(sendInvitation(cmd:userId:content:callback:));
参数 | 类型 | 含义 |
cmd | NSString | 业务自定义指令。 |
userId | NSString | 邀请的用户 ID。 |
content | NSString | 邀请的内容。 |
callback | ActionCallback | 发送结果回调。 |
返回值 | 类型 | 含义 |
inviteId | NSString | 用于标识此次邀请 ID。 |
- (void)acceptInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(acceptInvitation(id:callback:));
参数 | 类型 | 含义 |
id | NSString | 邀请 ID。 |
callback | ActionCallback | 发送结果回调。 |
- (void)rejectInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(rejectInvitation(id:callback:));
参数 | 类型 | 含义 |
id | NSString | 邀请 ID。 |
callback | ActionCallback | 发送结果回调。 |
- (void)cancelInvitation:(NSString *)identifier callback:(ActionCallback _Nullable)callback NS_SWIFT_NAME(cancelInvitation(id:callback:));
参数 | 类型 | 含义 |
id | NSString | 邀请 ID。 |
callback | ActionCallback | 发送结果回调。 |
- (void)onError:(int)codemessage:(NSString*)messageNS_SWIFT_NAME(onError(code:message:));
参数 | 类型 | 含义 |
code | int | 错误码。 |
message | NSString | 错误信息。 |
- (void)onWarning:(int)codemessage:(NSString *)messageNS_SWIFT_NAME(onWarning(code:message:));
参数 | 类型 | 含义 |
code | int | 错误码。 |
message | NSString | 警告信息。 |
- (void)onDebugLog:(NSString *)messageNS_SWIFT_NAME(onDebugLog(message:));
参数 | 类型 | 含义 |
message | NSString | 日志信息。 |
- (void)onRoomDestroy:(NSString *)roomIdNS_SWIFT_NAME(onRoomDestroy(roomId:));
参数 | 类型 | 含义 |
roomId | NSString | 房间 ID。 |
- (void)onRoomInfoChange:(VoiceRoomInfo *)roomInfoNS_SWIFT_NAME(onRoomInfoChange(roomInfo:));
参数 | 类型 | 含义 |
roomInfo | VoiceRoomInfo | 房间信息。 |
- (void)onUserMicrophoneMute:(NSString *)userId mute:(BOOL)muteNS_SWIFT_NAME(onUserMicrophoneMute(userId:mute:));
参数 | 类型 | 含义 |
userId | NSString | 用户 ID。 |
mute | BOOL | YES:静音麦位; NO:解除静音。 |
- (void)onUserVolumeUpdate:(NSArray<TRTCVolumeInfo *> *)userVolumes totalVolume:(NSInteger)totalVolumeNS_SWIFT_NAME(onUserVolumeUpdate(userVolumes:totalVolume:));
参数 | 类型 | 含义 |
userVolumes | NSArray | 用户列表。 |
totalVolume | NSInteger | 音量大小,取值:0 - 100。 |
- (void)onSeatInfoChange:(NSArray<VoiceRoomSeatInfo *> *)seatInfolistNS_SWIFT_NAME(onSeatListChange(seatInfoList:));
参数 | 类型 | 含义 |
seatInfoList | NSArray<VoiceRoomSeatInfo> | 全量的麦位列表。 |
- (void)onAnchorEnterSeat:(NSInteger)indexuser:(VoiceRoomUserInfo *)userNS_SWIFT_NAME(onAnchorEnterSeat(index:user:));
参数 | 类型 | 含义 |
index | NSInteger | 成员上麦的麦位。 |
user | VoiceRoomUserInfo | 上麦用户的详细信息。 |
- (void)onAnchorLeaveSeat:(NSInteger)indexuser:(VoiceRoomUserInfo *)userNS_SWIFT_NAME(onAnchorLeaveSeat(index:user:));
参数 | 类型 | 含义 |
index | NSInteger | 下麦的麦位。 |
user | VoiceRoomUserInfo | 上麦用户的详细信息。 |
- (void)onSeatMute:(NSInteger)indexisMute:(BOOL)isMuteNS_SWIFT_NAME(onSeatMute(index:isMute:));
参数 | 类型 | 含义 |
index | NSInteger | 操作的麦位。 |
isMute | BOOL | YES:静音麦位; NO:解除静音。 |
- (void)onSeatClose:(NSInteger)indexisClose:(BOOL)isCloseNS_SWIFT_NAME(onSeatClose(index:isClose:));
参数 | 类型 | 含义 |
index | NSInteger | 操作的麦位。 |
isClose | BOOL | YES:封禁麦位; NO: 解禁麦位。 |
- (void)onAudienceEnter:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onAudienceEnter(userInfo:));
参数 | 类型 | 含义 |
userInfo | VoiceRoomUserInfo | 进房听众信息。 |
- (void)onAudienceExit:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onAudienceExit(userInfo:));
参数 | 类型 | 含义 |
userInfo | VoiceRoomUserInfo | 退房听众信息。 |
- (void)onRecvRoomTextMsg:(NSString *)messageuserInfo:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onRecvRoomTextMsg(message:userInfo:));
参数 | 类型 | 含义 |
message | NSString | 文本消息。 |
userInfo | VoiceRoomUserInfo | 发送者用户信息。 |
- (void)onRecvRoomCustomMsg:(NSString *)commandmessage:(NSString *)messageuserInfo:(VoiceRoomUserInfo *)userInfoNS_SWIFT_NAME(onRecvRoomCustomMsg(command:message:userInfo:));
参数 | 类型 | 含义 |
command | NSString | 命令字,由开发者自定义,主要用于区分不同消息类型。 |
message | NSString | 文本消息。 |
userInfo | VoiceRoomUserInfo | 发送者用户信息。 |
- (void)onReceiveNewInvitation:(NSString *)identifierinviter:(NSString *)invitercmd:(NSString *)cmdcontent:(NSString *)contentNS_SWIFT_NAME(onReceiveNewInvitation(id:inviter:cmd:content:));
参数 | 类型 | 含义 |
id | NSString | 邀请 ID。 |
inviter | NSString | 邀请人的用户 ID。 |
cmd | NSString | 业务指定的命令字,由开发者自定义。 |
content | NSString | 业务指定的内容。 |
- (void)onInviteeAccepted:(NSString *)identifierinvitee:(NSString *)inviteeNS_SWIFT_NAME(onInviteeAccepted(id:invitee:));
参数 | 类型 | 含义 |
id | NSString | 邀请 ID。 |
invitee | NSString | 被邀请人的用户 ID。 |
- (void)onInviteeRejected:(NSString *)identifierinvitee:(NSString *)inviteeNS_SWIFT_NAME(onInviteeRejected(id:invitee:));
参数 | 类型 | 含义 |
id | NSString | 邀请 ID。 |
invitee | NSString | 被邀请人的用户 ID。 |
- (void)onInvitationCancelled:(NSString *)identifierinvitee:(NSString *)invitee NS_SWIFT_NAME(onInvitationCancelled(id:invitee:));
参数 | 类型 | 含义 |
id | NSString | 邀请 ID。 |
inviter | NSString | 邀请人的用户 ID。 |
本页内容是否解决了您的问题?