API
更新时间:2023-04-23
初始化相关接口
brtc_create_client
void* brtc_create_client();
介绍
创建 brtc client。
用户使用该sdk开发的入口,首先需要创建brtc client, 通过该api初始化sdk、发布流、订阅流等其他可提供的api操作。
参数
无
返回
void类型指针
brtc_set_server_url
void brtc_set_server_url(void* rtc_client, const char* url);
介绍
设置访问的url。
在使用brtc_login_room之前调用进行url设置。
参数
参数 | 类型 | 描述 |
---|---|---|
rtc_client | void* | RTC client句柄 |
url | const char* | RTC client连接的服务器的url |
返回
无
brtc_init_sdk
bool brtc_init_sdk(void* rtc_client, const char* app_id, const char* room_name, const char* user_id, const char* token, const char* cer_path);
介绍
初始化SDK。
初始化FreeRtos rtc sdk, 需在使用之前调用进行初始化。
参数
参数 | 类型 | 描述 |
---|---|---|
rtc_client | void* | RTC client句柄 |
appId | const char* | RTC 基础业务单元的唯一标识 |
room_name | const char* | 房间名,长度不超过255字节 |
user_id | const char* | 用户id, 数字字符串,每个房间的用户id必须唯一 |
token | const char* | RTC Server 端鉴权使用的字符串 |
cerPath | const char* | ssl 证书存放路径,证书有百度提供 |
返回
true 成功, false 失败
brtc_deInit_sdk
void brtc_deInit_sdk(void* rtc_client);
介绍
销毁SDK。
sdk使用完,可调用该api进行释放,销毁操作。
参数
参数 | 类型 | 描述 |
---|---|---|
rtc_client | void* | RTC client句柄 |
返回
无
brtc_destroy_client
void brtc_destroy_client(void* rtc_client);
介绍
销毁brtc client。
对brtc client进行销毁操作,释放相关资源。
参数
参数 | 类型 | 描述 |
---|---|---|
rtc_client | void* | RTC client句柄 |
返回
无
房间相关接口
brtc_login_room
bool brtc_login_room(void* rtc_client);
介绍
房间登录。
登录房间成功后,用户可以发布流或订阅流,并能通过IRtcMessageListener接口获取房间状态信息。
参数
参数 | 类型 | 描述 |
---|---|---|
rtc_client | void* | RTC client句柄 |
返回
true 成功, false 失败
brtc_logout_room
bool brtc_logout_room(void* rtc_client);
介绍
房间登出。
关闭媒体通道,关闭信令通道,释放内存资源,及销毁其他申请的资源。
参数
参数 | 类型 | 描述 |
---|---|---|
rtc_client | void* | RTC client句柄 |
返回
true 成功, false 失败
消息接口
brtc_register_message_listener
void brtc_register_message_listener(void* rtc_client, IRtcMessageListener msgListener);
介绍
注册消息监听接口。
用户可以实现参数定义的接口,并通过该接口注册,当sdk启动后,可以收到来自sdk的消息,并做相应的处理。接口详细信息可查看头文件:baidu_rtc_common_define.h
参数
参数 | 类型 | 描述 |
---|---|---|
rtc_client | void* | RTC client句柄 |
msgListener | IRtcMessageListener | RTC sdk 消息上报接口 |
返回
无