继承
方法
$(selector, contextopt) → {Element|null}
查找匹配selector的单个DOM元素。这可以在Component的contentEl()中或另一个自定义上下文中进行。
| 名称 | 类型 | 属性 | 默认 | 描述 |
|---|---|---|---|---|
选择器 | string | 一个有效的CSS选择器，将传递给 | ||
上下文 | Element | | <可选> | this.contentEl() | 一个用于查询的DOM元素。也可以是一个选择器字符串，在这种情况下，第一个匹配的元素将用作上下文。如果缺少，则使用 |
- 继承自
- 参见
找到的DOM元素，或null
- 类型：
- Element |
null
$$(selector, contextopt) → {NodeList}
查找匹配selector的所有DOM元素。这可以在Component的contentEl()中或另一个自定义上下文中进行。
| 名称 | 类型 | 属性 | 默认 | 描述 |
|---|---|---|---|---|
选择器 | string | 一个有效的CSS选择器，将传递给 | ||
上下文 | Element | | <可选> | this.contentEl() | 一个用于查询的DOM元素。也可以是一个选择器字符串，在这种情况下，第一个匹配的元素将用作上下文。如果缺少，则使用 |
- 继承自
- 参见
找到的DOM元素列表
- 类型：
- 节点列表
addChild(child, optionsopt, indexopt) → {Component}
在当前Component中添加一个子Component。
| 名称 | 类型 | 属性 | 默认 | 描述 |
|---|---|---|---|---|
子项 | string | | 要添加的子项的名称或实例。 | ||
选项 | Object | <可选> | {} | 将传递给子项的子项的选项的键/值存储。 |
索引 | 数字 | <可选> | this.children_.length | 尝试添加子项的索引。 |
作为子项添加的Component。使用字符串时，Component将由该过程创建。
- 类型：
- Component
addClass(…classesToAdd)
向Component的元素添加CSS类名。
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
要添加的类 | string | <可重复> | 一个或多个要添加的CSS类名。 |
blur()
从此组件中移除焦点
(abstract) buildCSSClass() → {string}
构建默认的DOM类名。应由子组件覆盖。
此对象的DOM类名。
- 类型：
- string
cancelAnimationFrame(id) → {number}
取消传递给Component#requestAnimationFrame (rAF) 的排队回调。
如果您通过Component#requestAnimationFrame排队了一个rAF回调，请使用此函数而不是window.cancelAnimationFrame。否则，您的销毁监听器将不会被清理，直到Component#dispose！
| 名称 | 类型 | 描述 |
|---|---|---|
ID | 数字 | 要清除的rAF ID。Component#requestAnimationFrame的返回值。 |
- 参见
返回已清除的rAF ID。
- 类型：
- 数字
cancelNamedAnimationFrame(name)
如果存在，取消当前的命名动画帧。
| 名称 | 类型 | 描述 |
|---|---|---|
名称 | string | 要取消的requestAnimationFrame的名称。 |
children() → {Array}
获取所有子组件的数组
子项
- 类型：
- 数组
clearInterval(intervalId) → {number}
清除通过window.setInterval或Component#setInterval创建的间隔。如果您通过Component#setInterval设置了一个间隔，请使用此函数而不是window.clearInterval。否则，您的销毁监听器将不会被清理，直到Component#dispose！
| 名称 | 类型 | 描述 |
|---|---|---|
intervalId | 数字 | 要清除的间隔ID。Component#setInterval或 |
- 参见
返回已清除的间隔ID。
- 类型：
- 数字
clearTimeout(timeoutId) → {number}
清除通过window.setTimeout或Component#setTimeout创建的超时。如果您通过Component#setTimeout设置了一个超时，请使用此函数而不是window.clearTimout。否则，您的销毁监听器将不会被清理，直到Component#dispose！
| 名称 | 类型 | 描述 |
|---|---|---|
timeoutId | 数字 | 要清除的超时ID。Component#setTimeout或 |
- 参见
返回已清除的超时ID。
- 类型：
- 数字
contentEl() → {Element}
返回Component的DOM元素。子项将插入到此处。这通常与Component#el中返回的元素相同。
此Component的内容元素。
- 类型：
- 元素
createEl() → {Element}
创建Component的DOM元素
创建的元素。
- 类型：
- 元素
currentDimension(widthOrHeight) → {number}
获取组件元素的计算宽度或高度。
使用window.getComputedStyle。
| 名称 | 类型 | 描述 |
|---|---|---|
宽度或高度 | string | 包含“width”或“height”的字符串。您想获取的任何一个。 |
请求的维度，如果该维度未设置，则为0。
- 类型：
- 数字
currentDimensions() → {Component~DimensionObject}
获取一个包含组件元素计算宽度和高度值的对象。
使用window.getComputedStyle。
组件元素的计算维度。
currentHeight() → {number}
获取组件元素的计算高度。
使用window.getComputedStyle。
组件元素的计算高度。
- 类型：
- 数字
currentWidth() → {number}
获取组件元素的计算宽度。
使用window.getComputedStyle。
组件元素的计算宽度。
- 类型：
- 数字
dimension(widthOrHeight, numopt, skipListenersopt) → {number|undefined}
获取或设置Component元素的宽度或高度。这是Component#width和Component#height的共享代码。
需要了解的事项
- 如果宽度或高度是数字，这将返回以“px”为后缀的数字。
- 如果宽度/高度是百分比，这将返回以“%”为后缀的百分比
- 隐藏元素的宽度在
window.getComputedStyle下为0。此函数默认为Component的style.width，并回退到window.getComputedStyle。有关更多信息，请参阅此处 - 如果您想要组件的计算样式，请使用Component#currentWidth和{Component#currentHeight
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
宽度或高度 | string | 8 'width' 或 'height' | |
num | number | | <可选> | 8 新维度 |
跳过监听器 | 布尔值 | <可选> | 跳过componentresize事件触发 |
获取时的维度，如果未设置则为0
- 类型：
- number |
undefined
dimensions(width, height)
同时设置Component元素的宽度和高度。
| 名称 | 类型 | 描述 |
|---|---|---|
宽度 | number | | 要设置 |
高度 | number | | 要设置 |
dispose(options)
销毁Component及所有子组件。
| 名称 | 类型 | 描述 | ||||||
|---|---|---|---|---|---|---|---|---|
选项 | Object | 属性
|
el() → {Element}
获取Component的DOM元素
- 继承自
此Component的DOM元素。
- 类型：
- 元素
(protected) emitTapEvents()
检测到触摸事件支持时发出“tap”事件。这用于通过轻触视频来支持切换控件。它们之所以启用，是因为否则每个子组件都会有额外的开销。
- Component#event:touchstart
- Component#event:touchmove
- Component#event:touchleave
- Component#event:touchcancel
- Component#event:touchend
enableTouchActivity()
此函数在触摸事件发生时报告用户活动。这可以被任何希望触摸事件以其他方式运行的子组件关闭。
当触摸事件发生时报告用户触摸活动。用户活动用于确定何时显示/隐藏控件。对于鼠标事件来说很简单，因为任何鼠标事件都应显示控件。因此，我们捕获冒泡到播放器的鼠标事件，并在发生时报告活动。对于触摸事件，它不像touchstart和touchend切换播放器控件那么容易。因此，触摸事件也无法在播放器级别帮助我们。
用户活动是异步检查的。因此，可能发生的情况是视频上的轻触事件关闭了控件。然后touchend事件冒泡到播放器。如果它报告了用户活动，就会立即重新打开控件。我们也不希望完全阻止触摸事件冒泡。此外，touchmove事件以及除轻触之外的任何其他事件，都不应重新打开控件。
- Component#event:touchstart
- Component#event:touchmove
- Component#event:touchend
- Component#event:touchcancel
focus()
将焦点设置到此组件
getAttribute(attribute) → {string|null}
获取Component元素上的属性值。
| 名称 | 类型 | 描述 |
|---|---|---|
属性 | string | 要获取其值的属性名称。 |
- 参见
- 请求的属性值。- 在某些浏览器中，如果属性不存在或没有值，则可能为空字符串 - 大多数浏览器在属性不存在或没有值时将返回null。
- 类型：
- string |
null
getChild(name) → {Component|undefined}
返回具有给定name的子Component。
| 名称 | 类型 | 描述 |
|---|---|---|
名称 | string | 要获取的子 |
具有给定name的子Component或undefined。
- 类型：
- Component |
undefined
getChildById(id) → {Component|undefined}
返回具有给定id的子Component。
| 名称 | 类型 | 描述 |
|---|---|---|
ID | string | 要获取的子 |
具有给定id的子Component或undefined。
- 类型：
- Component |
undefined
getDescendant(…names) → {Component|undefined}
返回给定后代names对应的后代Component。例如，['foo', 'bar', 'baz'] 将尝试在当前组件上获取'foo'，在'foo'组件上获取'bar'，在'bar'组件上获取'baz'，如果其中任何一个不存在，则返回undefined。
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
名称 | ...Array.<string> | | <可重复> | 要获取的子 |
遵循给定后代names的后代Component或undefined。
- 类型：
- Component |
undefined
getIsAvailableToBeFocused(el) → {boolean}
确定此组件是否当前可见/启用/等...
| 名称 | 类型 | 描述 |
|---|---|---|
元素 | HTMLElement | 代表组件的HTML元素。 |
如果组件当前可见且启用，则为true。否则，为false。
- 类型：
- 布尔值
getIsFocusable(el) → {boolean}
确定此组件是否可被视为可聚焦组件。
| 名称 | 类型 | 描述 |
|---|---|---|
元素 | HTMLElement | 代表组件的HTML元素。 |
如果组件可以被聚焦，则为true。否则，为false。
- 类型：
- 布尔值
getPositions() → {Object}
检索组件元素的位置和大小信息。
一个包含boundingClientRect和center属性的对象。- boundingClientRect：一个包含x、y、width、height、top、right、bottom和left属性的对象，表示元素的边界矩形。- center：一个包含x和y属性的对象，表示元素的中心点。width和height设置为0。
- 类型：
- Object
handleKeyDown(event)
当此Component接收到一个它不处理的keydown事件时，它会将该事件传递给Player进行处理。
| 名称 | 类型 | 描述 |
|---|---|---|
event | KeyboardEvent | 导致此函数被调用的 |
handleKeyPress(event)
许多组件过去都有一个handleKeyPress方法，但其命名不佳，因为它监听的是keydown事件。现在此方法名称委托给handleKeyDown。这意味着任何调用handleKeyPress的人都不会看到他们的方法调用停止工作。
| 名称 | 类型 | 描述 |
|---|---|---|
event | KeyboardEvent | 导致此函数被调用的事件。 |
(抽象) handleLanguagechange()
处理组件中播放器的语言变化。应由子组件覆盖。
hasClass(classToCheck) → {boolean}
检查组件元素是否具有CSS类名。
| 名称 | 类型 | 描述 |
|---|---|---|
classToCheck | string | 要检查的CSS类名。 |
- 如果
Component具有该类，则为True。- 如果Component不具有该类，则为False。
- 类型：
- 布尔值
height(numopt, skipListenersopt) → {number|undefined}
根据CSS样式获取或设置组件的高度。有关更详细的信息，请参见Component#dimension。
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
num | number | | <可选> | 您要设置的高度，后缀为“%”、“px”或无。 |
跳过监听器 | 布尔值 | <可选> | 跳过componentresize事件触发器 |
获取时的高度，如果没有高度则为零
- 类型：
- number |
undefined
hide()
如果Component的元素当前正在显示，则通过向其添加“vjs-hidden”类名来隐藏它。
id() → {string}
获取此Component的ID
- 继承自
此Component的ID
- 类型：
- string
initChildren()
根据选项添加和初始化默认子Component。
isDisposed() → {boolean}
确定此组件是否已销毁。
如果组件已销毁，则为true。否则，为false。
- 类型：
- 布尔值
localize(string, tokensopt, defaultValueopt) → {string}
给定英文字符串，将字符串本地化。
如果提供了令牌，它将尝试对提供的字符串进行简单的令牌替换。它查找的令牌看起来像{1}，其中索引是令牌数组中的1-indexed。
如果提供了defaultValue，当在提供的语言文件中找不到值时，将优先使用它而不是string。这对于希望为令牌替换设置描述性键但拥有简洁的本地化字符串且不需要包含en.json的情况很有用。
目前，它用于进度条计时。
{
"progress bar timing: currentTime={1} duration={2}": "{1} of {2}"
}
然后像这样使用
this.localize('progress bar timing: currentTime={1} duration{2}',
[this.player_.currentTime(), this.player_.duration()],
'{1} of {2}');
输出类似：01:23 of 24:56。
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
string | string | 要本地化的字符串和在语言文件中查找的键。 | |
令牌 | Array.<string> | <可选> | 如果当前项有令牌替换，请在此处提供令牌。 |
默认值 | string | <可选> | 默认为 |
本地化字符串，或者如果不存在本地化，则为英文字符串。
- 类型：
- string
name() → {string}
获取Component的名称。该名称用于引用Component并在注册期间设置。
此Component的名称。
- 类型：
- string
options(obj) → {Object}
使用新选项深度合并选项对象。
注意：当
obj和options都包含其值为对象的属性时。这两个属性将使用module:obj.merge合并
| 名称 | 类型 | 描述 |
|---|---|---|
obj | Object | 包含新选项的对象。 |
this.options_和obj合并后的新对象。
- 类型：
- Object
player() → {Player}
返回Component所附着的Player。
此Component所附着的播放器。
- 类型：
- Player
ready(fn)
将监听器绑定到组件的就绪状态。与事件监听器不同，如果就绪事件已经发生，它将立即触发函数。
| 名称 | 类型 | 描述 |
|---|---|---|
fn | ReadyCallback | 当 |
removeAttribute(attribute)
从Component的元素中移除属性。
| 名称 | 类型 | 描述 |
|---|---|---|
属性 | string | 要移除的属性名称。 |
- 参见
removeChild(component)
从此Component的子项列表中移除子Component。同时从此Component的元素中移除子Component的元素。
| 名称 | 类型 | 描述 |
|---|---|---|
组件 | Component | 要移除的子 |
removeClass(…classesToRemove)
从Component的元素中移除CSS类名。
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
要移除的类 | string | <可重复> | 一个或多个要移除的CSS类名。 |
requestAnimationFrame(fn) → {number}
将回调排队传递给requestAnimationFrame (rAF)，但有一些额外的优点
通过回退到Component#setTimeout来支持不支持rAF的浏览器。
回调被转换为Component~GenericCallback（即绑定到组件）。
如果组件在调用之前被销毁，则会自动取消rAF回调。
| 名称 | 类型 | 描述 |
|---|---|---|
fn | Component~GenericCallback | 一个函数，它将绑定到此组件并在浏览器下一次重绘之前执行。 |
- 参见
返回一个rAF ID，用于标识超时。它也可以在Component#cancelAnimationFrame中使用以取消动画帧回调。
- 类型：
- 数字
requestNamedAnimationFrame(name, fn)
请求一个动画帧，但只排队一个命名动画帧。在前面的动画帧完成之前，永远不会添加另一个。
| 名称 | 类型 | 描述 |
|---|---|---|
名称 | string | 此requestAnimationFrame的名称 |
fn | Component~GenericCallback | 一个函数，它将绑定到此组件并在浏览器下一次重绘之前执行。 |
setAttribute(attribute, value)
设置Component元素上的属性值
| 名称 | 类型 | 描述 |
|---|---|---|
属性 | string | 要设置的属性名称。 |
值 | string | 要将属性设置为的值。 |
- 参见
setIcon(iconName, elopt) → {Element}
向另一个元素或组件添加SVG图标元素。
| 名称 | 类型 | 属性 | 默认 | 描述 |
|---|---|---|---|---|
图标名称 | string | 图标的名称。所有图标名称的列表可以在“sandbox/svg-icons.html”中找到 | ||
元素 | 元素 | <可选> | this.el() | 要设置标题的元素。默认为当前组件的元素。 |
新创建的图标元素。
- 类型：
- 元素
setInterval(fn, interval) → {number}
创建一个每x毫秒运行一次的函数。此函数是window.setInterval的包装。但仍有一些原因选择使用此函数。
- 当Component#dispose被调用时，它通过Component#clearInterval被清除。
- 函数回调将是Component~GenericCallback
| 名称 | 类型 | 描述 |
|---|---|---|
fn | Component~GenericCallback | 每 |
间隔 | 数字 | 每 |
- 参见
返回一个可用于标识间隔的ID。它也可以在Component#clearInterval中使用以清除间隔。
- 类型：
- 数字
setTimeout(fn, timeout) → {number}
创建一个在x毫秒超时后运行的函数。此函数是window.setTimeout的包装。但仍有一些原因选择使用此函数
- 当Component#dispose被调用时，它通过Component#clearTimeout被清除。
- 函数回调将被转换为Component~GenericCallback
注意：您不能对此函数返回的ID使用
window.clearTimeout。这会导致其销毁监听器无法被清理！请改用Component#clearTimeout或Component#dispose。
| 名称 | 类型 | 描述 |
|---|---|---|
fn | Component~GenericCallback | 将在 |
超时 | 数字 | 在执行指定函数之前延迟的毫秒数。 |
- 参见
返回一个超时ID，用于标识超时。它也可以在Component#clearTimeout中使用以清除已设置的超时。
- 类型：
- 数字
show()
如果Component的元素被隐藏，则通过从其移除“vjs-hidden”类名来显示它。
toggleClass(classToToggle, predicateopt)
向组件的元素添加或移除CSS类名。
- 当Component#hasClass返回false时，添加
classToToggle。 - 当Component#hasClass返回true时，移除
classToToggle。
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
classToToggle | string | 要添加或移除的类。传递给DOMTokenList的toggle() | |
谓词 | boolean | | <可选> | 一个布尔值或返回布尔值的函数。传递给DOMTokenList的toggle()。 |
triggerReady()
触发此Component的所有就绪监听器。
width(numopt, skipListenersopt) → {number|undefined}
根据CSS样式获取或设置组件的宽度。有关更详细的信息，请参见Component#dimension。
| 名称 | 类型 | 属性 | 描述 |
|---|---|---|---|
num | number | | <可选> | 您要设置的宽度，后缀为“%”、“px”或无。 |
跳过监听器 | 布尔值 | <可选> | 跳过componentresize事件触发器 |
获取时的宽度，如果没有宽度则为零
- 类型：
- number |
undefined
事件
componentresize
当组件大小调整时触发。
dispose
当Component被销毁时触发。
| 名称 | 类型 | 属性 | 默认 | 描述 |
|---|---|---|---|---|
冒泡 | 布尔值 | <可选> | 假 | 设置为false，以便销毁事件不冒泡 |
ready
当Component就绪时触发。
tap
当Component被轻触时触发。
- 鼠标事件