API | 描述 |
获取单例对象。 | |
销毁单例对象。 | |
设置事件回调。 | |
设置事件回调所在的线程。 | |
登录。 | |
登出。 | |
修改个人信息。 |
API | 描述 |
创建房间(主播调用),若房间不存在,系统将自动创建一个新房间。 | |
销毁房间(主播调用)。 | |
进入房间(观众调用)。 | |
离开房间(观众调用)。 | |
获取房间列表的详细信息。 | |
获取房间内所有的主播列表,enterRoom() 成功后调用才有效。 | |
获取房间内所有的成员信息,enterRoom() 成功后调用才有效。 |
API | 描述 |
开启本地视频的预览画面。 | |
停止本地视频采集及预览。 | |
开始直播(推流)。 | |
停止直播(推流)。 | |
播放远端视频画面,可以在普通观看和连麦场景中调用。 | |
停止渲染远端视频画面。 |
API | 描述 |
观众请求连麦。 | |
主播处理连麦请求。 | |
主播踢除连麦观众。 |
API | 描述 |
主播请求跨房 PK。 | |
主播响应跨房 PK 请求。 | |
退出跨房 PK。 |
API | 描述 |
切换前后摄像头。 | |
设置是否镜像展示。 | |
静音本地音频。 | |
静音远端音频。 | |
静音所有远端音频。 |
API | 描述 |
API | 描述 |
API | 描述 |
在房间中广播文本消息,一般用于弹幕聊天。 | |
发送自定义文本消息。 |
API | 描述 |
错误回调。 | |
警告回调。 | |
其他用户登录了同一账号,被踢下线。 |
API | 描述 |
本地进房回调。 | |
远端用户是否存在可播放的主路画面(一般用于摄像头)。 | |
房间被销毁的回调。 |
API | 描述 |
收到新主播进房通知。 | |
收到主播退房通知。 | |
收到观众进房通知。 | |
收到观众退房通知。 |
API | 描述 |
主播收到观众连麦请求时的回调。 | |
主播同意观众的连麦请求。 | |
主播拒绝观众的连麦请求。 | |
连麦观众收到被踢出连麦的通知。 |
API | 描述 |
收到请求跨房 PK 通知。 | |
主播接受跨房 PK 请求。 | |
主播拒绝跨房 PK 请求。 | |
收到断开跨房 PK 通知。 |
API | 描述 |
收到文本消息。 | |
收到自定义消息。 |
static Future<TRTCLiveRoom> sharedInstance()
static void destroySharedInstance()
void registerListener(VoiceListenerFunc func);
void unRegisterListener(VoiceListenerFunc func);
Future<ActionCallback> login(int sdkAppId, String userId, String userSig, TRTCLiveRoomConfig config);
参数 | 类型 | 含义 |
sdkAppId | int | |
userId | String | 当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)。 |
userSig | String | |
config | TRTCLiveRoomConfig | 全局配置信息,请在登录时初始化,登录之后不可变更。 useCDNFirst 属性:用于设置观众观看方式。true 表示普通观众通过 CDN 观看,计费便宜但延时较高。false 表示普通观众通过低延时观看,计费价格介于 CDN 和连麦之间,但延迟可控制在1s以内。 CDNPlayDomain 属性:在 useCDNFirst 设置为 true 时才会生效,用于指定 CDN 观看的播放域名,您可以登录直播控制台 >【域名管理】页面中进行设置。 |
Future<ActionCallback> logout();
Future<ActionCallback> setSelfProfile(String userName, String avatarURL);
参数 | 类型 | 含义 |
userName | String | 昵称。 |
avatarURL | String | 头像地址。 |
Future<ActionCallback> createRoom(int roomId, TRTCCreateRoomParam roomParam);
参数 | 类型 | 含义 |
roomId | int | 房间标识,需要由您分配并进行统一管理。多个 roomID 可以汇总成一个直播间列表,腾讯云暂不提供直播间列表的管理服务,请自行管理您的直播间列表。 |
roomParam | RoomParam | 房间信息,用于房间描述的信息,例如房间名称,封面信息等。如果房间列表和房间信息都由您的服务器自行管理,可忽略该参数。 |
startCameraPreview()
打开摄像头预览,此时可以调整美颜参数。 createRoom()
创建直播间,房间创建成功与否会通过 ActionCallback 通知给主播。starPublish()
开始推流。Future<ActionCallback> destroyRoom();
Future<ActionCallback> enterRoom(int roomId);
参数 | 类型 | 含义 |
roomId | int | 房间标识。 |
enterRoom()
进入该房间。startPlay(userId)
并传入主播的 userId 开始播放。startPlay(userId)
即可开始播放。TRTCLiveRoomDelegate
中的 onAnchorEnter(userId)
的事件回调,该回调中携带主播的 userId 信息,再调用 startPlay(userId)
即可播放。Future<ActionCallback> exitRoom();
createRoom()
时通过 roomInfo 设置的。Future<RoomInfoCallback> getRoomInfos(List<String> roomIdList);
参数 | 类型 | 含义 |
roomIdList | List<String> | 房间号列表。 |
enterRoom()
成功后调用才有效。Future<UserListCallback> getAnchorList();
enterRoom()
成功后调用才有效。Future<UserListCallback> getRoomMemberList(int nextSeq)
参数 | 类型 | 含义 |
nextSeq | int | 分页拉取标志,第一次拉取填0,回调成功如果 nextSeq 不为零,需要分页,传入再次拉取,直至为0。 |
Future<void> startCameraPreview(bool isFrontCamera, int viewId);
参数 | 类型 | 含义 |
isFrontCamera | bool | true:前置摄像头;false:后置摄像头。 |
viewId | int | 视频 view 的回调 ID。 |
Future<void> stopCameraPreview();
Future<void> startPublish(String streamId);
参数 | 类型 | 含义 |
streamId | String? | 用于绑定直播 CDN 的 streamId,如果您希望观众通过直播 CDN 进行观看,需要指定当前主播的直播 streamId。 |
Future<void> stopPublish();
Future<void> startPlay(String userId, int viewId);
参数 | 类型 | 含义 |
userId | String | 需要观看的用户id。 |
viewId | int | 视频view的回调id。 |
enterRoom()
成功后调用 startPlay(userId)
播放主播的画面。TRTCLiveRoomDelegate
中的 onAnchorEnter(userId)
的事件回调,该回调中携带主播的 userId 信息,再调用 startPlay(userId)
即可播放主播的画面。TRTCLiveRoomDelegate
中的 onAnchorEnter(userId)
回调,此时使用回调中的 userId 调用 startPlay(userId)
即可播放连麦画面。onAnchorExit()
回调时,调用该接口。Future<void> stopPlay(String userId);
参数 | 类型 | 含义 |
userId | String | 对方的用户信息。 |
Future<ActionCallback> requestJoinAnchor();
requestJoinAnchor()
向主播发起连麦请求。TRTCLiveRoomDelegate
的 onRequestJoinAnchor()
回调通知。responseJoinAnchor()
决定是否接受来自观众的连麦请求。startCameraPreview()
开启本地摄像头。startPublish()
正式进入推流状态。TRTCLiveRoomDelegate
的 onAnchorEnter()
通知。startPlay()
即可看到连麦观众的视频画面。onAnchorEnter()
通知,调用 startPlay()
播放其他连麦者的视频画面。TRTCLiveRoomDelegate
的 onRequestJoinAnchor()
回调后需要调用此接口来处理观众的连麦请求。Future<ActionCallback> responseJoinAnchor(String userId, boolean agreee);
参数 | 类型 | 含义 |
userId | String | 观众 ID。 |
agree | bool | true:同意;false:拒绝。 |
TRTCLiveRoomDelegate
的 onKickoutJoinAnchor()
回调通知。Future<ActionCallback> kickoutJoinAnchor(String userId);
参数 | 类型 | 含义 |
userId | String | 连麦观众 ID。 |
Future<ActionCallback> requestRoomPK(int roomId, String userId);
参数 | 类型 | 含义 |
roomId | int | 被邀约房间 ID。 |
userId | String | 被邀约主播 ID。 |
requestRoomPK()
向主播 B 发起连麦请求。TRTCLiveRoomDelegate
的 onRequestRoomPK()
回调通知。responseRoomPK()
决定是否接受主播 A 的 PK 请求。TRTCLiveRoomDelegate
的 onAnchorEnter()
通知,然后调用 startPlay()
来显示主播 A 的视频画面。onRoomPKAccepted
或onRoomPKRejected
回调通知。TRTCLiveRoomDelegate
的 onAnchorEnter()
通知,然后调用 startPlay()
显示主播 B 的视频画面。requestRoomPK
传入的 responseCallback
回调。Future<ActionCallback> responseRoomPK(String userId, boolean agree);
参数 | 类型 | 含义 |
userId | String | 发起 PK 请求的主播 ID。 |
agree | bool | true:同意;false:拒绝。 |
TRTCLiveRoomDelegate
的 onQuitRoomPk()
回调通知。Future<ActionCallback> quitRoomPK();
Future<void> switchCamera(boolean isFrontCamera);
Future<void> setMirror(boolean isMirror);
参数 | 类型 | 含义 |
isMirror | bool | 开启/关闭镜像。 |
Future<void> muteLocalAudio(boolean mute);
参数 | 类型 | 含义 |
mute | boolean | true:开启静音;false:关闭静音。 |
Future<void> muteRemoteAudio(String userId, boolean mute);
参数 | 类型 | 含义 |
userId | String | 远端的用户 ID。 |
mute | boolean | true:开启静音;false:关闭静音。 |
Future<void> muteAllRemoteAudio(boolean mute);
参数 | 类型 | 含义 |
mute | boolean | true:开启静音;false:关闭静音。 |
getAudioEffectManager();
getBeautyManager();
Future<ActionCallback> sendRoomTextMsg(String message);
参数 | 类型 | 含义 |
message | String | 文本消息。 |
Future<ActionCallback> sendRoomCustomMsg(String cmd, String message);
参数 | 类型 | 含义 |
cmd | String | 命令字,由开发者自定义,主要用于区分不同消息类型。 |
message | String | 文本消息。 |
参数 | 类型 | 含义 |
errCode | int | 错误码。 |
errMsg | String | 错误信息。 |
参数 | 类型 | 含义 |
warningCode | int | 错误码。 |
warningMsg | String | 警告信息。 |
参数 | 类型 | 含义 |
result | int | result > 0 时为进房耗时(ms),result < 0 时为进房错误码。 |
参数 | 类型 | 含义 |
userId | String | 用户标识。 |
available | boolean | 画面是否开启。 |
TRTCLiveRoom
的 startPlay()
显示该主播的视频画面。参数 | 类型 | 含义 |
userId | String | 新进房主播 ID。 |
userName | String | 用户昵称。 |
userAvatar | String | 用户头像地址。 |
TRTCLiveRoom
的 stopPlay()
关闭该主播的视频画面。参数 | 类型 | 含义 |
userId | String | 退出主播 ID。 |
userName | String | 用户昵称。 |
userAvatar | String | 用户头像地址。 |
void onAudienceEnter(TRTCLiveRoomDef.TRTCLiveUserInfo userInfo);
参数 | 类型 | 含义 |
userInfo | TRTCLiveRoomDef.TRTCLiveUserInfo | 进房观众用户 ID、昵称、头像等信息。 |
参数 | 类型 | 含义 |
userId | String | 退房观众信息。 |
userName | String | 用户昵称。 |
userAvatar | String | 用户头像地址。 |
参数 | 类型 | 含义 |
userId | String | 请求连麦用户 ID。 |
userName | String | 用户昵称。 |
userAvatar | String | 用户头像地址。 |
参数 | 类型 | 含义 |
userId | String | 主播的用户 ID。 |
参数 | 类型 | 含义 |
userId | String | 主播的用户 ID。 |
TRTCLiveRoom
的 stopPublish()
退出连麦。TRTCLiveRoomDelegate
的 onAnchorEnter()
通知,然后调用 startPlay()
来播放邀约主播的流。参数 | 类型 | 含义 |
userId | String | 请求跨房用户 ID。 |
userName | String | 用户昵称。 |
userAvatar | String | 用户头像地址。 |
参数 | 类型 | 含义 |
userId | String | 接收跨房 PK 的用户 ID。 |
参数 | 类型 | 含义 |
userId | String | 拒绝跨房 PK 的用户 ID。 |
参数 | 类型 | 含义 |
message | String | 文本消息。 |
参数 | 类型 | 含义 |
command | String | 命令字,由开发者自定义,主要用于区分不同消息类型。 |
message | String | 文本消息。 |
本页内容是否解决了您的问题?