基础功能

更新时间:2021-05-25

概述

本文主要介绍了 SDK 功能中的常用功能和注意事项,例如登录和登出、获取直播列表、打开开播页、用户状态监测、订单信息获取等。

详细介绍

1. 登录账号

接入方 APP 在登录成功后,需要通过 server to server 交互 获取到 openID 和 token 后调用 SDK 接口进行绑定登录。具体获取 openID 和 token 可参考 服务端 SDK 集成 文档。

/// Called when login LinkV acount server successfully
/// @param originUid origin user uid
/// @param openID LinkV openID
/// @param token LinkV user token
- (void)onLoginSuccessWithOriginUid:(NSString *)originUid openID:(NSString *)openID token:(NSString *)token;

/// Called when the user logout
- (void)onLogout;

/// login status check
- (BOOL)isUserLogin;

2. 获取直播列表

(1) 列表视图

通过调用 fetchVideoListVC 可以快速获取标准化直播列表的视图容器,该视图包含热门、关注、全部、附近、国家等选项卡。

将该容器添加到你想要展示的页面上完成列表的展示,该列表具备基础的直播信息元素,可以由我方定制开发。

/// Get video list view
- (UIViewController *)fetchVideoListVC;

(2) 列表数据

直播列表数据也可以通过 fetchVideoListData 方法获取列表数据,由接入方客户端自定义开发UI界面。

/// Get the specified live broadcast
/// @param from   Feature or follow
/// @param gender   Get the broadcast of the specified gender
/// @param page   Start with 0
/// @param complete   Callback
- (void)fetchVideoListData:(LMVideoFrom)from gender:(LMRequestGender)gender page:(int)page complete:(void(^)(LMVideoResponse *response, NSError *error))complete;

3. 开始直播

开播过程中SDK会对当前客户端的摄像头和麦克风权限进行检测和申请,需要用户同意并授权才能使用直播功能,直播准备页面可以上传自定义直播封面、填写直播标题、选择直播标签、使用美颜滤镜开播。调用 fetchVideoListData 方法实现直播。

/// Start broadcast
- (void)startBroadcast;

4. 跳转到指定直播间

SDK 提供 通过 调用jumpToLiveRoomWithVid方法跳转到指定直播间的功能,传递 vid 给 SDK,SDK 会跳转到指定直播间。

/// Jump to the live room of the specified vid
/// @param vid vid
- (void)jumpToLiveRoomWithVid:(NSString *)vid;

5. 跳转登录

当用户没有登录时,点击直播间关注、送礼等会触发该回调方法,需在该方法中实现登录的相关操作。

/// Trigger login
- (void)startLogin;

6. SDK页面

打开个人页

/// Navigate to personal page
- (void)openPersonalPage;

打开搜索页

/// Navigate to Search page
- (void)openSearchPage;

打开排行榜页

/// Navigate to leader board page
- (void)openLeaderBoardPage;

打开指定用户主页

/// Navigate to user home page
/// @param userID user home page userid
- (void)openUserHomePage:(NSString *)userID;

7. 性别过滤

SDK 提供了首页数据列表性别过滤的功能,直接调用 SDK 的 showLiveListFilter 方法,可弹出选择性别框。

/// Show filter panel to filter live list
- (void)showLiveListFilter;