rtcerror.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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>RtcError | @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. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="../index.html" class="title">@urtc/sdk-web</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. </div>
  44. </div>
  45. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  46. </div>
  47. </div>
  48. </div>
  49. </div>
  50. <div class="tsd-page-title">
  51. <div class="container">
  52. <ul class="tsd-breadcrumb">
  53. <li>
  54. <a href="../index.html">Globals</a>
  55. </li>
  56. <li>
  57. <a href="rtcerror.html">RtcError</a>
  58. </li>
  59. </ul>
  60. <h1>Class RtcError</h1>
  61. </div>
  62. </div>
  63. </header>
  64. <div class="container container-main">
  65. <div class="row">
  66. <div class="col-8 col-content">
  67. <section class="tsd-panel tsd-comment">
  68. <div class="tsd-comment tsd-typography">
  69. <div class="lead">
  70. <p>RTC 错误 类型</p>
  71. </div>
  72. <p>通用错误及代码</p>
  73. <ul>
  74. <li>1000 - 非法参数</li>
  75. <li>1001 - 非法操作</li>
  76. <li>1002 - 不支持</li>
  77. <li>1003 - 不存在</li>
  78. <li>1004 - 请求失败</li>
  79. <li>1999 - 其他错误</li>
  80. </ul>
  81. <p>房间相关错误及代码</p>
  82. <ul>
  83. <li>2000 - 网关不可达</li>
  84. <li>2001 - 获取 Access Token 失败</li>
  85. <li>2002 - Access Token 非法</li>
  86. <li>2003 - Websocket 连接失败</li>
  87. <li>2004 - 加入房间失败</li>
  88. <li>2005 - 未加入房间</li>
  89. <li>2006 - 正在加入房间</li>
  90. <li>2007 - 正在离开房间,</li>
  91. <li>2008 - 角色类型不匹配</li>
  92. <li>2009 - 信令服务器地址错误</li>
  93. </ul>
  94. <p>流相关错误及代码</p>
  95. <ul>
  96. <li>3000 - 流不存在</li>
  97. <li>3001 - 同类型的流已存在</li>
  98. <li>3002 - 音频不存在</li>
  99. <li>3003 - 视频不存在</li>
  100. <li>3004 - [中止错误] 尽管用户和操作系统都授予了访问设备硬件的权利,而且未出现可能抛出NotReadableError异常的硬件问题,但仍然有一些问题的出现导致了设备无法被使用。</li>
  101. <li>3005 - [拒绝错误] 用户拒绝了当前的浏览器实例的访问请求;或者用户拒绝了当前会话的访问;或者用户在全局范围内拒绝了所有媒体访问请求。</li>
  102. <li>3006 - [找不到错误] 找不到满足请求参数的媒体类型。</li>
  103. <li>3007 - [无法读取错误] 尽管用户已经授权使用相应的设备,操作系统上某个硬件、浏览器或者网页层面发生的错误导致设备无法被访问。</li>
  104. <li>3008 - [无法满足要求错误] 指定的要求无法被设备满足。</li>
  105. <li>3009 - 流连接失败</li>
  106. <li>3010 - 流正在重连</li>
  107. <li>3011 - 流尚未发布</li>
  108. <li>3012 - 流正在发布</li>
  109. <li>3013 - 流正在取消发布</li>
  110. <li>3014 - 流已经发布</li>
  111. <li>3015 - 流尚未订阅</li>
  112. <li>3016 - 流正在订阅</li>
  113. <li>3017 - 流正在取消订阅</li>
  114. <li>3018 - 流已经订阅</li>
  115. </ul>
  116. </div>
  117. </section>
  118. <section class="tsd-panel tsd-hierarchy">
  119. <h3>Hierarchy</h3>
  120. <ul class="tsd-hierarchy">
  121. <li>
  122. <a href="rtcerror.html#error" class="tsd-signature-type">Error</a>
  123. <ul class="tsd-hierarchy">
  124. <li>
  125. <span class="target">RtcError</span>
  126. </li>
  127. </ul>
  128. </li>
  129. </ul>
  130. </section>
  131. <section class="tsd-panel-group tsd-index-group">
  132. <h2>Index</h2>
  133. <section class="tsd-panel tsd-index-panel">
  134. <div class="tsd-index-content">
  135. <section class="tsd-index-section tsd-is-external">
  136. <h3>Constructors</h3>
  137. <ul class="tsd-index-list">
  138. <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="rtcerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
  139. </ul>
  140. </section>
  141. <section class="tsd-index-section tsd-is-external">
  142. <h3>Properties</h3>
  143. <ul class="tsd-index-list">
  144. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="rtcerror.html#message" class="tsd-kind-icon">message</a></li>
  145. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="rtcerror.html#name" class="tsd-kind-icon">name</a></li>
  146. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="rtcerror.html#stack" class="tsd-kind-icon">stack</a></li>
  147. <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="rtcerror.html#error" class="tsd-kind-icon">Error</a></li>
  148. </ul>
  149. </section>
  150. <section class="tsd-index-section tsd-is-external">
  151. <h3>Methods</h3>
  152. <ul class="tsd-index-list">
  153. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="rtcerror.html#getcode" class="tsd-kind-icon">get<wbr>Code</a></li>
  154. <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="rtcerror.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
  155. </ul>
  156. </section>
  157. </div>
  158. </section>
  159. </section>
  160. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  161. <h2>Constructors</h2>
  162. <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
  163. <a name="constructor" class="tsd-anchor"></a>
  164. <h3>constructor</h3>
  165. <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
  166. <li class="tsd-signature tsd-kind-icon">new <wbr>Rtc<wbr>Error<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="rtcerror.html" class="tsd-signature-type">RtcError</a></li>
  167. </ul>
  168. <ul class="tsd-descriptions">
  169. <li class="tsd-description">
  170. <aside class="tsd-sources">
  171. </aside>
  172. <h4 class="tsd-parameters-title">Parameters</h4>
  173. <ul class="tsd-parameters">
  174. <li>
  175. <h5>code: <span class="tsd-signature-type">number</span></h5>
  176. </li>
  177. <li>
  178. <h5>message: <span class="tsd-signature-type">string</span></h5>
  179. </li>
  180. </ul>
  181. <h4 class="tsd-returns-title">Returns <a href="rtcerror.html" class="tsd-signature-type">RtcError</a></h4>
  182. </li>
  183. </ul>
  184. </section>
  185. </section>
  186. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  187. <h2>Properties</h2>
  188. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  189. <a name="message" class="tsd-anchor"></a>
  190. <h3>message</h3>
  191. <div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  192. <aside class="tsd-sources">
  193. <p>Inherited from <a href="rtcerror.html">RtcError</a>.<a href="rtcerror.html#message">message</a></p>
  194. </aside>
  195. </section>
  196. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  197. <a name="name" class="tsd-anchor"></a>
  198. <h3>name</h3>
  199. <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
  200. <aside class="tsd-sources">
  201. <p>Inherited from <a href="rtcerror.html">RtcError</a>.<a href="rtcerror.html#name">name</a></p>
  202. </aside>
  203. </section>
  204. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external">
  205. <a name="stack" class="tsd-anchor"></a>
  206. <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
  207. <div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
  208. <aside class="tsd-sources">
  209. <p>Inherited from <a href="rtcerror.html">RtcError</a>.<a href="rtcerror.html#stack">stack</a></p>
  210. <p>Overrides <a href="rtcerror.html">RtcError</a>.<a href="rtcerror.html#stack">stack</a></p>
  211. </aside>
  212. </section>
  213. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
  214. <a name="error" class="tsd-anchor"></a>
  215. <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
  216. <div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
  217. <aside class="tsd-sources">
  218. </aside>
  219. </section>
  220. </section>
  221. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  222. <h2>Methods</h2>
  223. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
  224. <a name="getcode" class="tsd-anchor"></a>
  225. <h3>get<wbr>Code</h3>
  226. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
  227. <li class="tsd-signature tsd-kind-icon">get<wbr>Code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
  228. </ul>
  229. <ul class="tsd-descriptions">
  230. <li class="tsd-description">
  231. <aside class="tsd-sources">
  232. </aside>
  233. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
  234. </li>
  235. </ul>
  236. </section>
  237. <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
  238. <a name="tostring" class="tsd-anchor"></a>
  239. <h3>to<wbr>String</h3>
  240. <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
  241. <li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
  242. </ul>
  243. <ul class="tsd-descriptions">
  244. <li class="tsd-description">
  245. <aside class="tsd-sources">
  246. </aside>
  247. <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
  248. </li>
  249. </ul>
  250. </section>
  251. </section>
  252. </div>
  253. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  254. <nav class="tsd-navigation primary">
  255. <ul>
  256. <li class="globals ">
  257. <a href="../index.html"><em>Globals</em></a>
  258. </li>
  259. </ul>
  260. </nav>
  261. <nav class="tsd-navigation secondary menu-sticky">
  262. <ul class="before-current">
  263. </ul>
  264. <ul class="current">
  265. <li class="current tsd-kind-class tsd-is-external">
  266. <a href="rtcerror.html" class="tsd-kind-icon">Rtc<wbr>Error</a>
  267. <ul>
  268. <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
  269. <a href="rtcerror.html#constructor" class="tsd-kind-icon">constructor</a>
  270. </li>
  271. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  272. <a href="rtcerror.html#message" class="tsd-kind-icon">message</a>
  273. </li>
  274. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
  275. <a href="rtcerror.html#name" class="tsd-kind-icon">name</a>
  276. </li>
  277. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external">
  278. <a href="rtcerror.html#stack" class="tsd-kind-icon">stack</a>
  279. </li>
  280. <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
  281. <a href="rtcerror.html#error" class="tsd-kind-icon">Error</a>
  282. </li>
  283. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
  284. <a href="rtcerror.html#getcode" class="tsd-kind-icon">get<wbr>Code</a>
  285. </li>
  286. <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
  287. <a href="rtcerror.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
  288. </li>
  289. </ul>
  290. </li>
  291. </ul>
  292. <ul class="after-current">
  293. </ul>
  294. </nav>
  295. </div>
  296. </div>
  297. </div>
  298. <footer class="with-border-bottom">
  299. <div class="container">
  300. <h2>Legend</h2>
  301. <div class="tsd-legend-group">
  302. </div>
  303. </div>
  304. </footer>
  305. <div class="container tsd-generator">
  306. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  307. </div>
  308. <div class="overlay"></div>
  309. <script src="../assets/js/main.js"></script>
  310. </body>
  311. </html>