币游国际平台
菜单类

视频播放器API参考

最新更新:Jan-10-2024

View播放器API参考细节方法、参数和属性视频Player或视频玩家对象并对应 标签上

上页:

并见:

配置选项

多播放器配置选项可定义为属性 标签或构造参数视频层或视频层方法论以上设置默认所有视频播放播放者,但如果特定视频源对同设置有不同值则被覆盖

本节包括:

关于设置配置参数的概述和指令见配置阶梯如何嵌入视频播放器

构造器参数

使用构造参数视频层或视频层方法定义全局配置选项

可控件 :

玩家视觉学

百合 类型 描述性
aiHighlightsGraph 布尔 是否显示AI生成视频亮点表示默认值 :虚伪
注解:当图生成时,附加变换使用时可能需要短时补全
大PlayButton 布尔或字符串 是否显示视频暂停时大中心播放按钮
可能的值 :
-真实性:总显示大播放按钮
-虚伪永不显示大播放按钮
-init系统:只在初始加载时显示大播放按钮
默认值 :真实性
颜色显示 对象类 玩家UI使用颜色值必须按ex色码提供可设置 :
-基础:播放器控件和信息栏基色以及中心播放按钮基色
-口音调:进取栏和音量级的颜色
-文本翻译:所有文本图标的颜色
控件栏 控制栏prps 配置控件栏组件
控件 布尔 是否显示视频播放器控件
floatingWhenNotVisible FloatingWhenNotVisible 视频播放时是否在屏幕角显示浮动播放器,可视性小半播放器
可能的值 :
-右转:显示屏幕右下角浮动播放器
-左转:显示屏幕左下角浮动播放器
流水体 布尔 是否激活流体布局模式,即动态调整播放器大小以适应容器或窗口

注解:你可以选择传递sld浮点s类视频标签例举 :
class="cld-video-player cld-video-player-skin-dark cld-fluid"
字体脸孔 字体脸孔 字体视频播放器文本元素使用未指明的玩家加载默认玩家字体-Fira ss
隐藏ContextMenu 布尔 是否隐藏右击播放器时显示上下文菜单默认值 :虚伪
interactionAreas interactionAreas 配置向视频播放器添加区域交互允许查看者点击视频并与其交互作用,例如放大视频区域更多信息见交互式视频.
回放Rates 数组 数组回放率显示控制栏允许用户改变视频播放速度
播放列表部件 PlaylistWidgetProps 向视频播放器添加播放列表部件
招贴选择 对象类 默认招贴每次显示新视频加载包括变换设置默认时,每加载新视频都使用视频中间图像/video/publicId.jpg)和如果播放器宽度设置,海报将响应例举设置采样图像sepia效果固定招贴所有视频招贴选择 : {publicId:sample/e
showJumpControls 布尔 显示跳控按钮,允许用户向前跳转或向后跳转10秒
showLogo 布尔 是否显示播放器内可点击标识可定制标识图像标志imageUrl和标识urlobjectell满足自身需求默认值 :真实性
标志imageUrl 字符串 URL标识图片显示只有当相关showLogo实事求是默认值:云形标识
objectell 字符串 URL浏览器调用播放器控件栏标识时发送只有当相关showLogo实事求是默认值 ://www.agrosoland.com
寻 布尔 使用寻宝栏时是否显示视频缩略图默认值 :真实性
注解:当查找缩略图生成时,包含所有缩略图的图像图文自动创建正因如此,这将使用附加变换并可能花短时间完成
视频JS 对象类 允许访问视频JSAPI所有底层能力细节见ViewJS播放器API.

玩家行为

百合 类型 描述性
自动播放 布尔 是否应用标准HTML5自播放默认值 :虚伪.
注解:自动播放不同浏览器和设备行为不同相关浏览器文档获取更多信息
自动播放模式 自动播放模式 自动播放模式对播放器使用类似默认HTML5自动播放参数加法悬浮支持默认值 :永不.
autoShowRecommendations 布尔 是否显示建议结束当前视频,如果可用播放列表自动前置华府市虚伪下段视频自动使用为建议,如果没有定义清晰单源玩家除设置autoShowRecommendations至真实性中,你必须清晰定义视频推荐使用source.recommendations参数化可选使用source.recommendations参数显示播放列表中的源,该参数取代默认行为显示下一视频为推荐
循环式 布尔 是否执行标准HTML5视频循环默认值 :虚伪.
最大轨迹 数目 最大视频播放器数请求视频多请求可能是必要的,如果视频首次请求时仍在处理中默认=3.可并用视频超时.
静音 布尔 玩家是否按标准HTML5哑模式加载默认值 :虚伪.
playedEventPercents 数组 数组表百分点百分数播放事件详解默认值 :25,50,75,100.
playedEventTimes 数组 数组列表时间(秒)自视频起始定时播放事件详解默认值 :空号.
splayin线程 布尔 仅与iOS相关视频重播时是否自动禁止输入全屏模式可同时使用自动播放并静音启动iOS设备自编
视频超时 毫米秒 最大时间视频播放者等待视频提供如果视频首次请求时仍在处理中,则此点可能相关默认=55000.可并用最大轨迹.
有证书 布尔 是否包括有证书播放器请求时页眉,例如列表文件或视频段上头有证书页眉中包括浏览器请求时的任何认证信头或cookie

视频配置

百合 类型 描述性
章次 对象类 上头章次定义播放器公共标识构造器参数设置在大多数情况下,比较好的做法是指定章节为部分videoPlayer.source方法论
预加载 字符串 标准HTML5视频预加载类型只有当相关自动播放华府市虚伪或自动播放模式华府市永不.

可能的值 :
  • 汽车:默认值立即开始加载视频
  • 元数据:只加载视频元数据
  • 无:不加载视频数据
公共标识 字符串 云公共标识视频源加载时使用可使用此设置播放视频在大多数情况下 最好的做法是在视频源码内指定公共标识videoPlayer.source
sourceTransformation 对象类 默认变换应用到特定源类型
源类型 数组 视频源类型(可选对应编解码器)可供播放者请求使用(视当前浏览器而定)。如果源类型无法在请求浏览器中播放,数组中下一个源将被试源类型后添加编解码器并分解mp4/h265.

HLS和MPEG-DASH使用值hls并破折号并可选指定上文描述的编解码器

面向自动格式选择使用汽车.

只限音频使用音频.

if also定义编解码器作为变换的一部分,这将覆盖源类型

默认值 :f_auto:视频.默认自动格式选择应用文件选择最优文件类型
变换 云型变换对象数组或字符串 默认变换应用到播放器中所有源视频

Ads解析

百合 类型 描述性
广告 AdsProps VAST、VPAID和VMAP等视频广告领先标准开机提供广告,包括Google双点或AdSense更多细节见视频广告和货币化.
分析学 布尔 是否激活视频播放事件分析默认值 :虚伪.
allowUsageReport 布尔 Cloudinary可选择收集视频播放器使用方式汇总统计收集数据汇总式帮助改善视频播放器未来版本,无法识别单个视频浏览器当真时(默认)云化收集视频播放器所执行事件的数据
cloudinaryAnalytics 布尔 是否发送视频解析数据云化默认值 :真实性.

构造器类型

AdsProps

百合 类型 描述性
adTagull 字符串 需求化全URLadTag运行
adsInPlaylist AdsInPlaylist 可选性何时调用播放列表默认值 :视频首映
show倒计时 布尔 可选性等真时,倒计时标签以小文字显示在视频播放器底部中心,并配有计数台显示时间(秒数)直到视频结束默认值 :真实性.
adlabel 字符串 可选性替代或翻译倒计时标签文本只有当相关show倒计时实事求是
局部化 字符串 可选性定位定位可以是ISO 639-1二字母或ISO 639-2三字母局部编码设置会影响adtag内相关元素的语言,例如Sppt选项默认值 :内.
预滚动Timeout 数目 可选性最大时间(以毫秒计)等待预发广告启动if广告不启动adtimeout事件触发
日期推移 数目 可选性最大时间( 毫秒) 等待贴贴启动if广告不启动adtimeout事件触发

控制栏prps

百合 类型 描述性
pictureInPictureToggle 布尔 是否显示图片切换按钮默认值 :虚伪
章按钮 布尔 是否显示章按钮打开章列表默认值 :虚伪

PlaylistWidgetProps

百合 类型 描述性
方向选择 方向引导 控制 web显示部件定位方向响应/移动视图中,部件常调整到播放器下方单列垂直滚动表默认值 :垂直
总计 字符串 下段视频总数包含部件最大四大缩略图可同时显示大数指针总计部件滚动显示其余部分

构造器enums

自动播放模式

字符串值设置自播放模式

值传 描述性
永不 禁用自定义游戏
常态化 启动自播放
悬浮 视频自动播放当播放器大都在视图港内时,当播放器大都失视时暂停播放

FloatingWhenNotVisible

字符串值设置浮动播放器位置

值传 描述性
左转 显示屏幕左下角浮动播放器
右转 显示屏幕右下角浮动播放器

字体脸孔

字符串值设置字面使用播放器文本元素

值传 描述性
加载并使用指定的Google字体.
多数现代浏览器和移动设备支持这些字体更多细节见谷歌字体FAQ
继承 继承当前网页使用字体
虚伪 应用通过CSS设置默认视频JS字体组

AdsInPlaylist

字符串定值调用adTag

值传 描述性
视频首映 调用adTag仅播放列表中的第一个视频
视频全景 调用视频播放列表

方向引导

字符串值设置未来视频方向

值传 描述性
水平化 横向显示即将到来的视频缩略图部件位于播放器下方并附加为为播放器定义的维度
垂直 横向显示即将到来的视频缩略图部件定位到播放器右侧并显示在为播放器定义的维度内(视频相应调整大小)。

视频标签属性

云属性参数作为部分传递 标签格式数据焊接 .复杂对象转成JSON下表属性与并行JavaScript有相同的描述、可能的值和默认值视频播放器构造参数上表

除云性配置外,所有HTML5构造属性都可像往常一样以HTML标签属性传递

支持云属性参数示例显示

  • 数据焊变={width:200
  • 数据悬浮选择sss
  • 数据链源={公有ibjectsserve:Mymovie/ transformation:{width:500}
  • data-cld-source-types='["mp4", "ogg", "webm"]'
  • 数据源转换={+4:{width:410}}
  • data-cld-public-id="mymovie"
  • data-cld-autoplay-mode="on-scroll"
  • data-cld-floating-when-not-visible="left"
  • 数据封表表示Yatra一
  • sld-colorssssss

实例方法

视频播放器下方方法允许获取或设置属性或执行初始实例加载后操作

多数方法返回玩家实例,以便链法调用

举例说,下列代码创建播放列表面向播放器并调用玩游戏方法 :

代码屏蔽播放器 设置变换应用到播放器中所有源码设置源码视频播放并调用玩游戏方法 :

可使用实例方法实现:

视频配置

当前PublicId

currentPublicId()

当前公共标识法获取当前源公开标识

源码

源码(publicId或winUrl,options)

源法为播放器设置新视频源并配置配置新视频源码使用下方构造参数也可以获取或设置这些属性或操作视频源码对象后初始实例加载

公共标识

云公共标识视频播放可指定为单参数或选项参数内

原创登陆器

完全URL视频使用源if descriptalal URL可包含变换内URL访问替代定义选项参数

注解
  • 使用原始 URL时,创建视频播放器实例支持时必须包含相关云产环境云名视频解析数据.
  • URL中包含的任何变换使用选项参数覆盖定义
选项
百合 类型 描述性
章次 布尔或对象 上头章次定义视频源可补充方式有:
  • 设置至真实性VTT文件自动添加章节使用命名规范存储于产品环境 章.vt .可使用分页编辑器创建视频播放器演播室
  • 使用VTT文件指定链接URL参数类
  • 手动定义章节,将键设置为章节启动时间秒数和值设定为章节标题
例举 :
  • 章节:真
  • chapters: { url: "https://res.www.agrosoland.com/demo/raw/upload/docs/chapters_example.vtt" }
  • {1:Captrol1}6:Captro2
默认值 :虚伪
信息库 对象类 标题字幕描述视频 主播放器视图使用 即时播放列表视频 推荐板例举 :vplayer.source(Mymovie) {info:{标题:My标题/
interactionAreas 对象类 配置为指定的源向视频播放器添加区域交互允许查看者点击视频并与其交互作用,例如放大视频区域更多信息见交互式视频.
最大轨迹 整数 最大视频播放器数请求视频多请求可能是必要的,如果视频首次请求时仍在处理中默认=3.可并用视频超时
招贴画 对象类 图片源加载时显示默认值:源视频中间图像/video/publicId.jpg)
推荐建议 数组函数或允诺 上头视频源码对象显示为当前建议视频源码.可指定为数组源或函数或允诺解决成数组源看吧显示视频推荐求更多
可购入性 对象类 配置向视频播放器UI添加组件允许查看器点击项目购买更多信息见可商店视频.
源类型 数组 视频源类型(可选对应编解码器)可供播放者请求使用(视当前浏览器而定)。如果源类型无法在请求浏览器中播放,数组中下一个源将被试源类型后添加编解码器并分解mp4/h265.

HLS和MPEG-DASH使用值hls并破折号并可选指定上文描述的编解码器

面向自动格式选择使用汽车.

只限音频使用音频.

if also定义编解码器作为变换的一部分,这将覆盖源类型

默认值 :f_auto:视频.默认自动格式选择应用文件选择最优文件类型
sourceTransformation 对象类 默认变换应用到特定源类型例举 :vplayer.source(mymovie),{sourtransformation({{p4}:{宽度410.看吧sourceTransformation方法语法
文本轨迹 对象类 文本轨迹添加视频源字幕或字幕.

例举 :播放器.s/res.www.agrosoland.com/demo/raw/upload/outdoors.vt

使用选项参数指定自定义选项.
变换 云型变换对象数组或字符串 变换应用到指定的视频源看吧变换法求语法
视频超时 整数 最大时间( 毫秒) 视频播放者等待视频提供如果视频首次请求时仍在处理中,则此点可能相关默认=55000.可并用最大轨迹.

文本轨迹选项
百合 类型 描述性
框内 对象类 位置和大小装箱显示文本轨迹定义宽度并高度显示并设置X级并y市坐标定位框例举 :{x:0%,y:0%,宽度:100%,高度:100%
字体脸孔 字符串 字体表情用于文本轨迹支持Google字体
字体大小 字符串 字体大小用于文本轨迹仅使用相对单元,例如百分数或模组.
重力 字符串 文本轨迹位置视频或存储器框内.支持方向值顶部,右转,底部,左转,中心点并组合上右,底层右,左下角,左上角.默认值 :底部
风格化 对象类 ss定型应用文本例举 :{color:black}.
主题化 字符串 一组预定义样式应用到文本轨迹可能的值 :默认,视频js默认,黄线,玩家颜色,3d.默认值 :默认.

播放列表

playlist(sources,options)

使用播放列表法获取或设置视频源列表播放器,包括任何所需变换

源码

视频源播放列表见源码获取更多信息

选项
百合 类型 描述性
自动前置 数目或虚伪 是否自动向下视频推延
可能的值 :
-0即时推送
-任何正值时间延迟视频
-虚伪:不预发
重复 布尔 是否回溯到播放列表尾端最后一段视频后的第一个视频
即时上台 布尔 是否显示列表中下段视频缩略图链路
可能的值 :
-虚伪:默认值不展示即将到来的视频
-真实性显示即时视频10秒前结束当前视频
-任何正值秒前当前视频显示即将到来视频

也可以修改这些选项并执行播放列表实例上多项其他操作细节见:播放列表操作.

播放列表ByTag

playlistByTag(tag,options)

PlaylistByTag方法执行调用客户端资产列表运算并返回允诺对象后返回播放列表由产品环境所有视频组成并带指定标签的播放器

标签识别

字符串值表示标签名构建播放列表

选项
百合 类型 描述性
排序器 函数转换 默认时视频列表排序参数接收函数设置检索视频源序函数应接收两个项并判定先出先出排序者行为与avaScript数组相似对比功能.
源Params 对象类 源码设置将应用到所有检索视频
自动前置 数目或虚伪 是否自动向下视频推延
可能的值 :
-0即时推送
-任何正值时间延迟视频
-虚伪:不预发
重复 布尔 是否回溯到播放列表尾端最后一段视频后的第一个视频
即时上台 布尔 是否显示列表中下段视频缩略图链路
可能的值 :
-虚伪:默认值不展示即将到来的视频
-真实性显示即时视频10秒前结束当前视频
-任何正值秒前当前视频显示即将到来视频

源ByTag

sourcesByTag(tag,options)

sourceByTag方法检索视频源方法有同语法并支持同选项播放列表ByTag.

autoShowRecommendations

autoShowRecommendations(Boolean)

使用自显示建议布林法判定是否在当前视频尾端显示推荐,如果可用的话播放列表自动前置华府市虚伪下段视频自动使用为建议,如果没有定义清晰单源玩家除设置autoShowRecommendations至真实性中,你必须清晰定义视频建议(或提供函数或允诺返回和源数组)source.recommendations参数化可选使用source.recommendations参数显示播放列表中的源,该参数取代默认行为显示下一视频为推荐

源类型

sourceTypes(Array)

使用源类型法获取或设置默认源类型(可选对应编解码器)如果源类型无法在请求浏览器中播放,数组中下一个源将被试源类型后添加编解码器并分解mp4/h265.

HLS和MPEG-DASH使用值hls并破折号并可选指定上文描述的编解码器

面向自动格式选择使用汽车.

只限音频使用音频.

if also定义编解码器作为变换的一部分,这将覆盖源类型

默认:默认值:f_auto:视频.默认自动格式选择应用文件选择最优文件类型

sourceTransformation

sourceTransformation(Object)

源转换法设置默认变换,用于指定源类型所有视频

获取特定源类型变换集

变换

变换(克隆.变换对象,数组或字符串)

使用变换法获取或设置播放器基变

招贴选择

posterOptions(options)

使用招贴选择法获取或设置公共标识和/或变换从现在开始应用时新视频加载默认时,每加载新视频都使用视频中间图像/video/publicId.jpg)

选项
百合 类型 描述性
公共标识 字符串 公共标识图用作招贴
变换 云型变换对象数组或字符串 变换应用到指定的视频源看吧变换法语法类
招贴画库 字符串 常量显示颜色替代图像无关还含公共标识或变换上下文Objects对象中的参数颜色可以是字符串值表示RGB或RGBAex三重或四重、三四位数RGB/RGBBA十六重或名色

控件

玩游戏

播放()

使用游戏法播放当前视频

暂停

暂停()

使用暂停法暂停当前视频

停止

stop()

停止法停止当前视频

下播放

播放Next

PlayNext方法播放播放列表中的下一段视频

播放前置

PlayPreceive()

Play前置视频播放列表

音量

卷量(卷量)

音量法获取或设置视频播放器音量级别量值介于0(静态)和1(最大量)间

哑巴

哑巴

静默法静默视频播放器

无云

unmute ()

unute方法解析视频播放器并恢复前一卷级

正模

smutte

使用调试法返回播放器当前是否停播

当前时间

currentTime(offsetSeconds)

当前时间法获取或设置当前视频播放时间

持续时间

持续时间 ()

使用持续时间法返回当前播放视频的持续时间

最大化

最大化

最大值方法输入全屏模式

退出最大化

excrimize ()

退出最大法退出全屏模式

最大化

eximized()

使用非最大化方法返回视频播放器是否全屏

视频播放器元素

流水体

流体(Boolean)

流水法判定是响应性调整视频大小以适应容器或窗口大小

高度显示

height(dimension)

使用高度法获取或设置视频播放器高度

宽度

width(dimension)

使用宽度法获取或设置视频播放器宽度

处理

处置 ()

处置法处置视频播放器并去除DOM中的元素

el市

el()

e方法返回视频播放器DOM元素

上

上(事件回调)

使用方法注册事件处理程序

关机

关闭(事件回调)

使用离线法从指定事件解码事件处理程序

视频JS

ViotiveJS(Object)

使用视频JS方法访问视频JSAPI所有底层能力细节见ViewJS播放器API.

事件处理

可注册视频播放器事件并用这些事件创建自定义视频播放器控件或触发应用中的其他自定义行为

此外,其中一些事件可跟踪谷歌分析器或其他解析跟踪器

可注册事件处理程序到下列HTML5视频事件

加载启动,悬停,中止,报错,清空,悬停,加载元数据,加载数据,可玩游戏,可编程,播放,等待时间,寻道,寻道,结束,持续时间变换,时间更新,进度分析,玩游戏,暂停,速率变化,量变,fullscreenchange,招贴切换.

由云视频播放器提供下列事件

哑巴

触发播放器停播

无云

玩家变换时触发

百分数播放

视频回播达X%时触发全视频持续时间触发事件百分数由视频播放器构造符定义playedEventPercents参数化

定时播放

视频重播后X秒触发秒由视频播放器构造符定义playedEventTimes参数化

寻道

触发器寻道Start并寻找End数据.

源交换

视频播放器源修改时触发

质量变换

触发自适应比特率质变返回视频高度宽度

出错

可监听错误报错事件详解并使用错误响应来确定视频播放器应如何响应示例下函数显示视频播放器自定义报错 :

播放列表操作

可依据公开标识列表或带指定标签的所有视频创建播放列表下方方法控制播放列表

概述和指令创建播放列表见创建播放列表.

操作 描述性
playAtIndex(index) 设置播放器当前视频源为播放列表中指定的0基索引位置并开始播放
currentIndex(index) 获取或设置当前视频源0基索引值
当前源码 获取当前播放视频源码.
链表 获取数组视频源码实例播放列表
重复(重试) 获取或设置播放列表自上视频结束播放后开始重播播放列表
PlayFirst () 设置播放器当前视频源到播放列表中的第一个视频源并播放
PlayLast () 设置播放器当前视频源
长度() 返回播放列表视频源数
播放Next 设置播放器当前源次播放列表并播放if当前播放源重复设为真实性中的第一个源播放否则什么都不会发生
PlayPreceive() 将播放器当前源设置为播放列表前源并播放如果当前播放源头列表中的第一个,则无事发生
播放器 () 返回返回视频层面向此播放列表 。
autoAdvance(delay) 获取或搭建播放列表自传配置
正整数延迟值设置延迟秒数,播放者等待播放下一段视频
- 值a虚伪取消自动预发转录影带使用下播放)
值0引出下一段视频紧接前一结束后播放
即时上台 获取或设置当前播放列表Upnew配置
- 值a虚伪取消展示即将到来的视频
- 值a真实性激活即时视频演示10秒前结束当前视频
正整数值设置当前视频结束前秒数显示即时视频

反馈发送

评分本页 :