成员
(常量) LOCAL_STORAGE_KEY
(常量) MODAL_CLASS_NAME
(常量) STEP_SECONDS
(常量) darkGray
(常量) defaults
(常量) defaults :TransientButtonOptions
(常量) findMimetype
如果可能,查找给定源字符串的MIME类型。使用播放器源缓存。
(常量) getMimetype
如果可能,获取给定src URL的MIME类型
(常量) innerHTMLDescriptorPolyfill
我们为没有innerHTML
描述符的浏览器实现的innerHTML
描述符。
(常量) srcDescriptorPolyfill
我们为没有src
描述符的浏览器实现的src
描述符
方法
constructColor(color, opacity) → {string}
从给定的十六进制颜色代码构造一个RGBA颜色。
名称 | 类型 | 描述 |
---|---|---|
颜色 | 数字 | 颜色的十六进制值,例如#f0e或#f604e2。 |
不透明度 | 数字 | 不透明度值,0.0 - 1.0。 |
创建的RGBA颜色,例如'rgba(255, 0, 0, 0.3)'。
- 类型:
- 字符串
firstSourceWatch(tech)
修补浏览器内部函数,以便我们可以同步判断是否有<source>
被添加到媒体元素中。出于某种原因,如果媒体元素已准备就绪且没有源,这会导致sourceset
事件。这在以下情况下发生:
- 页面刚刚加载,媒体元素没有源。
- 媒体元素已清空所有源,然后调用了
load()
。
它通过在支持时修补以下函数/属性来实现此目的:
append()
- 可用于向媒体元素添加<source>
元素appendChild()
- 可用于向媒体元素添加<source>
元素insertAdjacentHTML()
- 可用于向媒体元素添加<source>
元素innerHTML
- 可用于向媒体元素添加<source>
元素
名称 | 类型 | 描述 |
---|---|---|
技术 | Html5 | 正在设置sourceset的技术对象。 |
getDescriptor()
给定优先级列表和要获取的属性,获取属性描述符。
hasPlugin(name) → {boolean}
报告播放器是否可用某个插件。
这不报告此播放器上是否曾初始化过该插件。为此,请参阅usingPlugin。
名称 | 类型 | 描述 |
---|---|---|
名称 | 字符串 | 插件名称。 |
此播放器是否可用请求的插件。
- 类型:
- 布尔值
hook(type, The)
将函数钩子添加到特定的Video.js生命周期。
名称 | 类型 | 描述 |
---|---|---|
类型 | 字符串 | 函数要挂接的生命周期。 |
函数 | 函数 | | 要附加的函数或函数数组。 |
hookOnce(type, The)
将只运行一次的函数钩子添加到特定的Video.js生命周期。
名称 | 类型 | 描述 |
---|---|---|
类型 | 字符串 | 函数要挂接的生命周期。 |
函数 | 函数 | | 要附加的函数或函数数组。 |
hooks(type, fnopt) → {Array}
获取特定生命周期的钩子列表
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
类型 | 字符串 | 要获取钩子的生命周期 | |
函数 | 函数 | | <可选> | 可选地,向您正在获取的生命周期添加一个(或多个)钩子。 |
钩子数组,如果没有则为空数组。
- 类型:
- 数组
isActuallyDisabled(element) → {boolean}
判断元素是否实际处于禁用状态。
名称 | 类型 | 描述 |
---|---|---|
元素 | 节点 |
- 类型:
- 布尔值
isBeingRendered(element) → {boolean}
判断元素是否正在被渲染。
- 如果元素的样式为“visibility: hidden | collapse”或“display: none”,则不会被渲染。
- 如果元素的样式为“opacity: 0”,则不会被渲染(即不可见)。
- 如果元素的宽度和高度明确设置为0,则不会被渲染。
- 如果父元素被隐藏,则元素本身不会被渲染。(CSS visibility属性和display属性是可继承的。)
名称 | 类型 | 描述 |
---|---|---|
元素 | 节点 |
- 类型:
- 布尔值
isExpresslyInert(element) → {boolean}
判断元素是否明确处于惰性状态。
名称 | 类型 | 描述 |
---|---|---|
元素 | 节点 |
- 类型:
- 布尔值
isPromise(value) → {boolean}
返回一个对象是否是Promise
-like的(即是否具有then
方法)。
名称 | 类型 | 描述 |
---|---|---|
值 | 对象 | 一个可能或可能不是 |
对象是否是Promise
-like。
- 类型:
- 布尔值
isVisible(element) → {boolean}
判断元素对用户是否可见。
- 如果一个元素的offsetWidth、offsetHeight、height和width的总和小于1,则不可见。
- 如果elementCenter.x小于则不可见。
- 如果elementCenter.x大于文档宽度,则不可见。
- 如果elementCenter.y小于0,则不可见。
- 如果elementCenter.y是文档的高度,则不可见。
名称 | 类型 | 描述 |
---|---|---|
元素 | 节点 |
- 类型:
- 布尔值
isVisibleStyleProperty(element) → {boolean}
判断此元素的样式属性是否指定了其可见性。
名称 | 类型 | 描述 |
---|---|---|
元素 | CSSStyleDeclaration |
- 类型:
- 布尔值
percentify()
removeHook(type, fn) → {boolean}
从特定的Video.js生命周期中移除钩子。
名称 | 类型 | 描述 |
---|---|---|
类型 | 字符串 | 函数所挂接的生命周期 |
函数 | 函数 | 要移除的已挂接函数 |
被移除的函数或undefined
- 类型:
- 布尔值
setupSourceset(tech)
在Html5
技术上设置sourceset
处理。此函数修补以下元素属性/函数:
src
- 用于确定何时设置src
setAttribute()
- 用于确定何时设置src
load()
- 这会重新触发源选择算法,并可能导致sourceset事件。
如果在添加sourceset
支持时或在load()
期间没有源,我们还会修补firstSourceWatch
中列出的函数。
名称 | 类型 | 描述 |
---|---|---|
技术 | Html5 | 要修补的技术 |
silencePromise(value)
静默一个Promise-like对象。
这对于避免无害但可能令人困惑的“未捕获的播放Promise”拒绝错误消息很有用。
名称 | 类型 | 描述 |
---|---|---|
值 | 对象 | 一个可能或可能不是 |
sourcesetLoad(tech) → {boolean}
此函数用于在调用类似mediaEl.load()
的操作时触发sourceset。它将尝试通过src
属性,然后通过<source>
元素查找源。然后,它将使用找到的源(如果无法得知则为空字符串)触发sourceset
事件。如果找不到源,则不会触发sourceset
。
名称 | 类型 | 描述 |
---|---|---|
技术 | Html5 | 设置sourceset的技术对象 |
如果未触发sourceset则返回false,否则返回true。
- 类型:
- 布尔值
类型定义
错误元数据
一个包含错误类型以及其他错误相关信息的对象。
- 对象
名称 | 类型 | 描述 |
---|---|---|
错误类型 | 字符串 | 错误类型 |
事件
一个自定义DOM事件。
- CustomEvent
- 参见
EventListener(event, hashopt)
所有事件监听器应遵循以下格式。
- {事件目标}
名称 | 类型 | 属性 | 描述 |
---|---|---|---|
事件 | 事件 | 触发此函数的事件 | |
哈希 | 对象 | <可选> | 事件期间发送的数据哈希 |
PlayerReadyCallback() → {void}
- {播放器}
- 类型:
- 无
播放器版本
一个包含Video.js版本的对象。
- 对象
名称 | 类型 | 描述 |
---|---|---|
'video.js' | 字符串 | Video.js版本 |
插件事件哈希
- 对象
名称 | 类型 | 描述 |
---|---|---|
实例 | 字符串 | 对于基本插件,为插件函数的返回值。对于高级插件,为触发事件的插件实例。 |
名称 | 字符串 | 插件名称。 |
插件 | 字符串 | 对于基本插件,为插件函数。对于高级插件,为插件类/构造函数。 |
ReadyCallback() → {void}
一个在组件准备就绪时将调用的回调。this
将是组件实例。
- 类型:
- 无
源对象
一个包含以下结构的对象:{src: 'url', type: 'mimetype'}
,或仅包含src URL的字符串。
var SourceObject = {src: 'http://ex.com/video.mp4', type: 'video/mp4'};
var SourceString = 'http://example.com/some-video.mp4';
- 对象 |
字符串
名称 | 类型 | 描述 |
---|---|---|
源 | 字符串 | 源的URL |
类型 | 字符串 | 源的MIME类型 |
瞬时按钮选项
- 对象
名称 | 类型 | 属性 | 默认 | 描述 |
---|---|---|---|---|
控制文本 | 字符串 | <可选> | 控制文本,通常这些按钮可见。 | |
初始显示 | 数字 | <可选> | 4000 | 按钮初始保持可见的毫秒数 |
位置 | 数组.<('top'|'neartop'|'bottom'|'left'|'right')> | <可选> | 用于添加基本定位样式的位置字符串数组 | |
类名 | 字符串 | <可选> | 要添加的类 | |
获取焦点 | 布尔值 | <可选> | 假 | 元素显示时是否应获取焦点 |
点击处理函数 | 函数 | <可选> | 按钮激活时调用的函数 |