customvideoprofile.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  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>CustomVideoProfile | @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="customvideoprofile.html">CustomVideoProfile</a>
  59. </li>
  60. </ul>
  61. <h1>Interface CustomVideoProfile</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>自定义视频 Profile,请根据实际使用场景及网络环境,合理的设置</p>
  72. </div>
  73. <dl class="tsd-comment-tags">
  74. <dt>example</dt>
  75. <dd><pre><code class="language-js"><span style="color: #000000">{ width: </span><span style="color: #098658">640</span><span style="color: #000000">, height: </span><span style="color: #098658">480</span><span style="color: #000000">, framerate: </span><span style="color: #098658">15</span><span style="color: #000000">, bitrate: </span><span style="color: #098658">500</span><span style="color: #000000"> }</span>
  76. </code></pre>
  77. </dd>
  78. </dl>
  79. </div>
  80. </section>
  81. <section class="tsd-panel tsd-hierarchy">
  82. <h3>Hierarchy</h3>
  83. <ul class="tsd-hierarchy">
  84. <li>
  85. <span class="target">CustomVideoProfile</span>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="tsd-panel-group tsd-index-group">
  90. <h2>Index</h2>
  91. <section class="tsd-panel tsd-index-panel">
  92. <div class="tsd-index-content">
  93. <section class="tsd-index-section ">
  94. <h3>Properties</h3>
  95. <ul class="tsd-index-list">
  96. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customvideoprofile.html#bitrate" class="tsd-kind-icon">bitrate</a></li>
  97. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customvideoprofile.html#framerate" class="tsd-kind-icon">framerate</a></li>
  98. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customvideoprofile.html#height" class="tsd-kind-icon">height</a></li>
  99. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="customvideoprofile.html#width" class="tsd-kind-icon">width</a></li>
  100. </ul>
  101. </section>
  102. </div>
  103. </section>
  104. </section>
  105. <section class="tsd-panel-group tsd-member-group ">
  106. <h2>Properties</h2>
  107. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  108. <a name="bitrate" class="tsd-anchor"></a>
  109. <h3>bitrate</h3>
  110. <div class="tsd-signature tsd-kind-icon">bitrate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  111. <aside class="tsd-sources">
  112. </aside>
  113. <div class="tsd-comment tsd-typography">
  114. <div class="lead">
  115. <p>码率 (kbps),如:500</p>
  116. </div>
  117. </div>
  118. </section>
  119. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  120. <a name="framerate" class="tsd-anchor"></a>
  121. <h3>framerate</h3>
  122. <div class="tsd-signature tsd-kind-icon">framerate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  123. <aside class="tsd-sources">
  124. </aside>
  125. <div class="tsd-comment tsd-typography">
  126. <div class="lead">
  127. <p>帧率 (fps),如:15</p>
  128. </div>
  129. </div>
  130. </section>
  131. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  132. <a name="height" class="tsd-anchor"></a>
  133. <h3>height</h3>
  134. <div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  135. <aside class="tsd-sources">
  136. </aside>
  137. <div class="tsd-comment tsd-typography">
  138. <div class="lead">
  139. <p>视频高,如:480</p>
  140. </div>
  141. </div>
  142. </section>
  143. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  144. <a name="width" class="tsd-anchor"></a>
  145. <h3>width</h3>
  146. <div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
  147. <aside class="tsd-sources">
  148. </aside>
  149. <div class="tsd-comment tsd-typography">
  150. <div class="lead">
  151. <p>视频宽,如:640</p>
  152. </div>
  153. </div>
  154. </section>
  155. </section>
  156. </div>
  157. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  158. <nav class="tsd-navigation primary">
  159. <ul>
  160. <li class=" ">
  161. <a href="../index.html">Exports</a>
  162. </li>
  163. </ul>
  164. </nav>
  165. <nav class="tsd-navigation secondary menu-sticky">
  166. <ul class="before-current">
  167. </ul>
  168. <ul class="current">
  169. <li class="current tsd-kind-interface">
  170. <a href="customvideoprofile.html" class="tsd-kind-icon">Custom<wbr>Video<wbr>Profile</a>
  171. <ul>
  172. <li class=" tsd-kind-property tsd-parent-kind-interface">
  173. <a href="customvideoprofile.html#bitrate" class="tsd-kind-icon">bitrate</a>
  174. </li>
  175. <li class=" tsd-kind-property tsd-parent-kind-interface">
  176. <a href="customvideoprofile.html#framerate" class="tsd-kind-icon">framerate</a>
  177. </li>
  178. <li class=" tsd-kind-property tsd-parent-kind-interface">
  179. <a href="customvideoprofile.html#height" class="tsd-kind-icon">height</a>
  180. </li>
  181. <li class=" tsd-kind-property tsd-parent-kind-interface">
  182. <a href="customvideoprofile.html#width" class="tsd-kind-icon">width</a>
  183. </li>
  184. </ul>
  185. </li>
  186. </ul>
  187. <ul class="after-current">
  188. </ul>
  189. </nav>
  190. </div>
  191. </div>
  192. </div>
  193. <footer class="with-border-bottom">
  194. <div class="container">
  195. <h2>Legend</h2>
  196. <div class="tsd-legend-group">
  197. <ul class="tsd-legend">
  198. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  199. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  200. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  201. </ul>
  202. <ul class="tsd-legend">
  203. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  204. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  205. </ul>
  206. <ul class="tsd-legend">
  207. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  208. </ul>
  209. <ul class="tsd-legend">
  210. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  211. </ul>
  212. </div>
  213. </div>
  214. </footer>
  215. <div class="container tsd-generator">
  216. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  217. </div>
  218. <div class="overlay"></div>
  219. <script src="../assets/js/main.js"></script>
  220. </body>
  221. </html>