开放平台
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
首页平台概述
开发者
  • API文档
  • SDK
产品功能
  • 新手入门
  • 产品功能
常见问题
  1. 字段说明
  • demo
  • JS SDK
    • 产品介绍
    • 快速接入
    • SDK 对接示例
    • 观看直播
    • 暖场视频
    • 房间消息说明
    • 互动连麦
    • 文档白板
    • 全局事件
    • 全局错误码
    • 版本更新记录
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-聊天
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展功能
      • 资料下载
      • 观看限制验证
      • 观看协议
      • 回放章节
  • 点播SDK
    • 点播上传SDK
    • 更新记录
  • iOS SDK
    • 整体介绍
    • 快速接入
    • SDK 登录
    • 暖场视频
    • 视频轮询
    • 直播彩排
    • 高级美颜
    • 云导播
    • 观看协议
    • 文档白板演示
    • 聊天功能
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 观众互动
      • 推流摄像头
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-章节打点
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播间拓展能力
      • 直播间特色功能配置项
      • 文件下载
      • 修改角色昵称
      • 观看权限校验
      • 投屏
      • 虚拟人数
    • 观看回放
      • 观看回放
    • 防录屏
      • 跑马灯
    • 字段说明
      • 互动活动详情字段
      • 错误码说明
      • 常量定义
      • 活动详情字段说明
    • 版本更新说明
      • 版本更新信息
      • v2.3.0 到 v2.4.0 升级说明
      • v3.0.1 到 v3.2.0 升级说明
      • V2.9.0到v3.0.1升级说明
      • v6.3.0
      • v6.2.1
      • v3.2.0 到 v4.0.1
      • v2.7.0 到 v2.8.0、v2.9.0 升级说明
      • 6.5.0
      • v5.0.x 到 v6.0.0
      • v6.4.0
  • Adroid SDK
    • 整体介绍
    • 快速接入
    • SDK登录
    • 暖场视频
    • 视频轮巡功能
    • 直播彩排
    • 高级美颜
    • 云导播功能
    • 观看协议
    • 文档白板
    • 聊天功能
    • 房间消息
    • 信息采集说明
    • 视频直播
      • 发起视频直播
      • 观看视频直播
    • 互动直播
      • 互动直播API
      • 主播发起互动直播
      • 嘉宾加入互动直播
      • 观众观看互动直播
    • 无延迟直播
      • 主播发起无延迟直播
      • 观众观看无延迟直播
    • 互动工具
      • 互动-抽奖
      • 互动-礼物
      • 互动-签到
      • 互动-问卷
      • 互动-公告
      • 互动-商品
      • 互动-计时器
      • 互动-问答
      • 互动-推屏卡片
      • 互动-快问快答
      • 互动-优惠券
      • 互动-点赞
    • 直播拓展功能
      • 修改角色名称
      • 文件下载
      • 投屏演示
      • 虚拟人数
      • 观看权限校验
      • 直播间特色功能配置项
    • 观看回放
      • 观看回放/点播
    • 防录屏
      • 直播水印
      • 跑马灯
    • 字段说明
      • 房间消息字段说明
      • 聊天消息字段说明
      • 活动详情字段说明
    • 版本更新说明
      • 更新记录
      • v6.4.0
      • v6.3.0
      • v6.2.3
      • v6.2.1
      • v6.2.0
      • v6.1.0
      • v6.0.0
      • v5.0.0
      • v4.1.0
      • v4.0.0
      • v3.3.0
  • APP嵌入支付说明
    • 支付调起说明
    • Scheme规则说明
  1. 字段说明

常量定义

pragma mark - 新版版使用的常量定义如下
日志类型
typedef NS_ENUM(NSInteger,VHLogType) {
     VHLogType_OFF = 0, //关闭日志 默认设置
     VHLogType_ON    = 1,   //开启日志
     VHLogType_ALL   = 2,   //开启全部日志
};

pragma mark - 发起端常量定义#

发直播状态,当 kLiveStatusPushConnectError 时,content 代表出错原因 及具体错误码查看错误码定义。
    typedef NS_ENUM(NSInteger,VHLiveStatus) {
    VHLiveStatusNone = kLiveStatusNone,
    VHLiveStatusPushConnectSucceed = kLiveStatusPushConnectSucceed, //直播连接成功
    VHLiveStatusPushConnectError = kLiveStatusPushConnectError, //直播连接失败
    VHLiveStatusParamError = kLiveStatusParamError, //参数错误
    VHLiveStatusSendError = kLiveStatusSendError, //直播发送数据错误
    VHLiveStatusUploadSpeed = kLiveStatusUploadSpeed, //直播上传速率
    VHLiveStatusAudioRecoderError = kLiveStatusAudioRecoderError, //音频采集失败,提示用户查看权限或者重新推流,切记此事件会回调多次,直到音频采集正常为止
    VHLiveStatusUploadNetworkException = kLiveStatusUploadNetworkException,//发起端网络环境差
    VHLiveStatusUploadNetworkOK = kLiveStatusUploadNetworkOK, //发起端网络环境恢复正常
    VHLiveStatusGetUrlError = kLiveStatusGetUrlError, //获取推流地址失败 };
摄像头取景方向
    typedef NS_ENUM(NSInteger,VHDeviceOrientation) {
    VHDevicePortrait = kDevicePortrait,
    VHDeviceLandSpaceLeft = kDeviceLandSpaceRight,
    VHDeviceLandSpaceRight = kDeviceLandSpaceLeft };
推流视频分辨率
typedef NS_ENUM(NSInteger,VHVideoResolution) {
VHLowVideoResolution = kLowVideoResolution, //低分边率 352*288
VHGeneralVideoResolution = kGeneralVideoResolution, //普通分辨率 640*480
VHHVideoResolution = kHVideoResolution, //高分辨率 960*540
VHHDVideoResolution = kHDVideoResolution //超高分辨率 1280*720 };

pragma mark - 观看端常量定义#

观看端错误事件,当 VHLivePlayGetUrlError 时, content 代表出错原因 及具体错误码查看错误码定义。
typedef NS_ENUM(NSInteger,VHLivePlayErrorType) {
VHLivePlayErrorNone = kLiveStatusNone,
VHLivePlayGetUrlError = kLivePlayGetUrlError, //获取服务器rtmpUrl错误
VHLivePlayParamError = kLivePlayParamError, //参数错误
VHLivePlayRecvError = kLivePlayRecvError, //接受数据错误
VHLivePlayCDNConnectError = kLivePlayCDNConnectError, //CDN链接失败 };
直播播放器视频填充模式,回放使用 MPMoviePlayerController 自带填充模式设置。
typedef NS_ENUM(NSInteger,VHRTMPMovieScalingMode) {
VHRTMPMovieScalingModeNone = kRTMPMovieScalingModeNone, //填充满video显示view
VHRTMPMovieScalingModeAspectFit = kRTMPMovieScalingModeAspectFit, //在保持长宽比的前提下,缩放图片,使得图片在容器内完整显示出来 可能留有黑边
VHRTMPMovieScalingModeAspectFill = kRTMPMovieScalingModeAspectFill, //在保持长宽比的前提下,缩放图片,使图片充满容器 };
直播流类型
typedef NS_ENUM(NSInteger,VHStreamType) {
VHStreamTypeNone = kVHallStreamTypeNone, //未知
VHStreamTypeVideoAndAudio = kVHallStreamTypeVideoAndAudio,//音视频
VHStreamTypeOnlyVideo = kVHallStreamTypeOnlyVideo, //纯视频无音频
VHStreamTypeOnlyAudio = kVHallStreamTypeOnlyAudio, //纯音频 };
视频渲染模式
typedef NS_ENUM(NSInteger,VHRenderModel){
VHRenderModelNone = kVHallRenderModelNone,
VHRenderModelOrigin = kVHallRenderModelOrigin, //普通视图的渲染
VHRenderModelDewarpVR = kVHallRenderModelDewarpVR, //VR视图的渲染 };
播放器状态、直播状态、回放状态由于用户创建的 MPMoviePlayerController 实例获取
typedef NS_ENUM(NSInteger,VHPlayerState) {
VHPlayerStateStoped = 0, //停止 可调用startPlay: startPlayback: 状态转为VHallPlayerStateStarting
    VHPlayerStateStarting               = 1,    //启动中
VHPlayerStatePlaying = 2, *播放中 可调用stopPlay pausePlay 状态转为VHallPlayerStateStoped/VHallPlayerStatePaused VHPlayerStateStreamStoped = 3, *直播流停止 暂停pausePlay/流连接错误触发 可调用stopPlay reconnectPlay状态转为VHallPlayerStateStoped/VHallPlayerStatePlaying };
活动布局模式
typedef NS_ENUM(NSInteger,VHMovieVideoPlayMode) {
VHMovieVideoPlayModeNone = 0, //不存在
VHMovieVideoPlayModeMedia = 1, //单视频
VHMovieVideoPlayModeTextAndVoice = 2, //文档+声音
VHMovieVideoPlayModeTextAndMedia = 3, //文档+视频
VHMovieVideoPlayModeVoice = 4, //单音频 };
直播视频清晰度
typedef NS_ENUM(NSInteger,VHMovieDefinition) {
VHMovieDefinitionOrigin = 0, //原画
VHMovieDefinitionUHD = 1, //超高清
VHMovieDefinitionHD = 2, //高清
VHMovieDefinitionSD = 3, //标清
VHMovieDefinitionAudio = 4, //纯音频 };
活动状态
typedef NS_ENUM(NSInteger,VHMovieActiveState) {
VHMovieActiveStateNone = 0,
VHMovieActiveStateLive = 1, //直播
VHMovieActiveStateReservation = 2, //预约
VHMovieActiveStateEnd = 3, //结束
VHMovieActiveStateReplay = 4, //回放or点播
Saas 直播错误类型
typedef NS_ENUM(NSInteger,VHSaasLivePlayErrorType) {
    VHSaasLivePlayErrorNone ,
    VHSaasLivePlayParamError      //参数错误
    VHSaasLivePlayRecvError,       //接受数据错误
    VHSaasLivePlayCDNConnectError,      //CDN链接失败
    VHSaasVodPlayError,     //点播播放器错误信息
    VHSaasLivePlayGetUrlError,     //获取活动信息失败
    VHSaasPlaySSOKickout  //观看被踢出
};
互动房间错误类型
typedef NS_ENUM(NSInteger, VHRoomErrorStatus) {
    VHRoomErrorUnknown, // 未知错误
    VHRoomErrorClient, // 来自于VHClient的错误
    VHRoomErrorClientFailedSDP,
    VHRoomErrorSignaling, // 来自于VHSignalingChannel的错误
    VHRoomErrorKickout //开启sso,kickout
};
互动房间消息类型
typedef NS_ENUM(NSInteger, VHRoomMessageType) {
    VHRoomMessageType_vrtc_connect_open = 0,         //开启举手 (开启其他人申请上麦入口)
    VHRoomMessageType_vrtc_connect_close = 1,        //关闭举手 (关闭其他人申请上麦入口)
    VHRoomMessageType_vrtc_connect_apply = 2,        //某个用户申请上麦
    VHRoomMessageType_vrtc_connect_apply_cancel = 3, //某个用户取消上麦申请
    VHRoomMessageType_vrtc_connect_invite = 4,       //某个用户被主持人邀请上麦
    VHRoomMessageType_vrtc_connect_agree = 5,        //某个用户发起的上麦申请被主持人同意
    VHRoomMessageType_vrtc_connect_refused = 6,      //某个用户发起的上麦申请被主持人拒绝
    VHRoomMessageType_vrtc_mute = 7,                 //某个用户的麦克风静音
    VHRoomMessageType_vrtc_mute_all = 8,             //全体用户静音
    VHRoomMessageType_vrtc_mute_cancel = 9,          //某个用户的麦克风取消静音
    VHRoomMessageType_vrtc_mute_all_cancel = 10,     //取消全体用户静音
    VHRoomMessageType_vrtc_frames_forbid = 11,       //某个用户的摄像头关闭
    VHRoomMessageType_vrtc_frames_display = 12,      //某个用户的摄像头开启
    VHRoomMessageType_vrtc_big_screen_set = 13,      //某个用户的互动流画面被设置为旁路直播大画面
    VHRoomMessageType_vrtc_speaker_switch = 14,      //某个用户被设置为主讲人
    VHRoomMessageType_room_kickout = 15,             //某个用户被踢出
    VHRoomMessageType_live_start = 16,               //开始直播
    VHRoomMessageType_live_over = 17,                //结束直播
    VHRoomMessageType_room_announcement = 18,        //发布公告
    VHRoomMessageType_vrtc_disconnect_success = 19,  //某个用户下麦
    VHRoomMessageType_vrtc_connect_success = 20,     //某个用户上麦
    VHRoomMessageType_vrtc_connect_invite_refused = 21,    //某个用户拒绝来自主持人的上麦邀请 | since 6.3.3 消息携带inviter_Id|
    VHRoomMessageType_room_kickout_cancel = 22,      //某个用户被取消踢出
    VHRoomMessageType_room_banChat = 23,               //某个用户被禁言
    VHRoomMessageType_room_banChat_cancel = 24,        //某个用户被取消禁言
    VHRoomMessageType_room_allBanChat = 25,            //全体禁言
    VHRoomMessageType_room_allBanChat_cancel = 26,     //取消全体禁言
    VHRoomMessageType_room_vrtc_connect_invite_agree = 27,     //邀请id
};
修改于 2025-05-27 11:59:31
上一页
错误码说明
下一页
活动详情字段说明
Built with