Live/iosSDK
微博直播SDK接入方法-iOS
阅读以下文档,帮助了解如何使用微博直播SDK。
目录 |
开播流程
’‘’第三方开播页面——微博授权SDK——微博直播SDK‘’‘——推流直播
使用方法
1.需要使用微博授权,接入所需申请的权限见 微博授权 ;
2.申请微博直播所需权限,需提交appKey、Bundle id等,申请直播接口及直播互动接口权限,见直播权限申请;
3.导入WeiboLiveSDK.h,libWeiboLiveSDK.a,调用微博直播开播接口, 互动功能需要导入SinaLiveSDK相关头文件和库文件;
注:调用微博直播开播接口时,根据是否具有开播权限会唤起微博客户端或者跳转到浏览器微博客户端下载页面
接口说明
接口名称 | 功能描述 | 备注 |
---|---|---|
createLive | 创建直播 | |
updateLive | 更新直播 | |
deleteLive | 删除直播 | |
showLive | 获取直播信息 | |
registerWithBundle:user: | 注册Bundle | SinaLiveSDK |
addListener: | 添加互动监听 | SinaLiveSDK |
removeListener: | 移除互动监听 | SinaLiveSDK |
joinLiveRoom:succ:fail | 加入房间 | SinaLiveSDK |
exitLiveRoom:succ:fail | 退出房间 | SinaLiveSDK |
onNewMessage:requestId:errCode:errMsg: | 互动下发消息回调 | SinaLiveSDK |
注:各接口参数非必选字段传入nil值
1. createLive
- (NSString *) createLive:(NSString *)access_token title:(NSString*)title width:(NSString*)width height:(NSString*)height summary:(NSString*)summary published:(NSString*)published image:(NSString*)image replay:(NSString*)replay is_panolive:(NSString*)is_panolive;
功能:新建直播对象,获取直播推流地址,并同时发微博;
参数:Weibo开放平台创建直播接口参数;
返回值:有开播权限,返回Weibo开放平台创建直播接口返回值;没有开播权限返回nil,禁播用户会弹窗提醒;
2. updateLive
- (NSString *) updateLive:(NSString *)access_token liveid:(NSString*)liveid title:(NSString*)title summary:(NSString*)summary published:(NSString*)published image:(NSString*)image stop:(NSString*)stop replay_url:(NSString*)replay_url;
功能:直播对象信息、状态等更新;
参数:Weibo开放平台更新直播接口参数;
返回值:Weibo开放平台更新直播接口返回值;
3. deleteLive
- (NSString *) deleteLive:(NSString *)access_token liveid:(NSString*)liveid;
功能:直播对象删除,不可逆。
参数:Weibo开放平台删除直播接口参数;
返回值:Weibo开放平台删除直播接口返回值。
4. showLive
- (NSString *) showLive:(NSString *)access_token liveid:(NSString*)liveid detail:(NSString*)detail;
功能:直播对象信息、互动信息等获取;
参数:Weibo开放平台获取直播信息接口参数;
返回值:Weibo开放平台获取直播信息接口返回值;
5. registerWithBundle:user:
- (void)registerWithBundle:(WBIMBundle *)bundle user:(WBIMUser *)user;
功能:注册Bundle
参数:WBIMBundle对象,参照WBIMBundle定义,user对象,当前用户信息。
6. addListener:
-(void)addListener:(id<WBIMLiveListener>)listener;
功能:添加互动消息监听
参数:listener对象,实现协议参照 WBIMLiveListener
7. removeListener:
-(void)removeListener:(id<WBIMLiveListener>)listener;
功能:移除互动消息监听
参数:listener对象,实现协议参照 WBIMLiveListener
8. joinLiveRoom:succ:fail
- (void)joinLiveRoom:(WBIMJoinRoomRequest *)request succ:(void (^)(NSString *requestId, WBIMJoinRoomModel *response))succ fail:(void (^)(NSString *requestId, NSInteger code, NSString *msg))fail;
功能:加入房间(需要互动下发数据必须先加入房间)
参数:request对象,参照WBIMJoinRoomRequest定义,succ、fail为成功或失败后的回调。
9. exitLiveRoom:succ:fail
- (void)exitLiveRoom:(WBIMExitRoomRequest *)request succ:(void (^)(NSString *requestId, WBIMJoinRoomModel *response))succ fail:(void (^)(NSString *requestId, NSInteger code, NSString *msg))fail;
功能:退出房间(退出房间后即无法收取互动消息)
参数:request对象,参照WBIMExitRoomRequest定义,succ、fail为成功或失败后的回调。
10. onNewMessage:requestId:errCode:errMsg:
- (void)onNewMessage:(WBIMPushMessageModel *)msg requestId:(NSString *)requestId errCode:(NSInteger)errCode errMsg:(NSString *)errMsg;
功能:加入房间后互动消息会由此下发,下发数据内容具体见 WBIMPushMessageModel 定义。
参数:msg互动下发数据对象,requestId请求id,errCode错误代码,errMsg错误信息。
联系方式
接入及调试代码等工作,可联系guilu@staff.weibo.com
互动消息相关调试,可联系 liguang@staff.weibo.com