2025-01-15 19:42:35 +01:00

39 lines
16 KiB
HTML

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>js.html.VTTCue - API Reference</title></head><body><style>
a, code .type {
color: #24afc4;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #24afc4;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> VTTCue</h1><h4><small>package <a href="../../js/html/index.html">js.html</a></small></h4><h4><small>extends <a class="type" title="" href="../../js/html/TextTrackCue.html">TextTrackCue</a> &rsaquo; <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</a></small></h4> <p class="availability"><hr/><em>Available on HTML5</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p></p></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p><code><a href="#new"><span class="identifier">new</span></a> (<span style="white-space:nowrap">startTime:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="../../Float.html">Float</a>,</span> <span style="white-space:nowrap">endTime:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="../../Float.html">Float</a>,</span> <span style="white-space:nowrap">text:<a class="type" title="The basic String class." href="../../String.html">String</a></span>)</code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="align"></a><h3><p><code><a href="../../js/html/VTTCue.html#align"><span class="identifier">align</span></a>:<a class="type" title="" href="../../js/html/AlignSetting.html">AlignSetting</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="line"></a><h3><p><code><a href="../../js/html/VTTCue.html#line"><span class="identifier">line</span></a>:<a class="type" title="An abstract type allowing values to be either of T1 or T2 type." href="../../haxe/extern/EitherType.html">EitherType</a>&lt;<a class="type" title="The standard Int type." href="../../Int.html">Int</a>, <a class="type" title="Dynamic is a special type which is compatible with all other types." href="../../Dynamic.html">Dynamic</a>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="lineAlign"></a><h3><p><code><a href="../../js/html/VTTCue.html#lineAlign"><span class="identifier">lineAlign</span></a>:<a class="type" title="" href="../../js/html/AlignSetting.html">AlignSetting</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="position"></a><h3><p><code><a href="../../js/html/VTTCue.html#position"><span class="identifier">position</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="positionAlign"></a><h3><p><code><a href="../../js/html/VTTCue.html#positionAlign"><span class="identifier">positionAlign</span></a>:<a class="type" title="" href="../../js/html/AlignSetting.html">AlignSetting</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="region"></a><h3><p><code><a href="../../js/html/VTTCue.html#region"><span class="identifier">region</span></a>:<a class="type" title="" href="../../js/html/VTTRegion.html">VTTRegion</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="size"></a><h3><p><code><a href="../../js/html/VTTCue.html#size"><span class="identifier">size</span></a>:<a class="type" title="The standard Int type." href="../../Int.html">Int</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="snapToLines"></a><h3><p><code><a href="../../js/html/VTTCue.html#snapToLines"><span class="identifier">snapToLines</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="text"></a><h3><p><code><a href="../../js/html/VTTCue.html#text"><span class="identifier">text</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="vertical"></a><h3><p><code><a href="../../js/html/VTTCue.html#vertical"><span class="identifier">vertical</span></a>:<a class="type" title="" href="../../js/html/DirectionSetting.html">DirectionSetting</a></code></p></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="getCueAsHTML"></a><h3><p><code><a href="#getCueAsHTML"><span class="identifier">getCueAsHTML</span></a> ():<a class="type" title="The DocumentFragment interface represents a minimal document object that has no parent." href="../../js/html/DocumentFragment.html">DocumentFragment</a></code></p></h3><div class="doc"><p></p></div></div></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="" href="../../js/html/TextTrackCue.html">TextTrackCue</a></h4><div style="display:none"><div class="field "><a name="endTime"></a><h3><p><code><a href="../../js/html/TextTrackCue.html#endTime"><span class="identifier">endTime</span></a>:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="../../Float.html">Float</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="id"></a><h3><p><code><a href="../../js/html/TextTrackCue.html#id"><span class="identifier">id</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="onenter"></a><h3><p><code><a href="../../js/html/TextTrackCue.html#onenter"><span class="identifier">onenter</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="onexit"></a><h3><p><code><a href="../../js/html/TextTrackCue.html#onexit"><span class="identifier">onexit</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="pauseOnExit"></a><h3><p><code><a href="../../js/html/TextTrackCue.html#pauseOnExit"><span class="identifier">pauseOnExit</span></a>:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="startTime"></a><h3><p><code><a href="../../js/html/TextTrackCue.html#startTime"><span class="identifier">startTime</span></a>:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="../../Float.html">Float</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="track"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/TextTrackCue.html#track"><span class="identifier">track</span></a>:<a class="type" title="" href="../../js/html/TextTrack.html">TextTrack</a></code></p></h3><div class="doc"><p></p></div></div></div><div style="display:none"></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><div style="display:none"></div><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</a></h4><div style="display:none"><div class="field "><a name="addEventListener"></a><h3><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false,</span> <span style="white-space:nowrap">?wantsUntrusted:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="dispatchEvent"></a><h3><p><code><a href="#dispatchEvent"><span class="identifier">dispatchEvent</span></a> (<span style="white-space:nowrap">event:<a class="type" title="The Event interface represents any event which takes place in the DOM; some are user-generated (such as mouse or keyboard events), while others are generated by APIs (such as events that indicate an animation has finished running, a video has been paused, and so forth)." href="../../js/html/Event.html">Event</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="removeEventListener"></a><h3><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2017 &nbsp;<a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>