观看回放

在直播回放状态下或者点播活动中，观众可以通过 SDK 进入直播间观看回放或点播，补足除直播场景之外视频点播的场景需求。

关键步骤

initWithDelegate 初始化 VHMoviePlayer 对象

moviePlayer.moviePlayerView 添加播放器到 view 上

startPlayback 观看回放/点播视频

核心类

类名	类描述
VHallMoviePlayer	视频直播类

基础属性

属性	属性描述
delegate	代理对象
moviePlayerView	获取播放器 view
documentView	获取文档演示 view，如果没有文档则为 nil (在收到"文档显示/隐藏回调"后获取)
waterImg	水印（在收到"播放连接成功回调"后使用）
realityBufferTime	获取 RTMP 播放实际的缓冲时间，单位毫秒
playMode	获取当前视频观看模式
activeState	活动状态（在收到"视频信息预加载回调"或"播放连接成功回调"后使用）
playerState	获取播放器状态
webinarInfo	活动详情
timeout	设置链接的超时时间默认 5000 毫秒，单位为毫秒 MP4 点播最小 10000 毫秒
bufferTime	设置 RTMP 的缓冲时间默认 6 秒单位为秒必须>0 值越小延时越小,卡顿增加
movieScalingMode	设置视频的填充模式默认是自适应模式：VHRTMPMovieScalingModeAspectFit
defaultDefinition	设置默认播放的清晰度默认原画
curDefinition	设置当前播放的清晰度
duration	视频时长
playableDuration	可播放时长
rate	点播倍速播放速率 0.50, 0.67, 0.80, 1.0, 1.25, 1.50, and 2.0
currentPlaybackTime	当前播放时间点
initialPlaybackTime	初始化要播放的位置

播放器关键方法

方法	方法描述
initWithDelegate	初始化
preLoadRoomWithParam	预加载房间信息
startPlayback	观看回放/点播视频
pausePlay	暂停播放
reconnectPlay	恢复播放
stopPlay	停止播放
setMute	设置静音
destroyMoivePlayer	销毁播放器

辅助方法

方法	方法描述
takeVideoScreenshot	获得当前时间视频截图仅支持化蝶
getRecordListWithWebinarId	获取指定活动下的回放列表
cleanLastFrame	清空视频剩余的最后一帧画面
dlnaMappingObject	设置投屏对象
reconnectSocket	重连 socket
playerBackgroundColor	设置播放器背景色
playerBackgroundImage	设置播放器背景图片
audioOutput	设置音频输出设备

VHallMoviePlayerDelegate 代理方法

方法	方法描述
preLoadVideoFinish	视频信息预加载完成回调
connectSucceed	播放连接成功回调
bufferStart	缓冲开始回调
bufferStop	缓冲结束回调
downloadSpeed	下载速率的回调
recStreamtype	视频流类型回调
playError	播放时错误的回调
activeStateDidChange	当前活动状态回调
loadVideoPlayMode	当前视频播放模式，以及是否为 vr 活动回调
loadVideoPlayModeList	当前视频支持的播放模式列表回调
loadVideoDefinitionList	当前视频支持的清晰度列表回调
statusDidChange	播放器状态回调
videoSize	视频宽高回调（支持直播与点播）
currentTime	当前播放时间回调
videoPointArr	视频打点
isKickout	被踢出
isCast_screen	当前是否支持投屏功能
isHaveDocument	主持人显示/隐藏文档
documentDelayTime	直播文档同步，直播文档有延迟，指定需要延迟的秒数
announcementContentDidChange	发布公告的回调
isQuestion_status	当前是否开启问答功能
is_file_download	当前是否开启文件下载功能

初始化

方法 API

初始化 VHMoviePlayer 对象

- (instancetype)initWithDelegate:(id <VHallMoviePlayerDelegate>)delegate;

方法入参

参数名称	是否必须	示例	备注
delegate	是	self	代理对象

方法返回参数

参数名称	备注
VHMoviePlayer	观看直播对象

方法示例

@interface UIViewController ()<VHallMoviePlayerDelegate>
// 播放器
@property (nonatomic, strong) VHallMoviePlayer  *moviePlayer;
@end
- (void)viewDidLoad {
    [super viewDidLoad];
    /// 初始化
    self.moviePlayer = [[VHallMoviePlayer alloc]initWithDelegate:self];
}

预加载房间信息

方法 API

在收到"视频信息预加载完成回调"后，即可使用聊天、签到、问答、抽奖等功能，然后择机调用 startPlay/startPlayback 进行播放，注意使用此方法后，startPlay 和 startPlayback 传参将不再生效（此方法主要用于播放之前需要使用聊天等功能）

- (void)preLoadRoomWithParam:(NSDictionary *)param;

方法入参

参数名称	是否必须	示例	备注
param	是	字典	活动基础信息，包含以下参数
param[@"id"]	是	123456789	活动 Id，必传
param[@"record_id"]	否	6781736	回放 id，通过列表获取 getRecordListWithWebinarId
param[@"name"]	否	阿超	昵称
param[@"auth_model"]	否	1	0 : 校验观看权限(默认) 1 : 不校验观看权限

方法示例

NSMutableDictionary * param = [[NSMutableDictionary alloc] init];
param[@"id"] = @"123456789";
param[@"name"] = @"阿超";
param[@"auth_model"] = @(1);
[self.moviePlayer preLoadRoomWithParam:param];

观看回放/点播视频

方法 API

在收到"播放连接成功回调"后，才可使用聊天、签到、问答、抽奖等功能

- (BOOL)startPlayback:(NSDictionary *)param;

方法入参

参数名称	是否必须	示例	备注
param	是	字典	活动基础信息，包含以下参数
param[@"id"]	是	123456789	活动 Id，必传
param[@"name"]	否	阿超	昵称
param[@"auth_model"]	否	1	0 : 校验观看权限(默认) 1 : 不校验观看权限

方法示例

NSMutableDictionary * param = [[NSMutableDictionary alloc] init];
param[@"id"] = @"123456789";
param[@"name"] = @"阿超";
param[@"auth_model"] = @(1);
[self.moviePlayer startPlayback:param];

暂停播放

方法 API

直播等同于 stopPlay，停止播放

- (void)pausePlay;

方法示例

[self.moviePlayer pausePlay];

恢复播放

方法 API

播放出错/暂停播放后恢复播放

- (BOOL)reconnectPlay;

方法示例

[self.moviePlayer reconnectPlay];

停止播放

方法 API

- (BOOL)stopPlay;

方法示例

[self.moviePlayer stopPlay];

设置静音

方法 API

- (void)setMute:(BOOL)mute;

方法入参

参数名称	是否必须	示例	备注
mute	是	YES	是否静音

方法示例

[self.moviePlayer setMute:YES];

销毁播放器

方法 API

- (void)destroyMoivePlayer;

方法示例

[self.moviePlayer destroyMoivePlayer];

获得当前时间视频截图仅支持化蝶

方法 API

- (void)takeVideoScreenshot:(void (^)(UIImage* image))screenshotBlock;

方法示例

[_moviePlayer takeVideoScreenshot:^(UIImage *image) {

}];

获取指定活动下的回放列表

方法 API

+ (void)getRecordListWithWebinarId:(NSString *)webinarId pageNum:(NSInteger)pageNum pageSize:(NSInteger)pageSize complete:(void (^)(NSArray <VHRecordListModel *> *recordList, NSError *error))complete

方法入参

参数名称	是否必须	示例	备注
webinarId	是	12345678	活动 Id，必传
pageNum	是	1	页数
pageSize	否	10	一页几个

方法示例

[VHWebinarBaseInfo getRecordListWithWebinarId:self.webinar_id pageNum:1 pageSize:10 complete:^(NSArray<VHRecordListModel *> *recordList, NSError *error) {

}];

清空视频剩余的最后一帧画面

方法 API

- (void)cleanLastFrame;

方法示例

[self.moviePlayer cleanLastFrame]

设置投屏对象

方法 API

投屏功能使用步骤：1、设置 DLNAobj 2、收到 DLNAobj 设备列表回调后，设置投屏设备 3、DLNAobj 初始化播放。如果播放过程中多个 player 使用对同一个 DLNAobj，则 DLNAobj 需要重新初始化播放

- (BOOL)dlnaMappingObject:(VHDLNAControl *)DLNAobj;

方法入参

参数名称	是否必须	示例	备注
DLNAobj	是	DLNAobj	投屏对象

方法返回参数

参数名称	备注
return BOOL	YES 可投屏，NO 不可投屏

方法示例

[self.moviePlayer dlnaMappingObject:DLNAobj];

重连 socket

方法 API

重连

- (BOOL)reconnectSocket;

方法示例

[self.moviePlayer reconnectSocket];

设置播放器背景色

方法 API

默认黑色

- (void)playerBackgroundColor:(UIColor *)playerBgColor;

方法入参

参数名称	是否必须	示例	备注
playerBgColor	是	[UIColor redColor]	颜色

方法示例

[self.moviePlayer playerBackgroundColor:[UIColor blackColor]];

设置播放器背景图片

方法 API

- (void)playerBackgroundImage:(UIImage *)playerBgImage;

方法入参

参数名称	是否必须	示例	备注
playerBgImage	是	[UIImage new]	图片

方法示例

[self.moviePlayer playerBackgroundImage:[UIImage new]];

设置音频输出设备

方法 API

+ (void)audioOutput:(BOOL)inSpeaker;

方法入参

参数名称	是否必须	示例	备注
inSpeaker	是	YES	音频类别

方法示例

[self.moviePlayer audioOutput:YES];

视频信息预加载完成回调

方法 API

前提需使用方法"preLoadRoomWithParam"，收到此回调后，可以使用聊天、签到、问答、抽奖等功能，择机调用 startPlay/startPlayback 进行播放（可以实现在调用播放之前使用聊天等功能）

- (void)preLoadVideoFinish:(VHallMoviePlayer *)moviePlayer
               activeState:(VHMovieActiveState)activeState
                     error:(NSError*)error;

方法返回参数

参数名称	备注
activeState	活动状态
error	非空即预加载成功

播放连接成功回调

方法 API

前提需使用方法"startPlay/startPlayback"，收到此回调后，可以使用聊天、签到、问答、抽奖等功能

- (void)connectSucceed:(VHallMoviePlayer *)moviePlayer
                  info:(NSDictionary *)info;

方法返回参数

参数名称	备注
info	相关信息

缓冲开始回调

方法 API

- (void)bufferStart:(VHallMoviePlayer *)moviePlayer
               info:(NSDictionary *)info;

方法返回参数

参数名称	备注
info	相关信息

缓冲结束回调

方法 API

- (void)bufferStop:(VHallMoviePlayer *)moviePlayer
              info:(NSDictionary *)info;

方法返回参数

参数名称	备注
info	相关信息

下载速率的回调

方法 API

- (void)downloadSpeed:(VHallMoviePlayer *)moviePlayer
                 info:(NSDictionary *)info;

方法返回参数

参数名称	备注
info	相关信息

视频流类型回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
        recStreamTypeInfo:(NSDictionary *)info;

方法返回参数

参数名称	备注
info	相关信息

播放时错误的回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
          playError:(VHSaasLivePlayErrorType)livePlayErrorType
               info:(NSDictionary *)info;

方法返回参数

参数名称	备注
livePlayErrorType	直播错误类型
info	相关信息

livePlayErrorType 类型详情

| 参数名称 | 备注 |
| :---------------------------: | :----------------: | --- |
| VHSaasLivePlayErrorNone | |
| VHSaasLivePlayParamError | 参数错误 |
| VHSaasLivePlayRecvError | 接受数据错误 |
| VHSaasLivePlayCDNConnectError | CDN 链接失败 |
| VHSaasVodPlayError | 点播播放器错误信息 |
| VHSaasLivePlayGetUrlError | 获取活动信息失败 |
| VHSaasPlaySSOKickout | 观看被踢出 | |

当前活动状态回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
        activeStateDidChange:(VHMovieActiveState)activeState;

activeState 类型详情

参数名称	备注
VHMovieActiveStateNone
VHMovieActiveStateLive	直播
VHMovieActiveStateReservation	预约
VHMovieActiveStateEnd	结束
VHMovieActiveStateReplay	回放 or 点播

当前视频播放模式

方法 API

以及是否为 vr 活动回调

- (void)moviePlayer:(VHallMoviePlayer *)player
            loadVideoPlayMode:(VHMovieVideoPlayMode)playMode
                    isVrVideo:(BOOL)isVrVideo;

方法返回参数

参数名称	备注
playMode	视频播放模式
isVrVideo	是否为 vr 活动

playMode 类型详情

参数名称	备注
VHMovieVideoPlayModeNone	不存在
VHMovieVideoPlayModeMedia	单视频
VHMovieVideoPlayModeTextAndVoice	文档＋声音
VHMovieVideoPlayModeTextAndMedia	文档＋视频
VHMovieVideoPlayModeVoice	单音频

当前视频支持的播放模式列表回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)player
            loadVideoPlayModeList:(NSArray *)playModeList;

方法返回参数

参数名称	备注
playModeList	VHMovieVideoPlayMode 播放模式组合，如@[@(VHMovieVideoPlayModeMedia),@(VHMovieVideoPlayModeVoice)]

当前视频支持的清晰度列表回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)player
            loadVideoDefinitionList:(NSArray *)definitionList;

方法返回参数

参数名称	备注
definitionList	VHDefinition 清晰度组合，如@[@(VHDefinitionOrigin),@(VHDefinitionUHD),@(VHDefinitionHD)]

播放器状态回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            statusDidChange:(VHPlayerState)state;

方法返回参数

参数名称	备注
state	播放器状态

state 类型详情

参数名称	备注
VHPlayerStateStoped	停止可调用 startPlay: startPlayback: 状态转为 VHallPlayerStateStarting
VHPlayerStateStarting	启动中
VHPlayerStatePlaying	播放中可调用 stopPlay pausePlay 状态转为 VHallPlayerStateStoped/VHallPlayerStatePaused
VHPlayerStateStreamStoped	直播流停止暂停 pausePlay/流连接错误触发可调用 stopPlay reconnectPlay 状态转为 VHallPlayerStateStoped/VHallPlayerStatePlaying
VHPlayerStatePause	回放暂停状态
VHPlayerStateComplete	回放播放完成

视频宽高回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
          videoSize:(CGSize)size;

方法返回参数

参数名称	备注
size	视频尺寸

当前播放时间回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
        currentTime:(NSTimeInterval)currentTime;

方法返回参数

参数名称	备注
currentTime	当前播放时间点 1s 回调一次，可用于 UI 刷新

返回视频打点数据（若存在打点信息）

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
      videoPointArr:(NSArray <VHVidoePointModel *> *)pointArr;

方法返回参数

参数名称	备注
pointArr	已打点的数据

VHVidoePointModel 视频打点数据模型

参数名称	备注
timePoint	打点位置的时间，单位：秒
msg	打点位置的文字描述
picurl	打点位置的图片 url 地址
videoDuration	视频总时长，单位：秒
pointPersent	打点位置时间占视频总时长的百分比，如：0.35

被踢出

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            isKickout:(BOOL)isKickout;

方法返回参数

参数名称	备注
isKickout	被踢出（取消踢出后需要重新进入）

当前是否支持投屏功能

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            isCast_screen:(BOOL)isCast_screen;

方法返回参数

参数名称	备注
isCast_screen	1 支持 0 不支持

主持人显示/隐藏文档

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            isHaveDocument:(BOOL)isHave
            isShowDocument:(BOOL)isShow;

方法返回参数

参数名称	备注
isHave	YES 此活动有文档演示
isShow	YES 主持人显示观看端文档，NO 主持人隐藏观看端文档

直播文档同步

方法 API

直播文档有延迟，指定需要延迟的秒数（默认为直播缓冲时间，即：realityBufferTime/1000.0）

- (NSTimeInterval)documentDelayTime:(VHallMoviePlayer *)moviePlayer;

发布公告的回调

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            announcementContentDidChange:(NSString*)content
                             publishTime:(NSString*)time;

方法返回参数

参数名称	备注
content	公告内容
time	发布时间

当前是否开启问答功能

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            isQuestion_status:(BOOL)isQuestion_status
                question_name:(NSString *)questionName;

方法返回参数

参数名称	备注
isQuestion_status	1 开启 0 关闭

当前是否开启文件下载功能

方法 API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer is_file_download:(BOOL)is_file_download file_download_menu:(VHallPlayMenuModel *)file_download_menu;

方法返回参数

参数名称	备注
is_file_download	是否开启 1 开启 0 关闭
file_download_menu	文件下载菜单详情
questionName	v6.4 新增问答名称

关键步骤#

核心类#

基础属性#

播放器关键方法#

辅助方法#

VHallMoviePlayerDelegate 代理方法#

初始化#

预加载房间信息#

观看回放/点播视频#

暂停播放#

恢复播放#

停止播放#

设置静音#

销毁播放器#

获得当前时间视频截图仅支持化蝶#

获取指定活动下的回放列表#

清空视频剩余的最后一帧画面#

设置投屏对象#

重连 socket#

设置播放器背景色#

设置播放器背景图片#

设置音频输出设备#

视频信息预加载完成回调#

播放连接成功回调#

缓冲开始回调#

缓冲结束回调#

下载速率的回调#

视频流类型回调#

播放时错误的回调#

livePlayErrorType 类型详情#

当前活动状态回调#

activeState 类型详情#

当前视频播放模式#

playMode 类型详情#

当前视频支持的播放模式列表回调#

当前视频支持的清晰度列表回调#

播放器状态回调#

state 类型详情#

视频宽高回调#

当前播放时间回调#

返回视频打点数据（若存在打点信息）#

VHVidoePointModel 视频打点数据模型#

被踢出#

当前是否支持投屏功能#

主持人显示/隐藏文档#

直播文档同步#

发布公告的回调#

当前是否开启问答功能#

当前是否开启文件下载功能#

关键步骤

核心类

基础属性

播放器关键方法

辅助方法

VHallMoviePlayerDelegate 代理方法

初始化

预加载房间信息

观看回放/点播视频

暂停播放

恢复播放

停止播放

设置静音

销毁播放器

获得当前时间视频截图仅支持化蝶

获取指定活动下的回放列表

清空视频剩余的最后一帧画面

设置投屏对象

重连 socket

设置播放器背景色

设置播放器背景图片

设置音频输出设备

视频信息预加载完成回调

播放连接成功回调

缓冲开始回调

缓冲结束回调

下载速率的回调

视频流类型回调

播放时错误的回调

livePlayErrorType 类型详情

当前活动状态回调

activeState 类型详情

当前视频播放模式

playMode 类型详情

当前视频支持的播放模式列表回调

当前视频支持的清晰度列表回调

播放器状态回调

state 类型详情

视频宽高回调

当前播放时间回调

返回视频打点数据（若存在打点信息）

VHVidoePointModel 视频打点数据模型

被踢出

当前是否支持投屏功能

主持人显示/隐藏文档

直播文档同步

发布公告的回调

当前是否开启问答功能

当前是否开启文件下载功能