初始化配置

注意

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

配置方式

uniappuniappx

//配置
config: {
  /**
   * 播放源类型，可选值：VidAuth、VidSts、Url
   * VidAuth：通过 VID 和 Auth 授权播放视频的资源类型。使用播放授权码进行授权，适用于需要更简单授权机制的场景。
   * VidSts：通过 VID 和 STS 令牌播放视频的资源类型。使用阿里云 STS (Security Token Service) 进行授权，提供更高的安全性和访问控制。适用于需要临时访问凭证的场景。
   * Url：通过直接 URL 播放视频的资源类型。适用于公开访问的视频资源，无需额外的授权验证。
   */
  playType: "VidAuth",
  //视频ID，VidAuth和VidSts播放源类型必传
  vid: "004fc90fd71d71f0bf184531958c0402",
  //播放凭证，需要调用点播服务的GetVideoPlayAuth接口生成。VidAuth播放源类型必传
  playAuth: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImFwcC0xMDAwMDAwIiwidmlkZW9JZCI6IjAwNGZjOTBmZDcxZDcxZjBiZjE4NDUzMTk1OGMwNDAyIiwiY3VycmVudFRpbWVTdGFtcCI6MTc2NjEzMTE5MTYxMywiZXhwaXJlVGltZVN0YW1wIjoxOTIzODExMTkxNjEzLCJyZWdpb25JZCI6ImNuLXNoYW5naGFpIiwicGxheUNvbnRlbnRJbmZvIjp7ImZvcm1hdHMiOiJtM3U4Iiwic3RyZWFtVHlwZSI6InZpZGVvIiwiYXV0aFRpbWVvdXQiOjE4MDB9fQ.CjqZA-6okJb2PxOZr0Jjai9gWwvaNdG-bk3LWBMzhdc",
  //访问密钥 ID，VidSts播放源类型必传
  // accessKeyId: "",
  //访问密钥密文，VidSts播放源类型必传
  // accessKeySecret: "",
  //安全令牌，VidSts播放源类型必传
  // securityToken: "",
  //区域信息，VidSts播放源类型参数，可不传或为空
  // region: "",
  //视频 URL 地址，Url播放源类型必传
  // url: "",
  /**
   * 设置播放场景，可选值：VOD、LIVE、VIDEO_LIST、RESTRICTED、MINIMAL
   * VOD：适用场景：常规视频播放，功能特性：支持所有播放控制功能，包括播放/暂停、进度拖拽、快进/快退、倍速播放、音量/亮度调节、全屏切换、设置菜单等
   * LIVE：直播场景，适用场景：实时直播流播放，能特性：支持播放/暂停、刷新、音量/亮度调节、全屏切换、设置菜单等，但不支持进度拖拽、快进/快退、倍速播放等时间轴相关操作
   * VIDEO_LIST：列表播放场景，适用场景：视频列表中的播放器，如信息流、短视频列表等，功能特性：支持基本播放控制，但禁用垂直手势（音量/亮度调节），避免与列表滚动手势冲突
   * RESTRICTED：受限播放场景（限制时间轴操作），适用场景：教育培训、考试监控、演示展示等需要限制用户跳跃播放的场景，功能特性：支持播放/暂停、音量/亮度调节、全屏切换、设置菜单、字幕显示等，但禁用进度拖拽、快进/快退、倍速播放等时间轴相关操作，确保用户只能按正常速度顺序观看，无法跳过内容
   * MINIMAL：最小化播放场景（仅播放视图，无任何UI），适用场景：背景视频、装饰性视频、嵌入式播放器、自定义UI覆盖等，功能特性：仅显示纯净的视频播放画面，不显示任何UI元素，包括封面图、字幕、播放状态、控制界面等，适合需要完全自定义UI或作为背景元素的场景
   */
  // sceneType: "VOD",
  //设置封面图地址，视频播放前的封面图片 URL，用于在视频加载时显示。
  // coverUrl: "",
  //设置视频标题，视频的标题文本，用于在 UI 中显示。不设置标识不展示标题
  videoTitle: "Long Video",
  //设置是否自动播放，true 表示视频配置完成后自动开始播放，false 表示需要手动调用播放方法。
  // autoPlay: true,
  //设置 trace ID，用于跟踪和统计视频播放的标识符，通常用于日志记录和数据分析。
  // traceId: "",
  //设置视频起始播放时间，视频开始播放的时间点，单位：毫秒。
  // startTime: 0,
  //设置硬件解码,true 为使用硬件解码，false 为使用软件解码，默认为 true
  // isHardWareDecode: true,
  //设置屏幕休眠，true 为允许屏幕休眠，false 为不允许屏幕休眠，默认为 false
  // allowedScreenSleep: false,
  //订阅的播放器事件
  events: ['Error', 'SnapshotCompleted'],
}

//组件初始化配置
const config = ref({
  /**
   * 播放源类型，可选值：VidAuth、VidSts、Url
   * VidAuth：通过 VID 和 Auth 授权播放视频的资源类型。使用播放授权码进行授权，适用于需要更简单授权机制的场景。
   * VidSts：通过 VID 和 STS 令牌播放视频的资源类型。使用阿里云 STS (Security Token Service) 进行授权，提供更高的安全性和访问控制。适用于需要临时访问凭证的场景。
   * Url：通过直接 URL 播放视频的资源类型。适用于公开访问的视频资源，无需额外的授权验证。
   */
  playType: "VidAuth",
  //视频ID，VidAuth和VidSts播放源类型必传
  vid: "004fc90fd71d71f0bf184531958c0402",
  //播放凭证，需要调用点播服务的GetVideoPlayAuth接口生成。VidAuth播放源类型必传
  playAuth: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6ImFwcC0xMDAwMDAwIiwidmlkZW9JZCI6IjAwNGZjOTBmZDcxZDcxZjBiZjE4NDUzMTk1OGMwNDAyIiwiY3VycmVudFRpbWVTdGFtcCI6MTc2NjEzMTE5MTYxMywiZXhwaXJlVGltZVN0YW1wIjoxOTIzODExMTkxNjEzLCJyZWdpb25JZCI6ImNuLXNoYW5naGFpIiwicGxheUNvbnRlbnRJbmZvIjp7ImZvcm1hdHMiOiJtM3U4Iiwic3RyZWFtVHlwZSI6InZpZGVvIiwiYXV0aFRpbWVvdXQiOjE4MDB9fQ.CjqZA-6okJb2PxOZr0Jjai9gWwvaNdG-bk3LWBMzhdc",
  //访问密钥 ID，VidSts播放源类型必传
  // accessKeyId: "",
  //访问密钥密文，VidSts播放源类型必传
  // accessKeySecret: "",
  //安全令牌，VidSts播放源类型必传
  // securityToken: "",
  //区域信息，VidSts播放源类型参数，可不传或为空
  // region: "",
  //视频 URL 地址，Url播放源类型必传
  // url: "",
  /**
   * 设置播放场景，可选值：VOD、LIVE、VIDEO_LIST、RESTRICTED、MINIMAL
   * VOD：适用场景：常规视频播放，功能特性：支持所有播放控制功能，包括播放/暂停、进度拖拽、快进/快退、倍速播放、音量/亮度调节、全屏切换、设置菜单等
   * LIVE：直播场景，适用场景：实时直播流播放，能特性：支持播放/暂停、刷新、音量/亮度调节、全屏切换、设置菜单等，但不支持进度拖拽、快进/快退、倍速播放等时间轴相关操作
   * VIDEO_LIST：列表播放场景，适用场景：视频列表中的播放器，如信息流、短视频列表等，功能特性：支持基本播放控制，但禁用垂直手势（音量/亮度调节），避免与列表滚动手势冲突
   * RESTRICTED：受限播放场景（限制时间轴操作），适用场景：教育培训、考试监控、演示展示等需要限制用户跳跃播放的场景，功能特性：支持播放/暂停、音量/亮度调节、全屏切换、设置菜单、字幕显示等，但禁用进度拖拽、快进/快退、倍速播放等时间轴相关操作，确保用户只能按正常速度顺序观看，无法跳过内容
   * MINIMAL：最小化播放场景（仅播放视图，无任何UI），适用场景：背景视频、装饰性视频、嵌入式播放器、自定义UI覆盖等，功能特性：仅显示纯净的视频播放画面，不显示任何UI元素，包括封面图、字幕、播放状态、控制界面等，适合需要完全自定义UI或作为背景元素的场景
   */
  // sceneType: "VOD",
  //设置封面图地址，视频播放前的封面图片 URL，用于在视频加载时显示。
  // coverUrl: "",
  //设置视频标题，视频的标题文本，用于在 UI 中显示。不设置标识不展示标题
  videoTitle: "Long Video",
  //设置是否自动播放，true 表示视频配置完成后自动开始播放，false 表示需要手动调用播放方法。
  // autoPlay: true,
  //设置 trace ID，用于跟踪和统计视频播放的标识符，通常用于日志记录和数据分析。
  // traceId: "",
  //设置视频起始播放时间，视频开始播放的时间点，单位：毫秒。
  // startTime: 0,
  //设置硬件解码,true 为使用硬件解码，false 为使用软件解码，默认为 true
  // isHardWareDecode: true,
  //设置屏幕休眠，true 为允许屏幕休眠，false 为不允许屏幕休眠，默认为 false
  // allowedScreenSleep: false,
  //订阅的播放器事件
  events: ['Error', 'SnapshotCompleted'],
})

参数说明

参数名	参数类型	是否必填	默认值	参数描述
playType	String	是	无	播放源类型，可选值：`VidAuth`、`VidSts`、`Url`，具体可参考播放源类型说明
vid	String	否	无	视频ID，`VidAuth`和`VidSts`播放源类型必传
playAuth	String	否	无	播放凭证，需要调用点播服务的`GetVideoPlayAuth`接口生成。`VidAuth`播放源类型必传
accessKeyId	String	否	无	访问密钥 ID，`VidSts`播放源类型必传
accessKeySecret	String	否	无	访问密钥密文，`VidSts`播放源类型必传
securityToken	String	否	无	安全令牌，`VidSts`播放源类型必传
region	String	否	无	区域信息，`VidSts`播放源类型参数，可不传或为空
url	String	否	无	视频 URL 地址，`Url`播放源类型必传
sceneType	String	否	无	设置播放场景，可选值：`VOD`、`LIVE`、`VIDEO_LIST`、`RESTRICTED`、`MINIMAL`，具体可参考播放场景类型说明
coverUrl	String	否	无	设置封面图地址，视频播放前的封面图片 URL，用于在视频加载时显示
videoTitle	String	否	无	设置视频标题，视频的标题文本，用于在 UI 中显示。不设置标识不展示标题
autoPlay	Boolean	否	true	设置是否自动播放，true 表示视频配置完成后自动开始播放，false 表示需要手动调用播放方法
traceId	String	否	无	设置 trace ID，用于跟踪和统计视频播放的标识符，通常用于日志记录和数据分析
startTime	Integer	否	无	设置视频起始播放时间，视频开始播放的时间点，单位：毫秒
isHardWareDecode	Boolean	否	true	设置硬件解码,true 为使用硬件解码，false 为使用软件解码，默认为 true
allowedScreenSleep	Boolean	否	false	设置屏幕休眠，true 为允许屏幕休眠，false 为不允许屏幕休眠，默认为 false
events	String[]	否	无	订阅的播放器事件列表，订阅事件后会在插件的onEvent中返回，未订阅则不返回，事件类型可参考播放器订阅事件类型说明

播放源类型说明

名称	参数描述
VidAuth	通过 VID 和 Auth 授权播放视频的资源类型。使用播放授权码进行授权，适用于需要更简单授权机制的场景。
VidSts	通过 VID 和 STS 令牌播放视频的资源类型。使用阿里云 STS (Security Token Service) 进行授权，提供更高的安全性和访问控制。适用于需要临时访问凭证的场景。
Url	通过直接 URL 播放视频的资源类型。适用于公开访问的视频资源，无需额外的授权验证。

播放场景类型说明

名称	参数描述
VOD	适用场景：常规视频播放，功能特性：支持所有播放控制功能，包括播放/暂停、进度拖拽、快进/快退、倍速播放、音量/亮度调节、全屏切换、设置菜单等
LIVE	直播场景，适用场景：实时直播流播放，能特性：支持播放/暂停、刷新、音量/亮度调节、全屏切换、设置菜单等，但不支持进度拖拽、快进/快退、倍速播放等时间轴相关操作
VIDEO_LIST	列表播放场景，适用场景：视频列表中的播放器，如信息流、短视频列表等，功能特性：支持基本播放控制，但禁用垂直手势（音量/亮度调节），避免与列表滚动手势冲突
RESTRICTED	受限播放场景（限制时间轴操作），适用场景：教育培训、考试监控、演示展示等需要限制用户跳跃播放的场景，功能特性：支持播放/暂停、音量/亮度调节、全屏切换、设置菜单、字幕显示等，但禁用进度拖拽、快进/快退、倍速播放等时间轴相关操作，确保用户只能按正常速度顺序观看，无法跳过内容
MINIMAL	最小化播放场景（仅播放视图，无任何UI），适用场景：背景视频、装饰性视频、嵌入式播放器、自定义UI覆盖等，功能特性：仅显示纯净的视频播放画面，不显示任何UI元素，包括封面图、字幕、播放状态、控制界面等，适合需要完全自定义UI或作为背景元素的场景

播放器订阅事件类型说明

名称	参数描述
StateChanged	播放状态变化
FirstFrameRendered	首帧渲染完成
VideoSizeChanged	视频尺寸变化
Info	播放信息更新
Error	错误事件
LoadingBegin	开始加载
LoadingProgress	加载进度
LoadingEnd	加载结束
SetSpeedCompleted	设置速度完成
SnapshotCompleted	截图完成
SetLoopCompleted	设置循环完成
SetMuteCompleted	设置静音完成
SetScaleTypeCompleted	设置填充模式完成
SetMirrorTypeCompleted	设置镜像完成
SetRotationCompleted	设置旋转完成
TrackQualityListUpdated	清晰度列表更新
TrackSelected	清晰度选择完成

初始化配置 ​

配置方式 ​

参数说明 ​

播放源类型说明 ​

播放场景类型说明 ​

播放器订阅事件类型说明 ​

初始化配置

配置方式

参数说明

播放源类型说明

播放场景类型说明

播放器订阅事件类型说明