BJPlaybackCore github传送门
集成SDK
使用 CocoaPods 的方式集成:
- Podfile 中设置 source
source 'https://github.com/CocoaPods/Specs.git'
source 'http://git.baijiahulian.com/app/specs.git'
source 'https://gitlab.com/baijiayun/specs.git'
- Podfile 中引入 BJLiveCore
pod 'BJPlaybackCore'
Example
参考 Example
项目,运行它需要在 BJPlaybackCore/Example
目录下执行 pod install
命令。本部分示例代码主要基于该 demo 的 BJEnterRoomViewController
。
1. 引入头文件
#import
2. 创建用于回放的房间
- 创建用于在线回放的房间
/** 创建在线视频房间
@param _classId 教室ID
@param _token 用于服务器请求的token
*/
self.room = [BJPRoom onlineVideoCreateRoomWithClassId:_classId token:_token];
// 如果用户标识符 _userInfo 存在,上报该标识符
[self.room.playbackVM setUserInfo:_userInfo];
- 创建用于本地回放的房间
// 创建本地视频房间
self.room = [BJPRoom localVideoCreateRoom];
3. 设置起始播放时间
用于记忆播放:需要在进入房间之前设置上次播放的时间
// 假设上次播放到20s
self.room.playbackVM.initialPlaybackTime = 20.0;
4. 监听回放通知
- 通知类型
// 即将播放的通知
PMPlayerWillPlayNotification
// 播放状态改变的通知
PKMoviePlayerPlaybackStateDidChangeNotification
// 播放结束的通知
PKMoviePlayerPlaybackDidFinishNotification
- 以监听播放结束的通知为例
// 添加通知
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(playbackFinish:)
name:PKMoviePlayerPlaybackDidFinishNotification
object:nil];
// 响应方法
- (void)playbackFinish:(NSNotification *)noti {
// 获取结束原因
PKMovieFinishReason reason = [[noti.userInfo objectForKey:PKMoviePlayerPlaybackDidFinishReasonUserInfoKey] integerValue];
// 获取错误信息
NSString *error = [noti.userInfo objectForKey:@"error"];
switch (reason) {
case PKMovieFinishReasonPlaybackEnded: // 回放结束
[MBProgressHUD bjp_showMessageThenHide:@"Playback Ended ==> video finish" toView:self.view onHide:nil];
break;
case PKMovieFinishReasonPlaybackError: // 回放出错
[MBProgressHUD bjp_showMessageThenHide:[NSString stringWithFormat:@"playback error ==> video finish, error:%@", error] toView:self.view onHide:nil];
break;
case PKMovieFinishReasonUserExited: // 用户退出
[MBProgressHUD bjp_showMessageThenHide:@"User Exited ==> video finish" toView:self.view onHide:nil];
break;
default:
break;
}
}
5. 回放协议
协议为 BJPMProtocol
- 设置当前 viewController 为代理
self.room.playbackVM.playerControl.delegate = self;
- 代理方法
// 播放过程中出错(@required)
- (void)videoplayer:(BJPlayerManager *)playerManager throwPlayError:(NSError *)error {
NSLog(@"video play ended with error: %@", error);
}
6. 进入、退出房间
- 进入在线视频房间
[self.room enter];
- 进入本地视频房间:需要把 localVideo 文件夹放到沙盒 Library -> Caches 下面, 才可以看本地视频;在 APP 的 info.plist 增加媒体资料库 NSAppleMusicUsageDescription, 用于 iOS10 以上系统的手机访问本地的视频和信令文件
/** 进入本地视频房间
@param videoPath 本地视频的路径
@param startVideo 片头地址,可为 nil
@param endVideo 片尾地址,可为 nil
@param signalPath 本地信令:压缩文件的路径
@param definition 清晰度
@param isZip 是否为 zip 文件
*/
[self.room enterRoomWithVideoPath:videoPath startVideo:startVideo endVideo:endVideo signalPath:signalPath definition:DT_LOW isZip:NO status:^(BJPMediaLibraryAuthorizationStatus status) {
// 需要用户授权播放本地视频
if (status != BJPMediaLibraryAuthorizationStatusAuthorized) {
NSLog(@"请到设置 -> 隐私 -> 媒体资料库 中打开 本APP的选项, 否则无法看本地视频");
}
}];
- 退出房间
[self.room exit];
7. 监听进入、退出房间事件
- 监听进入房间
// 这个 block 会被立即执行,因此这里不需要 @weakify(self) 和 @strongify(self)
[self bjl_observe:BJLMakeMethod(self.room, roomDidEnterWithError:)
observer:^BOOL(BJLError *error) {
// error 为 nil 表示正常进入,否则输出错误信息
if (error) {
NSLog(@"roomDidEnterWithError ==> error = %@", error);
}
return YES;
}];
- 监听退出房间
// 即将退出房间
[self bjl_observe:BJLMakeMethod(self.room, roomWillExitWithError:)
observer:^BOOL(BJLError *error) {
// error 为 nil 表示主动退出,否则输出错误信息
if (error) {
NSLog(@"roomWillExitWithError: ==> error = %@", error);
}
return YES;
}];
// 退出房间
[self bjl_observe:BJLMakeMethod(self.room, roomDidExitWithError:)
observer:^BOOL(BJLError *error) {
// error 为 nil 表示主动退出,否则输出错误信息
if (error) {
NSLog(@"roomDidExitWithError ==> error = %@", error);
}
return YES;
}];
8. 添加回放视图
// playerView 为当前 viewController 自定义的播放视图
CGFloat width = ScreenWidth < ScreenHeight ? ScreenWidth : ScreenHeight;
self.room.playbackVM.playView.frame = CGRectMake(0, 0, width, width*9/16);
[self.playerView addSubview:self.room.playbackVM.playView];
9. 回放管理
创建房间之后,回放管理类 BJPPlaybackVM
的实例 playbackVM
也被初始化,可使用它进行回放管理
- 根据视频 ID 播放视频
NSInteger videoId = 12345678;
[self.room.playbackVM playVideoById:videoId];
- 视频播放控制
// 播放视频
[self.room.playbackVM playerPlay];
// 暂停播放
[self.room.playbackVM playerPause];
// 停止播放
[self.room.playbackVM playerStop];
- 跳转到指定时刻
// 以5.0秒为例
[self.room.playbackVM playerSeekToTime:5.0];
- 改变播放倍速
// 以2.0倍为例
[self.room.playbackVM changeRate:2.0];
- 切换清晰度
/** 切换换清晰度
DT_LOW = 0, //标清
DT_HIGH = 1, //高清
DT_SUPPERHD = 2, //超清
*/
[self.room.playbackVM changeDefinition:DT_HIGH];
10. 获取当前视频的播放信息
播放信息可通过回放管理类的实例 playbackVM
直接获取,也可以通过 KVO 监听
- 通过
playbackVM
获取
// 当前播放状态:枚举类型
PMPlayState playState = self.room.playbackVM.playbackState;
// 当前视频信息,包含视频 ID、视频名称、片头片尾、清晰度列表、选集信息列表等
PMVideoInfoModel *videoInfo = self.room.playbackVM.videoInfoModel;
NSArray *definitionList = videoInfo.definitionList; //支持的清晰度列表
NSArray *sectionInfoList = videoInfo.sectionInfoList; //选集信息列表
// 当前播放清晰度,包含清晰度类型、CDN 列表等
PPMVideoDefinitionInfoModel *definitionInfo = self.room.playbackVM.currDefinitionInfoModel;
NSArray *cdnList = definitionInfo.cdnList; // CDN列表
// 当前播放的 CDN
PMVideoCDNInfoModel *cdnInfo = self.room.playbackVM.currCDNInfoModel;
- 通过 KVO 监听
[self bjl_kvo:BJLMakeProperty(self.room.playbackVM, currentTime)
observer:^BOOL(NSNumber * _Nullable old, NSNumber * _Nullable now) {
NSLog(@"currentTime: old = %@; now = %@", old, now);
return YES;
}];
11. 显示PPT、画笔
- 添加PPT、画笔视图
// 将 BJPRoom 的课件视图添加到当前 viewController 的对应视图
UIView *roomSlideshowView = self.room.slideshowViewController.view;
[self.slideshowView addSubview:roomSlideshowView];
[roomSlideshowView mas_makeConstraints:^(MASConstraintMaker *make) {
make.edges.equalTo(self.slideshowView);
}];
- 设置显示模式
/** 设置显示模式
BJLContentMode_scaleAspectFit 完整
BJLContentMode_scaleAspectFill 铺满
BJLContentMode_scaleToFill 拉伸
*/
self.room.slideshowViewController.contentMode = BJLContentMode_scaleAspectFit;
12. 获取聊天消息列表
[self bjl_observe:BJLMakeMethod(self.room, didReceiveMessageList:)
observer:^BOOL(NSArray *messageArray){
NSLog(@"received %zi messages", messageArray.count);
return YES;
}];
13. 获取在线用户信息
创建房间之后,在线用户管理类 BJPOnlineUserVM
的实例 onlineUsersVM
也被初始化,可使用它进行回放管理
- 获取在线用户人数
NSInteger userCount = self.room.onlineUsersVM.onlineUsersTotalCount;
- 监听用户列表变化
[self bjl_observe:BJLMakeMethod(self.room.onlineUsersVM, onlineUserList:)
observer:^BOOL(NSArray *userList){
NSLog(@"userList has %zi elements", userList.count);
return YES;
}];
changeLogs
- 0.1.6: fix crash, 优化回调
- 0.1.8: 增加本地视频播放的接口
- 0.2.0: 增加片头片尾广告
- 0.2.3: 更新本地播放方法, 本地信令解压失败的容错
- 0.2.5: 增加访问媒体资料库授权状态, 用于iOS10以上版本首次播放本地视频时的回调
- 0.2.6: 优化
- 0.2.7: BJPPlaybackVM.h增加属性duration,initialPlaybackTime和方法-changeDefinition:
API
- BJPlaybackCore.h 头文件
- BJPRoom.h 回放视频房间
- BJPPlayVM.h 回放管理类
- BJPOnlineUserVM.h 在线用户管理类
- BJPLoadingVM.h 加载任务管理类
Author
辛亚鹏, [email protected]
License
BJPlayback-sdk is available under the MIT license. See the LICENSE file for more info:
MIT license