playoptions.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>PlayOptions | @urtc/sdk-web</title>
  7. <meta name="description" content="Documentation for @urtc/sdk-web">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. <script async src="../assets/js/search.js" id="search-script"></script>
  11. </head>
  12. <body>
  13. <header>
  14. <div class="tsd-page-toolbar">
  15. <div class="container">
  16. <div class="table-wrap">
  17. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  18. <div class="field">
  19. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  20. <input id="tsd-search-field" type="text" />
  21. </div>
  22. <ul class="results">
  23. <li class="state loading">Preparing search index...</li>
  24. <li class="state failure">The search index is not available</li>
  25. </ul>
  26. <a href="../index.html" class="title">@urtc/sdk-web</a>
  27. </div>
  28. <div class="table-cell" id="tsd-widgets">
  29. <div id="tsd-filter">
  30. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  31. <div class="tsd-filter-group">
  32. <div class="tsd-select" id="tsd-filter-visibility">
  33. <span class="tsd-select-label">All</span>
  34. <ul class="tsd-select-list">
  35. <li data-value="public">Public</li>
  36. <li data-value="protected">Public/Protected</li>
  37. <li data-value="private" class="selected">All</li>
  38. </ul>
  39. </div>
  40. <input type="checkbox" id="tsd-filter-inherited" checked />
  41. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  42. <input type="checkbox" id="tsd-filter-externals" checked />
  43. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  44. </div>
  45. </div>
  46. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  47. </div>
  48. </div>
  49. </div>
  50. </div>
  51. <div class="tsd-page-title">
  52. <div class="container">
  53. <ul class="tsd-breadcrumb">
  54. <li>
  55. <a href="../index.html">@urtc/sdk-web</a>
  56. </li>
  57. <li>
  58. <a href="playoptions.html">PlayOptions</a>
  59. </li>
  60. </ul>
  61. <h1>Interface PlayOptions</h1>
  62. </div>
  63. </div>
  64. </header>
  65. <div class="container container-main">
  66. <div class="row">
  67. <div class="col-8 col-content">
  68. <section class="tsd-panel tsd-comment">
  69. <div class="tsd-comment tsd-typography">
  70. <div class="lead">
  71. <p>播放器播放属性</p>
  72. </div>
  73. </div>
  74. </section>
  75. <section class="tsd-panel tsd-hierarchy">
  76. <h3>Hierarchy</h3>
  77. <ul class="tsd-hierarchy">
  78. <li>
  79. <span class="target">PlayOptions</span>
  80. </li>
  81. </ul>
  82. </section>
  83. <section class="tsd-panel-group tsd-index-group">
  84. <h2>Index</h2>
  85. <section class="tsd-panel tsd-index-panel">
  86. <div class="tsd-index-content">
  87. <section class="tsd-index-section ">
  88. <h3>Properties</h3>
  89. <ul class="tsd-index-list">
  90. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playoptions.html#controls" class="tsd-kind-icon">controls</a></li>
  91. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playoptions.html#fit" class="tsd-kind-icon">fit</a></li>
  92. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playoptions.html#mirror" class="tsd-kind-icon">mirror</a></li>
  93. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="playoptions.html#mute" class="tsd-kind-icon">mute</a></li>
  94. </ul>
  95. </section>
  96. </div>
  97. </section>
  98. </section>
  99. <section class="tsd-panel-group tsd-member-group ">
  100. <h2>Properties</h2>
  101. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  102. <a name="controls" class="tsd-anchor"></a>
  103. <h3><span class="tsd-flag ts-flagOptional">Optional</span> controls</h3>
  104. <div class="tsd-signature tsd-kind-icon">controls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;show&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;hide&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;auto&quot;</span></div>
  105. <aside class="tsd-sources">
  106. </aside>
  107. <div class="tsd-comment tsd-typography">
  108. <div class="lead">
  109. <p>视频播放时 audio / video 的控制面板的显示模式,默认自动判断(播放失败时显示,播放成功时隐藏)</p>
  110. </div>
  111. </div>
  112. </section>
  113. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  114. <a name="fit" class="tsd-anchor"></a>
  115. <h3><span class="tsd-flag ts-flagOptional">Optional</span> fit</h3>
  116. <div class="tsd-signature tsd-kind-icon">fit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;cover&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;contain&quot;</span></div>
  117. <aside class="tsd-sources">
  118. </aside>
  119. <div class="tsd-comment tsd-typography">
  120. <div class="lead">
  121. <p>视频播放时的<a href="../index.html#playervideofittype">显示模式</a>,默认 &#39;cover&#39;,屏幕共享时默认使用 &#39;contain&#39;</p>
  122. </div>
  123. </div>
  124. </section>
  125. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  126. <a name="mirror" class="tsd-anchor"></a>
  127. <h3><span class="tsd-flag ts-flagOptional">Optional</span> mirror</h3>
  128. <div class="tsd-signature tsd-kind-icon">mirror<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
  129. <aside class="tsd-sources">
  130. </aside>
  131. <div class="tsd-comment tsd-typography">
  132. <div class="lead">
  133. <p>是否镜像播放</p>
  134. </div>
  135. </div>
  136. </section>
  137. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  138. <a name="mute" class="tsd-anchor"></a>
  139. <h3>mute</h3>
  140. <div class="tsd-signature tsd-kind-icon">mute<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
  141. <aside class="tsd-sources">
  142. </aside>
  143. <div class="tsd-comment tsd-typography">
  144. <div class="lead">
  145. <p>是否静音播放</p>
  146. </div>
  147. </div>
  148. </section>
  149. </section>
  150. </div>
  151. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  152. <nav class="tsd-navigation primary">
  153. <ul>
  154. <li class=" ">
  155. <a href="../index.html">Exports</a>
  156. </li>
  157. </ul>
  158. </nav>
  159. <nav class="tsd-navigation secondary menu-sticky">
  160. <ul class="before-current">
  161. </ul>
  162. <ul class="current">
  163. <li class="current tsd-kind-interface">
  164. <a href="playoptions.html" class="tsd-kind-icon">Play<wbr>Options</a>
  165. <ul>
  166. <li class=" tsd-kind-property tsd-parent-kind-interface">
  167. <a href="playoptions.html#controls" class="tsd-kind-icon">controls</a>
  168. </li>
  169. <li class=" tsd-kind-property tsd-parent-kind-interface">
  170. <a href="playoptions.html#fit" class="tsd-kind-icon">fit</a>
  171. </li>
  172. <li class=" tsd-kind-property tsd-parent-kind-interface">
  173. <a href="playoptions.html#mirror" class="tsd-kind-icon">mirror</a>
  174. </li>
  175. <li class=" tsd-kind-property tsd-parent-kind-interface">
  176. <a href="playoptions.html#mute" class="tsd-kind-icon">mute</a>
  177. </li>
  178. </ul>
  179. </li>
  180. </ul>
  181. <ul class="after-current">
  182. </ul>
  183. </nav>
  184. </div>
  185. </div>
  186. </div>
  187. <footer class="with-border-bottom">
  188. <div class="container">
  189. <h2>Legend</h2>
  190. <div class="tsd-legend-group">
  191. <ul class="tsd-legend">
  192. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  193. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  194. </ul>
  195. <ul class="tsd-legend">
  196. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  197. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  198. </ul>
  199. <ul class="tsd-legend">
  200. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  201. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
  202. </ul>
  203. <ul class="tsd-legend">
  204. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  205. </ul>
  206. </div>
  207. </div>
  208. </footer>
  209. <div class="container tsd-generator">
  210. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  211. </div>
  212. <div class="overlay"></div>
  213. <script src="../assets/js/main.js"></script>
  214. </body>
  215. </html>