Skip to content

初始化配置 ​

注意

  • uniappx项目中配置的属性名称为configX
  • uniapp项目配置的属性名称为config

配置方式 ​

js
//配置
config: {
  /**
   * 您的AK 请到http://console.bce.baidu.com/iam/#/iam/accesslist获取
   */
  accessKey: "",
  // 是否开启"边播边缓存"功能
  isVideoCacheEnabled: true,
  //缓存保存目录,本地绝对路径,如:/storage/emulated/0/playerCache/
  cachePath: "",
  //播放地址
  path: "",
  //视频标题
  title: "",
  //设置网络请求超时门限值
  timeout: 10 * 1000 * 1000,
  //设置最大探测时长
  maxProbeTimeInMs: 2000,
  //媒体类型
  switchType: "SOURCE_SWITCH_NORMAL_MODE",
  //外挂字幕
  extSubtitleUrl: "",
  //弹幕配置
  danmakuParams: {
    //是否显示弹幕
    danmakuShow: false,
    //弹幕文件
    danmakuFile: "http://uniappdoc.yeyuboke.com/testfile/baiduDanmuComments.xml",
    //弹幕文件类型,url:网络地址,path:本地路径,raw:raw文件
    danmakuFileType: "url",
  },
  //多码率无缝切换
  mediaItems: {
    mediasUrl: [],
    mediasDesc: []
  }
}
js
const config = ref({
  /**
   * 您的AK 请到http://console.bce.baidu.com/iam/#/iam/accesslist获取
   */
  accessKey: "",
  // 是否开启"边播边缓存"功能
  isVideoCacheEnabled: true,
  //缓存保存目录,本地绝对路径,如:/storage/emulated/0/playerCache/
  cachePath: "",
  //播放地址
  path: "",
  //视频标题
  title: "",
  //设置网络请求超时门限值
  timeout: 10 * 1000 * 1000,
  //设置最大探测时长
  maxProbeTimeInMs: 2000,
  //媒体类型
  switchType: "SOURCE_SWITCH_NORMAL_MODE",
  //外挂字幕
  extSubtitleUrl: "",
  //弹幕配置
  danmakuParams: {
    //是否显示弹幕
    danmakuShow: false,
    //弹幕文件
    danmakuFile: "http://uniappdoc.yeyuboke.com/testfile/baiduDanmuComments.xml",
    //弹幕文件类型,url:网络地址,path:本地路径,raw:raw文件
    danmakuFileType: "url",
  },
  //多码率无缝切换
  // mediaItems: {
  //   mediasUrl: [],
  //   mediasDesc: []
  // }
})

参数说明 ​

参数名参数类型是否必填默认值参数描述
accessKeyString否无您的AK 请到http://console.bce.baidu.com/iam/#/iam/accesslist获取
customIDString否无由宿主传入自定义的CustomID(cuid)信息,该字段将用于视频Qos,可不设置或传空
isVrEnableBoolean否无VR是否可用
isShowBackBoolean否无是否显示返回按钮
positionInteger否无初始播放位置,单位:毫秒
danmakuParamsObject否无弹幕配置
danmakuParams.danmakuShowBoolean否false是否开启弹幕
danmakuParams.danmakuFileString否无初始化弹幕文件,xml文件,如果是raw文件的话不需要加扩展名,其他需要加上扩展名
danmakuParams.danmakuFileTypeString否无弹幕文件类型
url:网络地址
path:本地路径
raw:raw文件
danmakuParams.maxLinesInteger否30最大显示行数
danmakuParams.preventOverlappingBoolean否true设置是否禁止重叠
danmakuParams.danmakuStyleObject否无描边样式
danmakuParams.danmakuStyle.styleString否DANMAKU_STYLE_STROKEN样式,可选值:
DANMAKU_STYLE_DEFAULT:自动
DANMAKU_STYLE_NONE:无
DANMAKU_STYLE_SHADOW:阴影
DANMAKU_STYLE_STROKEN:描边
DANMAKU_STYLE_PROJECTION:投影
danmakuParams.danmakuStyle.valuesArray[float]否[3]描边值,DANMAKU_STYLE_SHADOW 阴影模式下,values传入阴影半径,DANMAKU_STYLE_STROKEN 描边模式下,values传入描边宽度,DANMAKU_STYLE_PROJECTION 投影模式下,values传入offsetX, offsetY, alpha offsetX/offsetY: x/y 方向上的偏移量 alpha: 投影透明度 [0...255]
danmakuParams.duplicateMergingEnabledBoolean否true是否启用合并重复弹幕
danmakuParams.scrollSpeedFactorfloat否1.2设置弹幕滚动速度系数,只对滚动弹幕有效
danmakuParams.scaleTextSizefloat否1.2设置弹幕文本大小
subtitleStyleObject否无内置字幕配置
subtitleStyle.textSizeInteger否18文本大小
subtitleStyle.textColorString否#FFFFFF文本颜色
isVideoCacheEnabledBoolean否false是否开启"边播边缓存"功能
switchTypeString否SOURCE_SWITCH_NORMAL_MODE多码率切换模式,可选值如下:
SOURCE_SWITCH_NORMAL_MODE:普通模式,非无缝切换
SOURCE_SWITCH_SMOOTH_MODE:MP4无缝切换模式
SOURCE_SWITCH_SMOOTH_HLS_MODE:HLS无缝切换模式
mediaItemsObject否无mp4多码率场景下,设置多分辨率媒体流信息
mediaItems.mediasUrlString[]否无子码流URL
mediaItems.mediasDescString[]否无子码流格式描述:VideoWidthxVideoWidth,Bitrate(1280x720,650000)
isLoopBoolean否false设置是否循环播放
timeoutInteger否0设置网络请求超时门限值
pathString是无播放地址
maxProbeTimeInMsInteger否-1设置最大探测时长
maxProbeSizeInBytesInteger否0设置最大探测的数据大小
sizeInBytesInteger否0设置最大缓存数据大小
bufferTimeInteger否0设置缓冲事件发生时,缓存多长时间的数据才结束
bufferSizeInteger否0设置"加载中"触发时,需要缓冲多大的数据才结束
maxCacheDurationInteger否-1设置最大缓存数据时长
renderStuckThresholdInteger否-1设置渲染卡顿统计门限值
leftVolumeFloat否-1左声道的音量,左右声道音量必须同时传递才有效
rightVolumeFloat否-1右声道的音量,左右声道音量必须同时传递才有效
wakeModeInteger否0设置保持唤醒模式
decodeModeInteger否0设置解码模式,0:自动识别,1:软解码
showCacheInfoBoolean否true设置是否显示默认的『加载中』信息
titleString否无视频标题
toggleFrameChasingBoolean否false设置是否开启直播追帧播放功能
extSubtitleUrlString否false外挂字幕
scalingModeString否VIDEO_SCALING_MODE_SCALE_TO_FIT裁剪模式,可选值如下:
VIDEO_SCALING_MODE_SCALE_TO_FIT:填充,保持视频内容的宽高比。视频与屏幕宽高不一致时,会留有黑边
VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING:裁剪,保持视频内容的宽高比。视频与屏幕宽高不一致时,会裁剪部分视频内容
VIDEO_SCALING_MODE_SCALE_TO_MATCH_PARENT:铺满,不保证视频内容宽高比。视频显示与屏幕宽高相等
headersObject否无头信息
isPlayBoolean否true初始化好之后立即播放