观看视频直播

功能说明

视频直播活动中，观众可以通过SDK进入直播间观看视频直播，是在直播间中进行聊天互动的基础动作。

注意事项

看直播房间和互动房间不能同时使用，进入互动需要暂停直播

必需登录成功之后才可以进入活动

用视频模式观看无延迟直播也会有视频延迟

观看互动直播才有连麦功能

在直播和互动切换的场景中，互动需要调用销毁且对持有的对象置位nil，然后在重新播放直播

关键步骤

initWithDelegate 初始化VHMoviePlayer对象

moviePlayer.moviePlayerView 添加播放器到view上

startPlay 观看直播视频

基础属性

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

播放器关键方法

方法	方法描述
initWithDelegate	初始化
preLoadRoomWithParam	预加载房间信息
startPlay	开始播放
startPlay:isPIP:	开始播放并配置画中画
pausePlay	暂停播放
reconnectPlay	恢复播放
stopPlay	停止播放
setMute	设置静音
destroyMoivePlayer	销毁播放器

连麦互动方法

方法	方法描述
microApplyWithType	申请上麦/取消申请
replyInvitationWithType	是否同意上麦

辅助方法

方法	方法描述
cleanLastFrame	清空视频剩余的最后一帧画面
dlnaMappingObject	设置投屏对象
reconnectSocket	重连socket
playerBackgroundColor	playerBackgroundColor
playerBackgroundImage	设置播放器背景图片
audioOutput	设置音频输出设备
openPIPSupported	开启画中画
closePIPSupported	关闭画中画
setIsOpenPIP	是否开启画中画

VHallMoviePlayerDelegate 代理方法

方法	方法描述
preLoadVideoFinish	视频信息预加载完成回调
connectSucceed	播放连接成功回调
liveDidStart	直播开始消息
liveDidStoped	直播结束消息
bufferStart	缓冲开始回调
bufferStop	缓冲结束回调
downloadSpeed	下载速率的回调
recStreamtype	视频流类型回调
playError	播放时错误的回调
activeStateDidChange	当前活动状态回调
loadVideoPlayMode	当前视频播放模式，以及是否为vr活动回调
loadVideoPlayModeList	当前视频支持的播放模式列表回调
loadVideoDefinitionList	当前视频支持的清晰度列表回调
statusDidChange	播放器状态回调
videoSize	视频宽髙回调（支持直播与点播）
isInteractiveActivity	当前活动是否允许举手申请上麦回调
microInvitationWithAttributes	主持人是否同意上麦申请回调
microInvitation	被主持人邀请上麦
isKickout	被踢出
isCast_screen	当前是否支持投屏功能
isHaveDocument	主持人显示/隐藏文档
documentDelayTime	直播文档同步，直播文档有延迟，指定需要延迟的秒数
announcementContentDidChange	发布公告的回调
isQuestion_status	当前是否开启问答功能
is_file_download	当前是否开启文件下载功能
pictureInPictureControllerWillStart	即将开启画中画
pictureInPictureControllerDidStart	已经开启画中画
pictureInPictureWithFailedToStartPictureInPictureWithError	开启画中画失败
pictureInPictureControllerWillStop	即将关闭画中画
pictureInPictureControllerDidStop	已经关闭画中画
pictureInPictureWithRestoreUserInterfaceForPictureInPictureStopWithCompletionHandler	关闭画中画且恢复播放界面

初始化

方法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[@"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)startPlay:(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 startPlay:param];

开始播放并配置画中画

开启画中画时需要勾选【Audio, AirPlay, and Picture in Picture】选项

方法API

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

- (BOOL)startPlay:(NSDictionary *)param isPIP:(BOOL)isPIP;

方法入参

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

方法示例

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

暂停播放

方法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

- (BOOL)microApplyWithType:(NSInteger)type finish:(void(^)(NSError *error))finishBlock;

方法入参

参数名称	是否必须	示例	备注
type	是	1	1申请上麦，0取消申请上麦
finishBlock	是	回调	消息发送结果，error为失败详情

方法示例

[self.moviePlayer microApplyWithType:1 finish:^(NSError *error) {
    if(error){
        NSLog(@"%@",error.description);
    }else{
        NSLog(@"申请上麦成功");
    }
}];

是否同意上麦

方法API

- (BOOL)replyInvitationWithType:(NSInteger)type finish:(void(^)(NSError *error))finishBlock;

方法入参

参数名称	是否必须	示例	备注
type	是	1	1接受，2拒绝，3超时失败
finishBlock	是	回调	消息发送结果，error为失败详情

方法示例

[self.moviePlayer replyInvitationWithType:1 finish:^(NSError *error) {
    if(error){
        NSLog(@"%@",error.description);
    }else{
        NSLog(@"申请上麦成功");
    }
}];

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

方法API

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

- (void)cleanLastFrame;

方法示例

[self.moviePlayer cleanLastFrame]

设置投屏对象

投屏功能使用步骤：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

- (BOOL)openPIPSupported;

方法示例

[self.moviePlayer openPIPSupported];

关闭画中画

方法API

- (BOOL)closePIPSupported;

方法示例

[self.moviePlayer closePIPSupported];

是否开启画中画

方法API

- (void)setIsOpenPIP:(BOOL)isOpenPIP;

方法示例

[self.moviePlayer setIsOpenPIP: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)liveDidStart:(VHallMoviePlayer *)moviePlayer;

直播结束消息

方法API

- (void)liveDidStoped:(VHallMoviePlayer *)moviePlayer;

缓冲开始回调

方法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
            isInteractiveActivity:(BOOL)isInteractive
            interactivePermission:(VHInteractiveState)state;

方法返回参数

参数名称	备注
isInteractive	当前活动是否支持互动功能
state	主持人是否允许举手

主持人是否同意上麦申请回调

方法API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            microInvitationWithAttributes:(NSDictionary *)attributes
                                    error:(NSError *)error;

方法返回参数

参数名称	备注
attributes	收到的数据
error	nil：同意上麦非nil：不同意上麦

被主持人邀请上麦

方法API

- (void)moviePlayer:(VHallMoviePlayer *)moviePlayer
            microInvitation:(NSDictionary *)attributes;

方法返回参数

参数名称	备注
attributes	收到的数据

被踢出

方法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关闭
questionName	v6.4 新增问答名称

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

方法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	文件下载菜单详情

即将开启画中画

方法API

- (void)pictureInPictureControllerWillStart;

已经开启画中画

方法API

- (void)pictureInPictureControllerDidStart;

开启画中画失败

方法API

- (void)pictureInPictureWithFailedToStartPictureInPictureWithError:(NSError *)error;

即将关闭画中画

方法API

- (void)pictureInPictureControllerWillStop;

已经关闭画中画

方法API

- (void)pictureInPictureControllerDidStop;

关闭画中画且恢复播放界面

方法API

- (void)pictureInPictureWithRestoreUserInterfaceForPictureInPictureStopWithCompletionHandler:(void (^)(BOOL restored))completionHandler;

功能说明#

注意事项#

关键步骤#

基础属性#

播放器关键方法#

连麦互动方法#

辅助方法#

VHallMoviePlayerDelegate 代理方法#

初始化#

预加载房间信息#

开始播放#

开始播放并配置画中画#

暂停播放#

恢复播放#

停止播放#

设置静音#

销毁播放器#

申请上麦或取消申请上麦#

是否同意上麦#

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

设置投屏对象#

重连socket#

设置播放器背景色#

设置播放器背景图片#

设置音频输出设备#

开启画中画#

关闭画中画#

是否开启画中画#

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

播放连接成功回调#

直播开始消息#

直播结束消息#

缓冲开始回调#

缓冲结束回调#

下载速率的回调#

视频流类型回调#

播放时错误的回调#

livePlayErrorType类型详情#

当前活动状态回调#

activeState类型详情#

当前视频播放模式#

playMode类型详情#

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

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

播放器状态回调#

state类型详情#

视频宽髙回调#

当前活动是否允许举手申请上麦回调#

主持人是否同意上麦申请回调#

被主持人邀请上麦#

被踢出#

当前是否支持投屏功能#

主持人显示/隐藏文档#

直播文档同步#

发布公告的回调#

当前是否开启问答功能#

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

即将开启画中画#

已经开启画中画#

开启画中画失败#

即将关闭画中画#

已经关闭画中画#

关闭画中画且恢复播放界面#

功能说明

注意事项

关键步骤

基础属性

播放器关键方法

连麦互动方法

辅助方法

VHallMoviePlayerDelegate 代理方法

初始化

预加载房间信息

开始播放

开始播放并配置画中画

暂停播放

恢复播放

停止播放

设置静音

销毁播放器

申请上麦或取消申请上麦

是否同意上麦

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

设置投屏对象

重连socket

设置播放器背景色

设置播放器背景图片

设置音频输出设备

开启画中画

关闭画中画

是否开启画中画

视频信息预加载完成回调

播放连接成功回调

直播开始消息

直播结束消息

缓冲开始回调

缓冲结束回调

下载速率的回调

视频流类型回调

播放时错误的回调

livePlayErrorType类型详情

当前活动状态回调

activeState类型详情

当前视频播放模式

playMode类型详情

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

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

播放器状态回调

state类型详情

视频宽髙回调

当前活动是否允许举手申请上麦回调

主持人是否同意上麦申请回调

被主持人邀请上麦

被踢出

当前是否支持投屏功能

主持人显示/隐藏文档

直播文档同步

发布公告的回调

当前是否开启问答功能

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

即将开启画中画

已经开启画中画

开启画中画失败

即将关闭画中画

已经关闭画中画

关闭画中画且恢复播放界面