serverconfig.html 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  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>ServerConfig | @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="serverconfig.html">ServerConfig</a>
  59. </li>
  60. </ul>
  61. <h1>Interface ServerConfig</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>服务器配置,可设置置网关(gateway)、信令(signal)、日志(log)服务器地址
  72. 注:</p>
  73. <ol>
  74. <li>gateway 和 signal 须二选一进行设置</li>
  75. <li>没有日志服务器时,log 可不设</li>
  76. </ol>
  77. </div>
  78. </div>
  79. </section>
  80. <section class="tsd-panel tsd-hierarchy">
  81. <h3>Hierarchy</h3>
  82. <ul class="tsd-hierarchy">
  83. <li>
  84. <span class="target">ServerConfig</span>
  85. </li>
  86. </ul>
  87. </section>
  88. <section class="tsd-panel-group tsd-index-group">
  89. <h2>Index</h2>
  90. <section class="tsd-panel tsd-index-panel">
  91. <div class="tsd-index-content">
  92. <section class="tsd-index-section ">
  93. <h3>Properties</h3>
  94. <ul class="tsd-index-list">
  95. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="serverconfig.html#gateway" class="tsd-kind-icon">gateway</a></li>
  96. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="serverconfig.html#log" class="tsd-kind-icon">log</a></li>
  97. <li class="tsd-kind-property tsd-parent-kind-interface"><a href="serverconfig.html#signal" class="tsd-kind-icon">signal</a></li>
  98. </ul>
  99. </section>
  100. </div>
  101. </section>
  102. </section>
  103. <section class="tsd-panel-group tsd-member-group ">
  104. <h2>Properties</h2>
  105. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  106. <a name="gateway" class="tsd-anchor"></a>
  107. <h3><span class="tsd-flag ts-flagOptional">Optional</span> gateway</h3>
  108. <div class="tsd-signature tsd-kind-icon">gateway<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  109. <aside class="tsd-sources">
  110. </aside>
  111. <div class="tsd-comment tsd-typography">
  112. <div class="lead">
  113. <p>网关地址,如 &#39;<a href="https://my-rtc.com.cn&#39;">https://my-rtc.com.cn&#39;</a></p>
  114. </div>
  115. </div>
  116. </section>
  117. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  118. <a name="log" class="tsd-anchor"></a>
  119. <h3><span class="tsd-flag ts-flagOptional">Optional</span> log</h3>
  120. <div class="tsd-signature tsd-kind-icon">log<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  121. <aside class="tsd-sources">
  122. </aside>
  123. <div class="tsd-comment tsd-typography">
  124. <div class="lead">
  125. <p>日志服务器地址,如 &#39;<a href="https://log.my-rtc.com.cn&#39;">https://log.my-rtc.com.cn&#39;</a></p>
  126. </div>
  127. </div>
  128. </section>
  129. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
  130. <a name="signal" class="tsd-anchor"></a>
  131. <h3><span class="tsd-flag ts-flagOptional">Optional</span> signal</h3>
  132. <div class="tsd-signature tsd-kind-icon">signal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  133. <aside class="tsd-sources">
  134. </aside>
  135. <div class="tsd-comment tsd-typography">
  136. <div class="lead">
  137. <p>信令服务器地址,如 &#39;wss://my-rtc.com.cn:5005&#39;</p>
  138. </div>
  139. </div>
  140. </section>
  141. </section>
  142. </div>
  143. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  144. <nav class="tsd-navigation primary">
  145. <ul>
  146. <li class=" ">
  147. <a href="../index.html">Exports</a>
  148. </li>
  149. </ul>
  150. </nav>
  151. <nav class="tsd-navigation secondary menu-sticky">
  152. <ul class="before-current">
  153. </ul>
  154. <ul class="current">
  155. <li class="current tsd-kind-interface">
  156. <a href="serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a>
  157. <ul>
  158. <li class=" tsd-kind-property tsd-parent-kind-interface">
  159. <a href="serverconfig.html#gateway" class="tsd-kind-icon">gateway</a>
  160. </li>
  161. <li class=" tsd-kind-property tsd-parent-kind-interface">
  162. <a href="serverconfig.html#log" class="tsd-kind-icon">log</a>
  163. </li>
  164. <li class=" tsd-kind-property tsd-parent-kind-interface">
  165. <a href="serverconfig.html#signal" class="tsd-kind-icon">signal</a>
  166. </li>
  167. </ul>
  168. </li>
  169. </ul>
  170. <ul class="after-current">
  171. </ul>
  172. </nav>
  173. </div>
  174. </div>
  175. </div>
  176. <footer class="with-border-bottom">
  177. <div class="container">
  178. <h2>Legend</h2>
  179. <div class="tsd-legend-group">
  180. <ul class="tsd-legend">
  181. <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
  182. <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
  183. <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
  184. </ul>
  185. <ul class="tsd-legend">
  186. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
  187. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
  188. </ul>
  189. <ul class="tsd-legend">
  190. <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
  191. </ul>
  192. <ul class="tsd-legend">
  193. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
  194. </ul>
  195. </div>
  196. </div>
  197. </footer>
  198. <div class="container tsd-generator">
  199. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  200. </div>
  201. <div class="overlay"></div>
  202. <script src="../assets/js/main.js"></script>
  203. </body>
  204. </html>