@realsee/live 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/README.md +51 -56
  2. package/docs/.nojekyll +1 -0
  3. package/docs/assets/custom.css +43 -0
  4. package/docs/assets/highlight.css +127 -0
  5. package/docs/assets/icons.css +1043 -0
  6. package/docs/assets/{images/icons.png → icons.png} +0 -0
  7. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  8. package/docs/assets/main.js +52 -0
  9. package/docs/assets/search.js +1 -0
  10. package/docs/assets/style.css +1388 -0
  11. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  12. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  13. package/docs/classes/RTCProtocol.RTCExample.html +62 -814
  14. package/docs/classes/RTCProtocol.VRWebViewRTC.html +60 -0
  15. package/docs/classes/shared_utils.Subscribe.html +55 -596
  16. package/docs/enums/RTCProtocol.RTCJoinedInfoCodeEnum.html +9 -0
  17. package/docs/enums/RTCProtocol.RTCType.html +1 -185
  18. package/docs/enums/live.BuiltinActionType.html +15 -325
  19. package/docs/enums/live.BuiltinEventType.html +7 -268
  20. package/docs/enums/live.Command.html +7 -346
  21. package/docs/enums/live.MemUserStatus.html +1 -307
  22. package/docs/enums/live.MicroStatus.html +3 -258
  23. package/docs/enums/live.UserStatus.html +9 -287
  24. package/docs/enums/live.WebSocketCloseError.html +19 -382
  25. package/docs/enums/live.WebSocketErrorType.html +1 -307
  26. package/docs/enums/live.WebSocketState.html +13 -325
  27. package/docs/index.html +327 -512
  28. package/docs/interfaces/RTCProtocol.GetVoiceSignReturnType.html +1 -0
  29. package/docs/interfaces/RTCProtocol.RTCJoinedInfo.html +1 -0
  30. package/docs/interfaces/RTCProtocol.RTCProtocol-1.html +60 -765
  31. package/docs/interfaces/RTCProtocol.VRWebViewRTCOptions.html +1 -0
  32. package/docs/interfaces/live.Live.html +119 -1302
  33. package/docs/interfaces/live.LiveOptions.html +22 -499
  34. package/docs/interfaces/live.LiveReact.html +52 -984
  35. package/docs/modules/RTCProtocol.html +17 -361
  36. package/docs/modules/live.html +103 -1219
  37. package/docs/modules/shared_utils.html +10 -248
  38. package/docs/modules.html +1 -125
  39. package/lib/RTC/BrowserRTC.d.ts +30 -0
  40. package/lib/RTC/BrowserRTC.js +163 -0
  41. package/lib/RTC/BrowserRTC.js.map +1 -0
  42. package/lib/RTC/VRWebViewRTC.d.ts +23 -0
  43. package/lib/RTC/VRWebViewRTC.js +124 -0
  44. package/lib/RTC/VRWebViewRTC.js.map +1 -0
  45. package/lib/RTC/index.d.ts +22 -0
  46. package/lib/{RTCProtocol → RTC}/index.js +3 -7
  47. package/lib/RTC/index.js.map +1 -0
  48. package/lib/createLive.d.ts +1 -1
  49. package/lib/createLive.js +50 -22
  50. package/lib/createLive.js.map +1 -1
  51. package/lib/createLiveReact.d.ts +11 -10
  52. package/lib/createLiveReact.js +4 -6
  53. package/lib/createLiveReact.js.map +1 -1
  54. package/lib/shared-utils/Subscribe.d.ts +1 -1
  55. package/lib/typings/EventType.d.ts +10 -0
  56. package/lib/typings/GetVoiceSign.d.ts +11 -0
  57. package/lib/typings/GetVoiceSign.js +3 -0
  58. package/lib/typings/GetVoiceSign.js.map +1 -0
  59. package/lib/typings/Live.d.ts +6 -4
  60. package/lib/typings/LiveMsg.d.ts +4 -0
  61. package/lib/typings/LiveMsg.js +4 -0
  62. package/lib/typings/LiveMsg.js.map +1 -1
  63. package/lib/typings/LiveOptions.d.ts +3 -7
  64. package/lib/typings/RTCEventType.d.ts +2 -14
  65. package/lib/typings/RTCEventType.js +0 -7
  66. package/lib/typings/RTCEventType.js.map +1 -1
  67. package/lib/typings/RTCJoinedInfo.d.ts +28 -0
  68. package/lib/typings/RTCJoinedInfo.js +23 -0
  69. package/lib/typings/RTCJoinedInfo.js.map +1 -0
  70. package/lib/{RTCProtocol/index.d.ts → typings/RTCProtocol.d.ts} +1 -19
  71. package/lib/typings/RTCProtocol.js +9 -0
  72. package/lib/typings/RTCProtocol.js.map +1 -0
  73. package/lib/typings/VRWebViewRTCOptions.d.ts +6 -0
  74. package/lib/typings/VRWebViewRTCOptions.js +3 -0
  75. package/lib/typings/VRWebViewRTCOptions.js.map +1 -0
  76. package/lib/typings/WebSocket.d.ts +2 -1
  77. package/lib/typings/WebSocket.js +1 -0
  78. package/lib/typings/WebSocket.js.map +1 -1
  79. package/package.json +8 -4
  80. package/umd/{RTCProtocol.046933a5.js → RTCProtocol.543610f0.js} +1 -1
  81. package/umd/createLive.a6edf473.js +1 -0
  82. package/umd/createLiveReact.e21b4514.js +1 -0
  83. package/docs/assets/css/main.css +0 -2787
  84. package/docs/assets/js/main.js +0 -248
  85. package/docs/assets/js/search.js +0 -1
  86. package/lib/RTCProtocol/index.js.map +0 -1
  87. package/umd/createLive.6845145e.js +0 -1
  88. package/umd/createLiveReact.406cf5a3.js +0 -1
package/docs/modules/live.html CHANGED
@@ -1,1219 +1,103 @@
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>live | 如视 Live SDK - v0.1.1</title>
7
- <meta name="description" content="Documentation for 如视 Live SDK - v0.1.1">
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">如视 Live SDK - v0.1.1</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
- </div>
43
- </div>
44
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
45
- </div>
46
- </div>
47
- </div>
48
- </div>
49
- <div class="tsd-page-title">
50
- <div class="container">
51
- <ul class="tsd-breadcrumb">
52
- <li>
53
- <a href="../modules.html">如视 Live SDK - v0.1.1</a>
54
- </li>
55
- <li>
56
- <a href="live.html">live</a>
57
- </li>
58
- </ul>
59
- <h1>Module live</h1>
60
- </div>
61
- </div>
62
- </header>
63
- <div class="container container-main">
64
- <div class="row">
65
- <div class="col-8 col-content">
66
- <section class="tsd-panel-group tsd-index-group">
67
- <h2>Index</h2>
68
- <section class="tsd-panel tsd-index-panel">
69
- <div class="tsd-index-content">
70
- <section class="tsd-index-section ">
71
- <h3>Enumerations</h3>
72
- <ul class="tsd-index-list">
73
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr>Action<wbr>Type</a></li>
74
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr>Event<wbr>Type</a></li>
75
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.Command.html" class="tsd-kind-icon">Command</a></li>
76
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.MemUserStatus.html" class="tsd-kind-icon">Mem<wbr>User<wbr>Status</a></li>
77
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.MicroStatus.html" class="tsd-kind-icon">Micro<wbr>Status</a></li>
78
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.UserStatus.html" class="tsd-kind-icon">User<wbr>Status</a></li>
79
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Close<wbr>Error</a></li>
80
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error<wbr>Type</a></li>
81
- <li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketState.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>State</a></li>
82
- </ul>
83
- </section>
84
- <section class="tsd-index-section ">
85
- <h3>Interfaces</h3>
86
- <ul class="tsd-index-list">
87
- <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/live.Live.html" class="tsd-kind-icon">Live</a></li>
88
- <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/live.LiveOptions.html" class="tsd-kind-icon">Live<wbr>Options</a></li>
89
- <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/live.LiveReact.html" class="tsd-kind-icon">Live<wbr>React</a></li>
90
- </ul>
91
- </section>
92
- <section class="tsd-index-section ">
93
- <h3>Type aliases</h3>
94
- <ul class="tsd-index-list">
95
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr>Msg</a></li>
96
- <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#EventType" class="tsd-kind-icon">Event<wbr>Type</a></li>
97
- <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveActionReactCallback" class="tsd-kind-icon">Live<wbr>Action<wbr>React<wbr>Callback</a></li>
98
- <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveEventType" class="tsd-kind-icon">Live<wbr>Event<wbr>Type</a></li>
99
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#LiveMsg" class="tsd-kind-icon">Live<wbr>Msg</a></li>
100
- <li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveProviderPropTypes" class="tsd-kind-icon">Live<wbr>Provider<wbr>Prop<wbr>Types</a></li>
101
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#ReqLiveMsg" class="tsd-kind-icon">Req<wbr>Live<wbr>Msg</a></li>
102
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#RoomInfo" class="tsd-kind-icon">Room<wbr>Info</a></li>
103
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#UserInfo" class="tsd-kind-icon">User<wbr>Info</a></li>
104
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#UserInfoExt" class="tsd-kind-icon">User<wbr>Info<wbr>Ext</a></li>
105
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#WebSocketError" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error</a></li>
106
- <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#WebSocketEventType" class="tsd-kind-icon">Web<wbr>Socket<wbr>Event<wbr>Type</a></li>
107
- </ul>
108
- </section>
109
- <section class="tsd-index-section ">
110
- <h3>Functions</h3>
111
- <ul class="tsd-index-list">
112
- <li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#createLive" class="tsd-kind-icon">create<wbr>Live</a></li>
113
- <li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#createLiveReact" class="tsd-kind-icon">create<wbr>Live<wbr>React</a></li>
114
- <li class="tsd-kind-function tsd-parent-kind-module"><a href="live.html#parseLiveMsg" class="tsd-kind-icon">parse<wbr>Live<wbr>Msg</a></li>
115
- </ul>
116
- </section>
117
- </div>
118
- </section>
119
- </section>
120
- <section class="tsd-panel-group tsd-member-group ">
121
- <h2>Type aliases</h2>
122
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
123
- <a name="BuiltinMsg" class="tsd-anchor"></a>
124
- <h3>Builtin<wbr>Msg</h3>
125
- <div class="tsd-signature tsd-kind-icon">Builtin<wbr>Msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>action<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinActionType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinActionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>extension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>event_type<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinEventType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinEventType</a><span class="tsd-signature-symbol">; </span>to_user_ids<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></div>
126
- <aside class="tsd-sources">
127
- <ul>
128
- <li>Defined in typings/LiveMsg.ts:93</li>
129
- </ul>
130
- </aside>
131
- <div class="tsd-comment tsd-typography">
132
- <div class="lead">
133
- <p>内置事件数据结构体。</p>
134
- </div>
135
- </div>
136
- <div class="tsd-type-declaration">
137
- <h4>Type declaration</h4>
138
- <ul class="tsd-parameters">
139
- <li class="tsd-parameter">
140
- <h5>action<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinActionType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinActionType</a></h5>
141
- </li>
142
- <li class="tsd-parameter">
143
- <h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>extension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></h5>
144
- <ul class="tsd-parameters">
145
- <li class="tsd-parameter-index-signature">
146
- <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
147
- </li>
148
- <li class="tsd-parameter">
149
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> extension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
150
- </li>
151
- </ul>
152
- </li>
153
- <li class="tsd-parameter">
154
- <h5>event_<wbr>type<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinEventType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinEventType</a></h5>
155
- </li>
156
- <li class="tsd-parameter">
157
- <h5>to_<wbr>user_<wbr>ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
158
- </li>
159
- </ul>
160
- </div>
161
- </section>
162
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
163
- <a name="EventType" class="tsd-anchor"></a>
164
- <h3>Event<wbr>Type</h3>
165
- <div class="tsd-signature tsd-kind-icon">Event<wbr>Type&lt;Snapshot&gt;<span class="tsd-signature-symbol">:</span> <a href="live.html#LiveEventType" class="tsd-signature-type" data-tsd-kind="Type alias">LiveEventType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><a href="live.html#WebSocketEventType" class="tsd-signature-type" data-tsd-kind="Type alias">WebSocketEventType</a></div>
166
- <aside class="tsd-sources">
167
- <ul>
168
- <li>Defined in typings/EventType.ts:85</li>
169
- </ul>
170
- </aside>
171
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
172
- <ul class="tsd-type-parameters">
173
- <li>
174
- <h4>Snapshot</h4>
175
- </li>
176
- </ul>
177
- </section>
178
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
179
- <a name="LiveActionReactCallback" class="tsd-anchor"></a>
180
- <h3>Live<wbr>Action<wbr>React<wbr>Callback</h3>
181
- <div class="tsd-signature tsd-kind-icon">Live<wbr>Action<wbr>React<wbr>Callback&lt;Snapshot, TicketArgs&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;broadcast&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;exit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;kick&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;toggleMicro&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;forbidMicro&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;sendKeyframe&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getFramesByKey&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;setSelfInfo&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;updateStatus&quot;</span><span class="tsd-signature-symbol">&gt;</span></div>
182
- <aside class="tsd-sources">
183
- <ul>
184
- <li>Defined in typings/Live.ts:138</li>
185
- </ul>
186
- </aside>
187
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
188
- <ul class="tsd-type-parameters">
189
- <li>
190
- <h4>Snapshot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
191
- </li>
192
- <li>
193
- <h4>TicketArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
194
- </li>
195
- </ul>
196
- </section>
197
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
198
- <a name="LiveEventType" class="tsd-anchor"></a>
199
- <h3>Live<wbr>Event<wbr>Type</h3>
200
- <div class="tsd-signature tsd-kind-icon">Live<wbr>Event<wbr>Type&lt;Snapshot&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>broadcast<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>builtinEvent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>keyframes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>kickOut<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>readyKeyframeSync<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>selfInfoUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>userListUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div>
201
- <aside class="tsd-sources">
202
- <ul>
203
- <li>Defined in typings/EventType.ts:35</li>
204
- </ul>
205
- </aside>
206
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
207
- <ul class="tsd-type-parameters">
208
- <li>
209
- <h4>Snapshot</h4>
210
- </li>
211
- </ul>
212
- <div class="tsd-type-declaration">
213
- <h4>Type declaration</h4>
214
- <ul class="tsd-parameters">
215
- <li class="tsd-parameter">
216
- <h5>broadcast<span class="tsd-signature-symbol">: </span>function</h5>
217
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
218
- <li class="tsd-signature tsd-kind-icon">broadcast<span class="tsd-signature-symbol">(</span>evtMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>, frontRequestId<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><span class="tsd-signature-type">void</span></li>
219
- </ul>
220
- <ul class="tsd-descriptions">
221
- <li class="tsd-description">
222
- <aside class="tsd-sources">
223
- <ul>
224
- <li>Defined in typings/EventType.ts:46</li>
225
- </ul>
226
- </aside>
227
- <div class="tsd-comment tsd-typography">
228
- <div class="lead">
229
- <p>收到其他用户的广播消息。</p>
230
- </div>
231
- </div>
232
- <h4 class="tsd-parameters-title">Parameters</h4>
233
- <ul class="tsd-parameters">
234
- <li>
235
- <h5>evtMsg: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
236
- <div class="tsd-comment tsd-typography">
237
- </div>
238
- </li>
239
- <li>
240
- <h5>frontRequestId: <span class="tsd-signature-type">string</span></h5>
241
- </li>
242
- </ul>
243
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
244
- </li>
245
- </ul>
246
- </li>
247
- <li class="tsd-parameter">
248
- <h5>builtin<wbr>Event<span class="tsd-signature-symbol">: </span>function</h5>
249
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
250
- <li class="tsd-signature tsd-kind-icon">builtin<wbr>Event<span class="tsd-signature-symbol">(</span>builtinMsg<span class="tsd-signature-symbol">: </span><a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
251
- </ul>
252
- <ul class="tsd-descriptions">
253
- <li class="tsd-description">
254
- <aside class="tsd-sources">
255
- <ul>
256
- <li>Defined in typings/EventType.ts:40</li>
257
- </ul>
258
- </aside>
259
- <div class="tsd-comment tsd-typography">
260
- <div class="lead">
261
- <p>内置消息事件</p>
262
- </div>
263
- </div>
264
- <h4 class="tsd-parameters-title">Parameters</h4>
265
- <ul class="tsd-parameters">
266
- <li>
267
- <h5>builtinMsg: <a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a></h5>
268
- <div class="tsd-comment tsd-typography">
269
- </div>
270
- </li>
271
- </ul>
272
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
273
- </li>
274
- </ul>
275
- </li>
276
- <li class="tsd-parameter">
277
- <h5>error<span class="tsd-signature-symbol">: </span>function</h5>
278
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
279
- <li class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">(</span>liveMsg<span class="tsd-signature-symbol">: </span><a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
280
- </ul>
281
- <ul class="tsd-descriptions">
282
- <li class="tsd-description">
283
- <aside class="tsd-sources">
284
- <ul>
285
- <li>Defined in typings/EventType.ts:77</li>
286
- </ul>
287
- </aside>
288
- <div class="tsd-comment tsd-typography">
289
- <div class="lead">
290
- <p>异常消息：不符合规范。</p>
291
- </div>
292
- </div>
293
- <h4 class="tsd-parameters-title">Parameters</h4>
294
- <ul class="tsd-parameters">
295
- <li>
296
- <h5>liveMsg: <a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a></h5>
297
- <div class="tsd-comment tsd-typography">
298
- </div>
299
- </li>
300
- </ul>
301
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
302
- </li>
303
- </ul>
304
- </li>
305
- <li class="tsd-parameter">
306
- <h5>keyframes<span class="tsd-signature-symbol">: </span>function</h5>
307
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
308
- <li class="tsd-signature tsd-kind-icon">keyframes<span class="tsd-signature-symbol">(</span>keyframes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">&gt;</span>, frontRequestId<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><span class="tsd-signature-type">void</span></li>
309
- </ul>
310
- <ul class="tsd-descriptions">
311
- <li class="tsd-description">
312
- <aside class="tsd-sources">
313
- <ul>
314
- <li>Defined in typings/EventType.ts:57</li>
315
- </ul>
316
- </aside>
317
- <div class="tsd-comment tsd-typography">
318
- <div class="lead">
319
- <p>获取其他用户输送的帧数据：根据此帧数据更新UI状态。</p>
320
- </div>
321
- </div>
322
- <h4 class="tsd-parameters-title">Parameters</h4>
323
- <ul class="tsd-parameters">
324
- <li>
325
- <h5>keyframes: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></h5>
326
- <div class="tsd-comment tsd-typography">
327
- </div>
328
- </li>
329
- <li>
330
- <h5>frontRequestId: <span class="tsd-signature-type">string</span></h5>
331
- </li>
332
- </ul>
333
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
334
- </li>
335
- </ul>
336
- </li>
337
- <li class="tsd-parameter">
338
- <h5>kick<wbr>Out<span class="tsd-signature-symbol">: </span>function</h5>
339
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
340
- <li class="tsd-signature tsd-kind-icon">kick<wbr>Out<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
341
- </ul>
342
- <ul class="tsd-descriptions">
343
- <li class="tsd-description">
344
- <aside class="tsd-sources">
345
- <ul>
346
- <li>Defined in typings/EventType.ts:72</li>
347
- </ul>
348
- </aside>
349
- <div class="tsd-comment tsd-typography">
350
- <div class="lead">
351
- <p>被踢出房间</p>
352
- </div>
353
- </div>
354
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
355
- </li>
356
- </ul>
357
- </li>
358
- <li class="tsd-parameter">
359
- <h5>ready<wbr>Keyframe<wbr>Sync<span class="tsd-signature-symbol">: </span>function</h5>
360
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
361
- <li class="tsd-signature tsd-kind-icon">ready<wbr>Keyframe<wbr>Sync<span class="tsd-signature-symbol">(</span>lastKeyframe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
362
- </ul>
363
- <ul class="tsd-descriptions">
364
- <li class="tsd-description">
365
- <aside class="tsd-sources">
366
- <ul>
367
- <li>Defined in typings/EventType.ts:52</li>
368
- </ul>
369
- </aside>
370
- <div class="tsd-comment tsd-typography">
371
- <div class="lead">
372
- <p>带看已经就绪，可以发送帧数据。</p>
373
- </div>
374
- </div>
375
- <h4 class="tsd-parameters-title">Parameters</h4>
376
- <ul class="tsd-parameters">
377
- <li>
378
- <h5>lastKeyframe: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></h5>
379
- <div class="tsd-comment tsd-typography">
380
- <p>带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。</p>
381
- </div>
382
- </li>
383
- </ul>
384
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
385
- </li>
386
- </ul>
387
- </li>
388
- <li class="tsd-parameter">
389
- <h5>self<wbr>Info<wbr>Update<span class="tsd-signature-symbol">: </span>function</h5>
390
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
391
- <li class="tsd-signature tsd-kind-icon">self<wbr>Info<wbr>Update<span class="tsd-signature-symbol">(</span>userInfo<span class="tsd-signature-symbol">: </span><a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a>, frontRequestId<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><span class="tsd-signature-type">void</span></li>
392
- </ul>
393
- <ul class="tsd-descriptions">
394
- <li class="tsd-description">
395
- <aside class="tsd-sources">
396
- <ul>
397
- <li>Defined in typings/EventType.ts:62</li>
398
- </ul>
399
- </aside>
400
- <div class="tsd-comment tsd-typography">
401
- <div class="lead">
402
- <p>个人信息发生更新。</p>
403
- </div>
404
- </div>
405
- <h4 class="tsd-parameters-title">Parameters</h4>
406
- <ul class="tsd-parameters">
407
- <li>
408
- <h5>userInfo: <a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a></h5>
409
- <div class="tsd-comment tsd-typography">
410
- </div>
411
- </li>
412
- <li>
413
- <h5>frontRequestId: <span class="tsd-signature-type">string</span></h5>
414
- </li>
415
- </ul>
416
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
417
- </li>
418
- </ul>
419
- </li>
420
- <li class="tsd-parameter">
421
- <h5>user<wbr>List<wbr>Update<span class="tsd-signature-symbol">: </span>function</h5>
422
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
423
- <li class="tsd-signature tsd-kind-icon">user<wbr>List<wbr>Update<span class="tsd-signature-symbol">(</span>userList<span class="tsd-signature-symbol">: </span><a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a><span class="tsd-signature-symbol">[]</span>, frontRequestId<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><span class="tsd-signature-type">void</span></li>
424
- </ul>
425
- <ul class="tsd-descriptions">
426
- <li class="tsd-description">
427
- <aside class="tsd-sources">
428
- <ul>
429
- <li>Defined in typings/EventType.ts:67</li>
430
- </ul>
431
- </aside>
432
- <div class="tsd-comment tsd-typography">
433
- <div class="lead">
434
- <p>用户列表更新。</p>
435
- </div>
436
- </div>
437
- <h4 class="tsd-parameters-title">Parameters</h4>
438
- <ul class="tsd-parameters">
439
- <li>
440
- <h5>userList: <a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a><span class="tsd-signature-symbol">[]</span></h5>
441
- <div class="tsd-comment tsd-typography">
442
- </div>
443
- </li>
444
- <li>
445
- <h5>frontRequestId: <span class="tsd-signature-type">string</span></h5>
446
- </li>
447
- </ul>
448
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
449
- </li>
450
- </ul>
451
- </li>
452
- </ul>
453
- </div>
454
- </section>
455
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
456
- <a name="LiveMsg" class="tsd-anchor"></a>
457
- <h3>Live<wbr>Msg</h3>
458
- <div class="tsd-signature tsd-kind-icon">Live<wbr>Msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>frontRequestId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>requestId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>roomCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>triggerUserId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
459
- <aside class="tsd-sources">
460
- <ul>
461
- <li>Defined in typings/LiveMsg.ts:114</li>
462
- </ul>
463
- </aside>
464
- <div class="tsd-comment tsd-typography">
465
- <div class="lead">
466
- <p>响应的信息结构体。</p>
467
- </div>
468
- </div>
469
- <div class="tsd-type-declaration">
470
- <h4>Type declaration</h4>
471
- <ul class="tsd-parameters">
472
- <li class="tsd-parameter">
473
- <h5>app<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
474
- </li>
475
- <li class="tsd-parameter">
476
- <h5>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
477
- </li>
478
- <li class="tsd-parameter">
479
- <h5>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a></h5>
480
- </li>
481
- <li class="tsd-parameter">
482
- <h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5>
483
- </li>
484
- <li class="tsd-parameter">
485
- <h5>front<wbr>Request<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
486
- </li>
487
- <li class="tsd-parameter">
488
- <h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
489
- </li>
490
- <li class="tsd-parameter">
491
- <h5>request<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
492
- </li>
493
- <li class="tsd-parameter">
494
- <h5>room<wbr>Code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
495
- </li>
496
- <li class="tsd-parameter">
497
- <h5>trigger<wbr>User<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
498
- </li>
499
- </ul>
500
- </div>
501
- </section>
502
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
503
- <a name="LiveProviderPropTypes" class="tsd-anchor"></a>
504
- <h3>Live<wbr>Provider<wbr>Prop<wbr>Types</h3>
505
- <div class="tsd-signature tsd-kind-icon">Live<wbr>Provider<wbr>Prop<wbr>Types&lt;Snapshot, TicketArgs&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">React.ReactNode</span><span class="tsd-signature-symbol">; </span>live<span class="tsd-signature-symbol">?: </span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></div>
506
- <aside class="tsd-sources">
507
- <ul>
508
- <li>Defined in createLiveReact.tsx:13</li>
509
- </ul>
510
- </aside>
511
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
512
- <ul class="tsd-type-parameters">
513
- <li>
514
- <h4>Snapshot</h4>
515
- </li>
516
- <li>
517
- <h4>TicketArgs</h4>
518
- </li>
519
- </ul>
520
- <div class="tsd-type-declaration">
521
- <h4>Type declaration</h4>
522
- <ul class="tsd-parameters">
523
- <li class="tsd-parameter">
524
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> children<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">React.ReactNode</span></h5>
525
- </li>
526
- <li class="tsd-parameter">
527
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> live<span class="tsd-signature-symbol">?: </span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span></h5>
528
- </li>
529
- </ul>
530
- </div>
531
- </section>
532
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
533
- <a name="ReqLiveMsg" class="tsd-anchor"></a>
534
- <h3>Req<wbr>Live<wbr>Msg</h3>
535
- <div class="tsd-signature tsd-kind-icon">Req<wbr>Live<wbr>Msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>to_user_ids<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><span class="tsd-signature-symbol">; </span>front_request_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
536
- <aside class="tsd-sources">
537
- <ul>
538
- <li>Defined in typings/LiveMsg.ts:28</li>
539
- </ul>
540
- </aside>
541
- <div class="tsd-comment tsd-typography">
542
- <div class="lead">
543
- <p>向服务端请求数据时的数据格式。</p>
544
- </div>
545
- </div>
546
- <div class="tsd-type-declaration">
547
- <h4>Type declaration</h4>
548
- <ul class="tsd-parameters">
549
- <li class="tsd-parameter">
550
- <h5>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a></h5>
551
- <div class="tsd-comment tsd-typography">
552
- <div class="lead">
553
- <p>请求指令。</p>
554
- </div>
555
- </div>
556
- </li>
557
- <li class="tsd-parameter">
558
- <h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>to_user_ids<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></h5>
559
- <div class="tsd-comment tsd-typography">
560
- <div class="lead">
561
- <p>数据内容</p>
562
- </div>
563
- </div>
564
- <ul class="tsd-parameters">
565
- <li class="tsd-parameter-index-signature">
566
- <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
567
- </li>
568
- <li class="tsd-parameter">
569
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> to_<wbr>user_<wbr>ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
570
- <div class="tsd-comment tsd-typography">
571
- <div class="lead">
572
- <p>如果此数据仅发送给某些用户，请提供这些用户的ucid。</p>
573
- </div>
574
- </div>
575
- </li>
576
- </ul>
577
- </li>
578
- <li class="tsd-parameter">
579
- <h5>front_<wbr>request_<wbr>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
580
- <div class="tsd-comment tsd-typography">
581
- <div class="lead">
582
- <p>前端请求时生成的uuid()。</p>
583
- </div>
584
- </div>
585
- </li>
586
- </ul>
587
- </div>
588
- </section>
589
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
590
- <a name="RoomInfo" class="tsd-anchor"></a>
591
- <h3>Room<wbr>Info</h3>
592
- <div class="tsd-signature tsd-kind-icon">Room<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>init_timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>last_frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></div>
593
- <aside class="tsd-sources">
594
- <ul>
595
- <li>Defined in typings/RoomInfo.ts:1</li>
596
- </ul>
597
- </aside>
598
- <div class="tsd-type-declaration">
599
- <h4>Type declaration</h4>
600
- <ul class="tsd-parameters">
601
- <li class="tsd-parameter">
602
- <h5>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
603
- <ul class="tsd-parameters">
604
- <li class="tsd-parameter">
605
- <h5>app_<wbr>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
606
- </li>
607
- <li class="tsd-parameter">
608
- <h5>create_<wbr>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
609
- </li>
610
- <li class="tsd-parameter">
611
- <h5>create_<wbr>user_<wbr>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
612
- </li>
613
- <li class="tsd-parameter">
614
- <h5>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
615
- </li>
616
- <li class="tsd-parameter">
617
- <h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
618
- </li>
619
- <li class="tsd-parameter">
620
- <h5>room_<wbr>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
621
- </li>
622
- <li class="tsd-parameter">
623
- <h5>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
624
- </li>
625
- </ul>
626
- </li>
627
- <li class="tsd-parameter">
628
- <h5>init_<wbr>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
629
- </li>
630
- <li class="tsd-parameter">
631
- <h5>last_<wbr>frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
632
- </li>
633
- </ul>
634
- </div>
635
- </section>
636
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
637
- <a name="UserInfo" class="tsd-anchor"></a>
638
- <h3>User<wbr>Info</h3>
639
- <div class="tsd-signature tsd-kind-icon">User<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>current_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">?: </span><a href="live.html#UserInfoExt" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfoExt</a><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mem_user_status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.MemUserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">MemUserStatus</a><span class="tsd-signature-symbol">; </span>micro_status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>once_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>rtc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.UserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">UserStatus</a><span class="tsd-signature-symbol">; </span>user_role<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
640
- <aside class="tsd-sources">
641
- <ul>
642
- <li>Defined in typings/UserInfo.ts:49</li>
643
- </ul>
644
- </aside>
645
- <div class="tsd-comment tsd-typography">
646
- <div class="lead">
647
- <p>带看会话房间用户的信息格式。</p>
648
- </div>
649
- </div>
650
- <div class="tsd-type-declaration">
651
- <h4>Type declaration</h4>
652
- <ul class="tsd-parameters">
653
- <li class="tsd-parameter">
654
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> current_<wbr>ws_<wbr>online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
655
- <div class="tsd-comment tsd-typography">
656
- <div class="lead">
657
- <p>用户当前是否在线。</p>
658
- </div>
659
- </div>
660
- </li>
661
- <li class="tsd-parameter">
662
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> extension<span class="tsd-signature-symbol">?: </span><a href="live.html#UserInfoExt" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfoExt</a></h5>
663
- <div class="tsd-comment tsd-typography">
664
- <div class="lead">
665
- <p>用户信息扩展字段。</p>
666
- </div>
667
- </div>
668
- </li>
669
- <li class="tsd-parameter">
670
- <h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
671
- <div class="tsd-comment tsd-typography">
672
- <div class="lead">
673
- <p>用户唯一标识ID。</p>
674
- </div>
675
- </div>
676
- </li>
677
- <li class="tsd-parameter">
678
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> mem_<wbr>user_<wbr>status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.MemUserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">MemUserStatus</a></h5>
679
- <div class="tsd-comment tsd-typography">
680
- <div class="lead">
681
- <p>内存中的用户状态。</p>
682
- </div>
683
- </div>
684
- </li>
685
- <li class="tsd-parameter">
686
- <h5>micro_<wbr>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
687
- <div class="tsd-comment tsd-typography">
688
- <div class="lead">
689
- <p>用户当前是否开启麦克风。</p>
690
- </div>
691
- </div>
692
- </li>
693
- <li class="tsd-parameter">
694
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> once_<wbr>ws_<wbr>online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
695
- <div class="tsd-comment tsd-typography">
696
- <div class="lead">
697
- <p>用户曾经是否在线过，即进入房间后又由于某种原因离开后重新进入。</p>
698
- </div>
699
- </div>
700
- </li>
701
- <li class="tsd-parameter">
702
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5>
703
- <div class="tsd-comment tsd-typography">
704
- <div class="lead">
705
- <p>当前用户的权限配置。（UI层面理解）。</p>
706
- </div>
707
- </div>
708
- </li>
709
- <li class="tsd-parameter">
710
- <h5>rtc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
711
- <div class="tsd-comment tsd-typography">
712
- <div class="lead">
713
- <p>RTC 环境是否就绪，即当前语音是否联通。</p>
714
- </div>
715
- </div>
716
- </li>
717
- <li class="tsd-parameter">
718
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.UserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">UserStatus</a></h5>
719
- <div class="tsd-comment tsd-typography">
720
- <div class="lead">
721
- <p>用户当前的状态。</p>
722
- </div>
723
- </div>
724
- </li>
725
- <li class="tsd-parameter">
726
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> user_<wbr>role<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
727
- <div class="tsd-comment tsd-typography">
728
- <div class="lead">
729
- <p>用户角色定义。（前端不关注此字段）。</p>
730
- </div>
731
- </div>
732
- </li>
733
- </ul>
734
- </div>
735
- </section>
736
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
737
- <a name="UserInfoExt" class="tsd-anchor"></a>
738
- <h3>User<wbr>Info<wbr>Ext</h3>
739
- <div class="tsd-signature tsd-kind-icon">User<wbr>Info<wbr>Ext<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>avatar<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>nickname<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
740
- <aside class="tsd-sources">
741
- <ul>
742
- <li>Defined in typings/UserInfo.ts:31</li>
743
- </ul>
744
- </aside>
745
- <div class="tsd-comment tsd-typography">
746
- <div class="lead">
747
- <p>用户信息扩展字段：比如提供用户画像相关的数据。</p>
748
- </div>
749
- </div>
750
- <div class="tsd-type-declaration">
751
- <h4>Type declaration</h4>
752
- <ul class="tsd-parameters">
753
- <li class="tsd-parameter-index-signature">
754
- <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
755
- <div class="tsd-comment tsd-typography">
756
- <div class="lead">
757
- <p>其他用户相关的字段，比如用户职称、住址、联系方式等信息。</p>
758
- </div>
759
- </div>
760
- </li>
761
- <li class="tsd-parameter">
762
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> avatar<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
763
- <div class="tsd-comment tsd-typography">
764
- <div class="lead">
765
- <p>用户头像。</p>
766
- </div>
767
- </div>
768
- </li>
769
- <li class="tsd-parameter">
770
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> nickname<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
771
- <div class="tsd-comment tsd-typography">
772
- <div class="lead">
773
- <p>用户昵称。</p>
774
- </div>
775
- </div>
776
- </li>
777
- </ul>
778
- </div>
779
- </section>
780
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
781
- <a name="WebSocketError" class="tsd-anchor"></a>
782
- <h3>Web<wbr>Socket<wbr>Error</h3>
783
- <div class="tsd-signature tsd-kind-icon">Web<wbr>Socket<wbr>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>closeError<span class="tsd-signature-symbol">?: </span><a href="../enums/live.WebSocketCloseError.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketCloseError</a><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>target<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CloseEvent</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="../enums/live.WebSocketErrorType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketErrorType</a><span class="tsd-signature-symbol"> }</span></div>
784
- <aside class="tsd-sources">
785
- <ul>
786
- <li>Defined in typings/WebSocket.ts:31</li>
787
- </ul>
788
- </aside>
789
- <div class="tsd-type-declaration">
790
- <h4>Type declaration</h4>
791
- <ul class="tsd-parameters">
792
- <li class="tsd-parameter">
793
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> close<wbr>Error<span class="tsd-signature-symbol">?: </span><a href="../enums/live.WebSocketCloseError.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketCloseError</a></h5>
794
- </li>
795
- <li class="tsd-parameter">
796
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5>
797
- </li>
798
- <li class="tsd-parameter">
799
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> target<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CloseEvent</span></h5>
800
- </li>
801
- <li class="tsd-parameter">
802
- <h5>type<span class="tsd-signature-symbol">: </span><a href="../enums/live.WebSocketErrorType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketErrorType</a></h5>
803
- </li>
804
- </ul>
805
- </div>
806
- </section>
807
- <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
808
- <a name="WebSocketEventType" class="tsd-anchor"></a>
809
- <h3>Web<wbr>Socket<wbr>Event<wbr>Type</h3>
810
- <div class="tsd-signature tsd-kind-icon">Web<wbr>Socket<wbr>Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ws.afterConnect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.beforeConnect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.readyStateUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div>
811
- <aside class="tsd-sources">
812
- <ul>
813
- <li>Defined in typings/EventType.ts:9</li>
814
- </ul>
815
- </aside>
816
- <div class="tsd-comment tsd-typography">
817
- <div class="lead">
818
- <p>WebSocket 相关异步事件</p>
819
- </div>
820
- <dl class="tsd-comment-tags">
821
- <dt>description</dt>
822
- <dd><p>可以</p>
823
- </dd>
824
- </dl>
825
- </div>
826
- <div class="tsd-type-declaration">
827
- <h4>Type declaration</h4>
828
- <ul class="tsd-parameters">
829
- <li class="tsd-parameter">
830
- <h5>ws.after<wbr>Connect<span class="tsd-signature-symbol">: </span>function</h5>
831
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
832
- <li class="tsd-signature tsd-kind-icon">ws.after<wbr>Connect<span class="tsd-signature-symbol">(</span>reConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
833
- </ul>
834
- <ul class="tsd-descriptions">
835
- <li class="tsd-description">
836
- <aside class="tsd-sources">
837
- <ul>
838
- <li>Defined in typings/EventType.ts:22</li>
839
- </ul>
840
- </aside>
841
- <div class="tsd-comment tsd-typography">
842
- <div class="lead">
843
- <p>WebSocket 连接后</p>
844
- </div>
845
- </div>
846
- <h4 class="tsd-parameters-title">Parameters</h4>
847
- <ul class="tsd-parameters">
848
- <li>
849
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> reConnect: <span class="tsd-signature-type">number</span></h5>
850
- </li>
851
- </ul>
852
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
853
- </li>
854
- </ul>
855
- </li>
856
- <li class="tsd-parameter">
857
- <h5>ws.before<wbr>Connect<span class="tsd-signature-symbol">: </span>function</h5>
858
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
859
- <li class="tsd-signature tsd-kind-icon">ws.before<wbr>Connect<span class="tsd-signature-symbol">(</span>reConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
860
- </ul>
861
- <ul class="tsd-descriptions">
862
- <li class="tsd-description">
863
- <aside class="tsd-sources">
864
- <ul>
865
- <li>Defined in typings/EventType.ts:18</li>
866
- </ul>
867
- </aside>
868
- <div class="tsd-comment tsd-typography">
869
- <div class="lead">
870
- <p>WebSocket 连接前</p>
871
- </div>
872
- </div>
873
- <h4 class="tsd-parameters-title">Parameters</h4>
874
- <ul class="tsd-parameters">
875
- <li>
876
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> reConnect: <span class="tsd-signature-type">number</span></h5>
877
- </li>
878
- </ul>
879
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
880
- </li>
881
- </ul>
882
- </li>
883
- <li class="tsd-parameter">
884
- <h5>ws.error<span class="tsd-signature-symbol">: </span>function</h5>
885
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
886
- <li class="tsd-signature tsd-kind-icon">ws.error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><a href="live.html#WebSocketError" class="tsd-signature-type" data-tsd-kind="Type alias">WebSocketError</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
887
- </ul>
888
- <ul class="tsd-descriptions">
889
- <li class="tsd-description">
890
- <aside class="tsd-sources">
891
- <ul>
892
- <li>Defined in typings/EventType.ts:27</li>
893
- </ul>
894
- </aside>
895
- <div class="tsd-comment tsd-typography">
896
- <div class="lead">
897
- <p>WebSocket 连接过程中遭遇的异常情况信息。</p>
898
- </div>
899
- </div>
900
- <h4 class="tsd-parameters-title">Parameters</h4>
901
- <ul class="tsd-parameters">
902
- <li>
903
- <h5>error: <a href="live.html#WebSocketError" class="tsd-signature-type" data-tsd-kind="Type alias">WebSocketError</a></h5>
904
- <div class="tsd-comment tsd-typography">
905
- <p>错误信息。</p>
906
- </div>
907
- </li>
908
- </ul>
909
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
910
- </li>
911
- </ul>
912
- </li>
913
- <li class="tsd-parameter">
914
- <h5>ws.message<span class="tsd-signature-symbol">: </span>function</h5>
915
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
916
- <li class="tsd-signature tsd-kind-icon">ws.message<span class="tsd-signature-symbol">(</span>liveMsg<span class="tsd-signature-symbol">: </span><a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
917
- </ul>
918
- <ul class="tsd-descriptions">
919
- <li class="tsd-description">
920
- <aside class="tsd-sources">
921
- <ul>
922
- <li>Defined in typings/EventType.ts:32</li>
923
- </ul>
924
- </aside>
925
- <div class="tsd-comment tsd-typography">
926
- <div class="lead">
927
- <p>WebSocket 收到的消息</p>
928
- </div>
929
- </div>
930
- <h4 class="tsd-parameters-title">Parameters</h4>
931
- <ul class="tsd-parameters">
932
- <li>
933
- <h5>liveMsg: <a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a></h5>
934
- <div class="tsd-comment tsd-typography">
935
- <p>透传 WebSocket 消息</p>
936
- </div>
937
- </li>
938
- </ul>
939
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
940
- </li>
941
- </ul>
942
- </li>
943
- <li class="tsd-parameter">
944
- <h5>ws.ready<wbr>State<wbr>Update<span class="tsd-signature-symbol">: </span>function</h5>
945
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal">
946
- <li class="tsd-signature tsd-kind-icon">ws.ready<wbr>State<wbr>Update<span class="tsd-signature-symbol">(</span>readyState<span class="tsd-signature-symbol">: </span><a href="../enums/live.WebSocketState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
947
- </ul>
948
- <ul class="tsd-descriptions">
949
- <li class="tsd-description">
950
- <aside class="tsd-sources">
951
- <ul>
952
- <li>Defined in typings/EventType.ts:14</li>
953
- </ul>
954
- </aside>
955
- <div class="tsd-comment tsd-typography">
956
- <div class="lead">
957
- <p>WebSocket 状态发生更新</p>
958
- </div>
959
- </div>
960
- <h4 class="tsd-parameters-title">Parameters</h4>
961
- <ul class="tsd-parameters">
962
- <li>
963
- <h5>readyState: <a href="../enums/live.WebSocketState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketState</a></h5>
964
- <div class="tsd-comment tsd-typography">
965
- <p>当前状态枚举值。</p>
966
- </div>
967
- </li>
968
- </ul>
969
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
970
- </li>
971
- </ul>
972
- </li>
973
- </ul>
974
- </div>
975
- </section>
976
- </section>
977
- <section class="tsd-panel-group tsd-member-group ">
978
- <h2>Functions</h2>
979
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
980
- <a name="createLive" class="tsd-anchor"></a>
981
- <h3>create<wbr>Live</h3>
982
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
983
- <li class="tsd-signature tsd-kind-icon">create<wbr>Live&lt;Snapshot, TicketArgs&gt;<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span></li>
984
- </ul>
985
- <ul class="tsd-descriptions">
986
- <li class="tsd-description">
987
- <aside class="tsd-sources">
988
- <ul>
989
- <li>Defined in createLive.ts:205</li>
990
- </ul>
991
- </aside>
992
- <div class="tsd-comment tsd-typography">
993
- <div class="lead">
994
- <p>创建 <code>live</code> 实例。</p>
995
- </div>
996
- </div>
997
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
998
- <ul class="tsd-type-parameters">
999
- <li>
1000
- <h4>Snapshot</h4>
1001
- </li>
1002
- <li>
1003
- <h4>TicketArgs</h4>
1004
- </li>
1005
- </ul>
1006
- <h4 class="tsd-parameters-title">Parameters</h4>
1007
- <ul class="tsd-parameters">
1008
- <li>
1009
- <h5>options: <a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span></h5>
1010
- </li>
1011
- </ul>
1012
- <h4 class="tsd-returns-title">Returns <a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span></h4>
1013
- </li>
1014
- </ul>
1015
- </section>
1016
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
1017
- <a name="createLiveReact" class="tsd-anchor"></a>
1018
- <h3>create<wbr>Live<wbr>React</h3>
1019
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
1020
- <li class="tsd-signature tsd-kind-icon">create<wbr>Live<wbr>React&lt;Snapshot, TicketArgs&gt;<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/live.LiveReact.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveReact</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span></li>
1021
- </ul>
1022
- <ul class="tsd-descriptions">
1023
- <li class="tsd-description">
1024
- <aside class="tsd-sources">
1025
- <ul>
1026
- <li>Defined in createLiveReact.tsx:21</li>
1027
- </ul>
1028
- </aside>
1029
- <div class="tsd-comment tsd-typography">
1030
- <div class="lead">
1031
- <p>创建 <a href="../interfaces/live.LiveReact.html">LiveReact</a> 实例，并提供 <code>React</code> 技术栈相关工具链。</p>
1032
- </div>
1033
- </div>
1034
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
1035
- <ul class="tsd-type-parameters">
1036
- <li>
1037
- <h4>Snapshot</h4>
1038
- </li>
1039
- <li>
1040
- <h4>TicketArgs</h4>
1041
- </li>
1042
- </ul>
1043
- <h4 class="tsd-parameters-title">Parameters</h4>
1044
- <ul class="tsd-parameters">
1045
- <li>
1046
- <h5>options: <a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span></h5>
1047
- </li>
1048
- </ul>
1049
- <h4 class="tsd-returns-title">Returns <a href="../interfaces/live.LiveReact.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveReact</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Snapshot</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TicketArgs</span><span class="tsd-signature-symbol">&gt;</span></h4>
1050
- </li>
1051
- </ul>
1052
- </section>
1053
- <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
1054
- <a name="parseLiveMsg" class="tsd-anchor"></a>
1055
- <h3>parse<wbr>Live<wbr>Msg</h3>
1056
- <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
1057
- <li class="tsd-signature tsd-kind-icon">parse<wbr>Live<wbr>Msg<span class="tsd-signature-symbol">(</span>jsonTxt<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="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></li>
1058
- </ul>
1059
- <ul class="tsd-descriptions">
1060
- <li class="tsd-description">
1061
- <aside class="tsd-sources">
1062
- <ul>
1063
- <li>Defined in typings/LiveMsg.ts:131</li>
1064
- </ul>
1065
- </aside>
1066
- <div class="tsd-comment tsd-typography">
1067
- <div class="lead">
1068
- <p>解析下后端数据格式。</p>
1069
- </div>
1070
- </div>
1071
- <h4 class="tsd-parameters-title">Parameters</h4>
1072
- <ul class="tsd-parameters">
1073
- <li>
1074
- <h5>jsonTxt: <span class="tsd-signature-type">string</span></h5>
1075
- <div class="tsd-comment tsd-typography">
1076
- <p>JSON序列化后的文本。</p>
1077
- </div>
1078
- </li>
1079
- </ul>
1080
- <h4 class="tsd-returns-title">Returns <a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4>
1081
- <p>false 标识解析失败；解析成功返回 <a href="live.html#LiveMsg">LiveMsg</a> 实例。</p>
1082
- </li>
1083
- </ul>
1084
- </section>
1085
- </section>
1086
- </div>
1087
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
1088
- <nav class="tsd-navigation primary">
1089
- <ul>
1090
- <li class=" ">
1091
- <a href="../modules.html">Modules</a>
1092
- </li>
1093
- <li class=" tsd-kind-module">
1094
- <a href="RTCProtocol.html">RTCProtocol</a>
1095
- </li>
1096
- <li class="current tsd-kind-module">
1097
- <a href="live.html">live</a>
1098
- </li>
1099
- <li class=" tsd-kind-module">
1100
- <a href="shared_utils.html">shared-<wbr>utils</a>
1101
- </li>
1102
- </ul>
1103
- </nav>
1104
- <nav class="tsd-navigation secondary menu-sticky">
1105
- <ul class="before-current">
1106
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1107
- <a href="../enums/live.BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr>Action<wbr>Type</a>
1108
- </li>
1109
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1110
- <a href="../enums/live.BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr>Event<wbr>Type</a>
1111
- </li>
1112
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1113
- <a href="../enums/live.Command.html" class="tsd-kind-icon">Command</a>
1114
- </li>
1115
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1116
- <a href="../enums/live.MemUserStatus.html" class="tsd-kind-icon">Mem<wbr>User<wbr>Status</a>
1117
- </li>
1118
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1119
- <a href="../enums/live.MicroStatus.html" class="tsd-kind-icon">Micro<wbr>Status</a>
1120
- </li>
1121
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1122
- <a href="../enums/live.UserStatus.html" class="tsd-kind-icon">User<wbr>Status</a>
1123
- </li>
1124
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1125
- <a href="../enums/live.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Close<wbr>Error</a>
1126
- </li>
1127
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1128
- <a href="../enums/live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error<wbr>Type</a>
1129
- </li>
1130
- <li class=" tsd-kind-enum tsd-parent-kind-module">
1131
- <a href="../enums/live.WebSocketState.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>State</a>
1132
- </li>
1133
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
1134
- <a href="../interfaces/live.Live.html" class="tsd-kind-icon">Live</a>
1135
- </li>
1136
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
1137
- <a href="../interfaces/live.LiveOptions.html" class="tsd-kind-icon">Live<wbr>Options</a>
1138
- </li>
1139
- <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
1140
- <a href="../interfaces/live.LiveReact.html" class="tsd-kind-icon">Live<wbr>React</a>
1141
- </li>
1142
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1143
- <a href="live.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr>Msg</a>
1144
- </li>
1145
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
1146
- <a href="live.html#EventType" class="tsd-kind-icon">Event<wbr>Type</a>
1147
- </li>
1148
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
1149
- <a href="live.html#LiveActionReactCallback" class="tsd-kind-icon">Live<wbr>Action<wbr>React<wbr>Callback</a>
1150
- </li>
1151
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
1152
- <a href="live.html#LiveEventType" class="tsd-kind-icon">Live<wbr>Event<wbr>Type</a>
1153
- </li>
1154
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1155
- <a href="live.html#LiveMsg" class="tsd-kind-icon">Live<wbr>Msg</a>
1156
- </li>
1157
- <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter">
1158
- <a href="live.html#LiveProviderPropTypes" class="tsd-kind-icon">Live<wbr>Provider<wbr>Prop<wbr>Types</a>
1159
- </li>
1160
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1161
- <a href="live.html#ReqLiveMsg" class="tsd-kind-icon">Req<wbr>Live<wbr>Msg</a>
1162
- </li>
1163
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1164
- <a href="live.html#RoomInfo" class="tsd-kind-icon">Room<wbr>Info</a>
1165
- </li>
1166
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1167
- <a href="live.html#UserInfo" class="tsd-kind-icon">User<wbr>Info</a>
1168
- </li>
1169
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1170
- <a href="live.html#UserInfoExt" class="tsd-kind-icon">User<wbr>Info<wbr>Ext</a>
1171
- </li>
1172
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1173
- <a href="live.html#WebSocketError" class="tsd-kind-icon">Web<wbr>Socket<wbr>Error</a>
1174
- </li>
1175
- <li class=" tsd-kind-type-alias tsd-parent-kind-module">
1176
- <a href="live.html#WebSocketEventType" class="tsd-kind-icon">Web<wbr>Socket<wbr>Event<wbr>Type</a>
1177
- </li>
1178
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
1179
- <a href="live.html#createLive" class="tsd-kind-icon">create<wbr>Live</a>
1180
- </li>
1181
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
1182
- <a href="live.html#createLiveReact" class="tsd-kind-icon">create<wbr>Live<wbr>React</a>
1183
- </li>
1184
- <li class=" tsd-kind-function tsd-parent-kind-module">
1185
- <a href="live.html#parseLiveMsg" class="tsd-kind-icon">parse<wbr>Live<wbr>Msg</a>
1186
- </li>
1187
- </ul>
1188
- </nav>
1189
- </div>
1190
- </div>
1191
- </div>
1192
- <footer>
1193
- <div class="container">
1194
- <h2>Legend</h2>
1195
- <div class="tsd-legend-group">
1196
- <ul class="tsd-legend">
1197
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
1198
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
1199
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
1200
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
1201
- </ul>
1202
- <ul class="tsd-legend">
1203
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
1204
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
1205
- </ul>
1206
- <ul class="tsd-legend">
1207
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
1208
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
1209
- </ul>
1210
- <ul class="tsd-legend">
1211
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
1212
- </ul>
1213
- </div>
1214
- </div>
1215
- </footer>
1216
- <div class="overlay"></div>
1217
- <script src="../assets/js/main.js"></script>
1218
- </body>
1219
- </html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>live | 如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="live.html">live</a></li></ul><h1>Module live</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr/>Action<wbr/>Type</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.MemUserStatus.html" class="tsd-kind-icon">Mem<wbr/>User<wbr/>Status</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.MicroStatus.html" class="tsd-kind-icon">Micro<wbr/>Status</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.UserStatus.html" class="tsd-kind-icon">User<wbr/>Status</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Close<wbr/>Error</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error<wbr/>Type</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketState.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>State</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/live.Live.html" class="tsd-kind-icon">Live</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/live.LiveOptions.html" class="tsd-kind-icon">Live<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/live.LiveReact.html" class="tsd-kind-icon">Live<wbr/>React</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#KeyframeTypes" class="tsd-kind-icon">Keyframe<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveActionReactCallback" class="tsd-kind-icon">Live<wbr/>Action<wbr/>React<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveEventType" class="tsd-kind-icon">Live<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#LiveMsg" class="tsd-kind-icon">Live<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveProviderPropTypes" class="tsd-kind-icon">Live<wbr/>Provider<wbr/>Prop<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#ReqLiveMsg" class="tsd-kind-icon">Req<wbr/>Live<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#RoomInfo" class="tsd-kind-icon">Room<wbr/>Info</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#UserInfo" class="tsd-kind-icon">User<wbr/>Info</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#UserInfoExt" class="tsd-kind-icon">User<wbr/>Info<wbr/>Ext</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#WebSocketError" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#WebSocketEventType" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Event<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#createLive" class="tsd-kind-icon">create<wbr/>Live</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#createLiveReact" class="tsd-kind-icon">create<wbr/>Live<wbr/>React</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="live.html#parseLiveMsg" class="tsd-kind-icon">parse<wbr/>Live<wbr/>Msg</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="BuiltinMsg" class="tsd-anchor"></a><h3>Builtin<wbr/>Msg</h3><div class="tsd-signature tsd-kind-icon">Builtin<wbr/>Msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>action<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinActionType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinActionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>extension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>event_type<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinEventType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinEventType</a><span class="tsd-signature-symbol">; </span>to_user_ids<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></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:97</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>内置事件数据结构体。</p>
3
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>action<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinActionType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinActionType</a></h5></li><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>extension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> extension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></li><li class="tsd-parameter"><h5>event_<wbr/>type<span class="tsd-signature-symbol">: </span><a href="../enums/live.BuiltinEventType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltinEventType</a></h5></li><li class="tsd-parameter"><h5>to_<wbr/>user_<wbr/>ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="EventType" class="tsd-anchor"></a><h3>Event<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Event<wbr/>Type<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <a href="live.html#LiveEventType" class="tsd-signature-type" data-tsd-kind="Type alias">LiveEventType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><a href="live.html#WebSocketEventType" class="tsd-signature-type" data-tsd-kind="Type alias">WebSocketEventType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:97</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Snapshot</h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="KeyframeTypes" class="tsd-anchor"></a><h3>Keyframe<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Keyframe<wbr/>Types<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Type</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">Property</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Type</span><span class="tsd-signature-symbol"> as </span><span class="tsd-signature-type">Property</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>nextKeyframes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Type</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Property</span><span class="tsd-signature-symbol">]</span>, prevKeyframes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Type</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Property</span><span class="tsd-signature-symbol">]</span>, frontRequestId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:93</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Type</h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="LiveActionReactCallback" class="tsd-anchor"></a><h3>Live<wbr/>Action<wbr/>React<wbr/>Callback</h3><div class="tsd-signature tsd-kind-icon">Live<wbr/>Action<wbr/>React<wbr/>Callback<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;broadcast&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;exit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;kick&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;toggleMicro&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;forbidMicro&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;sendKeyframe&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getFramesByKey&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;setSelfInfo&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;updateStatus&quot;</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/Live.ts:140</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Snapshot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="LiveEventType" class="tsd-anchor"></a><h3>Live<wbr/>Event<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Live<wbr/>Event<wbr/>Type<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>broadcast<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>builtinEvent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>keyframes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>kickOut<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>readyKeyframeSync<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>roomChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>selfInfoUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>userChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>userListUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:35</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Snapshot</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>broadcast<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">broadcast<span class="tsd-signature-symbol">(</span>evtMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>, frontRequestId<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:58</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>收到其他用户的广播消息。</p>
5
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evtMsg: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
+ </div></div></li><li><h5>frontRequestId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>builtin<wbr/>Event<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">builtin<wbr/>Event<span class="tsd-signature-symbol">(</span>builtinMsg<span class="tsd-signature-symbol">: </span><a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:40</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ <p>内置消息事件</p>
8
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>builtinMsg: <a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>error<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">(</span>liveMsg<span class="tsd-signature-symbol">: </span><a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:89</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>异常消息：不符合规范。</p>
11
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>liveMsg: <a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
12
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>keyframes<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">keyframes<span class="tsd-signature-symbol">(</span>keyframes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span>, frontRequestId<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:69</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
13
+ <p>获取其他用户输送的帧数据：根据此帧数据更新UI状态。</p>
14
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>keyframes: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
15
+ </div></div></li><li><h5>frontRequestId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>kick<wbr/>Out<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">kick<wbr/>Out<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:84</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>被踢出房间</p>
17
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>ready<wbr/>Keyframe<wbr/>Sync<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">ready<wbr/>Keyframe<wbr/>Sync<span class="tsd-signature-symbol">(</span>lastKeyframe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:64</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
+ <p>带看已经就绪，可以发送帧数据。</p>
19
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>lastKeyframe: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
20
+ <p>带看最后一帧数据（链接切换、断网等重连恢复上次会话帧状态），你可以通过此数据拉齐当前UI状态。</p>
21
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>room<wbr/>Change<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">room<wbr/>Change<span class="tsd-signature-symbol">(</span>builtinMsg<span class="tsd-signature-symbol">: </span><a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:52</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
22
+ <p>内置消息事件：房间信息改变</p>
23
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>builtinMsg: <a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
24
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>self<wbr/>Info<wbr/>Update<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">self<wbr/>Info<wbr/>Update<span class="tsd-signature-symbol">(</span>userInfo<span class="tsd-signature-symbol">: </span><a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a>, frontRequestId<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:74</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
25
+ <p>个人信息发生更新。</p>
26
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>userInfo: <a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
27
+ </div></div></li><li><h5>frontRequestId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>user<wbr/>Change<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">user<wbr/>Change<span class="tsd-signature-symbol">(</span>builtinMsg<span class="tsd-signature-symbol">: </span><a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:46</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
28
+ <p>内置消息事件: 用户信息改变</p>
29
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>builtinMsg: <a href="live.html#BuiltinMsg" class="tsd-signature-type" data-tsd-kind="Type alias">BuiltinMsg</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
30
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>user<wbr/>List<wbr/>Update<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">user<wbr/>List<wbr/>Update<span class="tsd-signature-symbol">(</span>userList<span class="tsd-signature-symbol">: </span><a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a><span class="tsd-signature-symbol">[]</span>, frontRequestId<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><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:79</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
31
+ <p>用户列表更新。</p>
32
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>userList: <a href="live.html#UserInfo" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfo</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
33
+ </div></div></li><li><h5>frontRequestId: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="LiveMsg" class="tsd-anchor"></a><h3>Live<wbr/>Msg</h3><div class="tsd-signature tsd-kind-icon">Live<wbr/>Msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>appId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>frontRequestId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>requestId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>roomCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>triggerUserId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:118</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
34
+ <p>响应的信息结构体。</p>
35
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>app<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a></h5></li><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>front<wbr/>Request<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>request<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>room<wbr/>Code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>trigger<wbr/>User<wbr/>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="LiveProviderPropTypes" class="tsd-anchor"></a><h3>Live<wbr/>Provider<wbr/>Prop<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Live<wbr/>Provider<wbr/>Prop<wbr/>Types<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">React.ReactNode</span><span class="tsd-signature-symbol">; </span>live<span class="tsd-signature-symbol">?: </span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in createLiveReact.tsx:13</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Snapshot</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> children<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">React.ReactNode</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> live<span class="tsd-signature-symbol">?: </span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="ReqLiveMsg" class="tsd-anchor"></a><h3>Req<wbr/>Live<wbr/>Msg</h3><div class="tsd-signature tsd-kind-icon">Req<wbr/>Live<wbr/>Msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>to_user_ids<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><span class="tsd-signature-symbol">; </span>front_request_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:28</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
36
+ <p>向服务端请求数据时的数据格式。</p>
37
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>command<span class="tsd-signature-symbol">: </span><a href="../enums/live.Command.html" class="tsd-signature-type" data-tsd-kind="Enumeration">Command</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
38
+ <p>请求指令。</p>
39
+ </div></div></li><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>to_user_ids<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></h5><div class="tsd-comment tsd-typography"><div class="lead">
40
+ <p>数据内容</p>
41
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> to_<wbr/>user_<wbr/>ids<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
42
+ <p>如果此数据仅发送给某些用户，请提供这些用户的ucid。</p>
43
+ </div></div></li></ul></li><li class="tsd-parameter"><h5>front_<wbr/>request_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
44
+ <p>前端请求时生成的uuid()。</p>
45
+ </div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="RoomInfo" class="tsd-anchor"></a><h3>Room<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Room<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>init_timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>last_frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RoomInfo.ts:1</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>info<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>app_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>create_user_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>room_code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>app_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>create_<wbr/>time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>create_<wbr/>user_<wbr/>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>extension<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>room_<wbr/>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></li><li class="tsd-parameter"><h5>init_<wbr/>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>last_<wbr/>frame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="UserInfo" class="tsd-anchor"></a><h3>User<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>current_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>extension<span class="tsd-signature-symbol">?: </span><a href="live.html#UserInfoExt" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfoExt</a><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>mem_user_status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.MemUserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">MemUserStatus</a><span class="tsd-signature-symbol">; </span>micro_status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>once_ws_online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>rtc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.UserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">UserStatus</a><span class="tsd-signature-symbol">; </span>user_role<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:49</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
46
+ <p>带看会话房间用户的信息格式。</p>
47
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> current_<wbr/>ws_<wbr/>online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
48
+ <p>用户当前是否在线。</p>
49
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> extension<span class="tsd-signature-symbol">?: </span><a href="live.html#UserInfoExt" class="tsd-signature-type" data-tsd-kind="Type alias">UserInfoExt</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
50
+ <p>用户信息扩展字段。</p>
51
+ </div></div></li><li class="tsd-parameter"><h5>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
52
+ <p>用户唯一标识ID。</p>
53
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> mem_<wbr/>user_<wbr/>status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.MemUserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">MemUserStatus</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
54
+ <p>内存中的用户状态。</p>
55
+ </div></div></li><li class="tsd-parameter"><h5>micro_<wbr/>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
56
+ <p>用户当前是否开启麦克风。</p>
57
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> once_<wbr/>ws_<wbr/>online<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
58
+ <p>用户曾经是否在线过，即进入房间后又由于某种原因离开后重新进入。</p>
59
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> permission<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
60
+ <p>当前用户的权限配置。（UI层面理解）。</p>
61
+ </div></div></li><li class="tsd-parameter"><h5>rtc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
62
+ <p>RTC 环境是否就绪，即当前语音是否联通。</p>
63
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> status<span class="tsd-signature-symbol">?: </span><a href="../enums/live.UserStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">UserStatus</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
64
+ <p>用户当前的状态。</p>
65
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> user_<wbr/>role<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
66
+ <p>用户角色定义。（前端不关注此字段）。</p>
67
+ </div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="UserInfoExt" class="tsd-anchor"></a><h3>User<wbr/>Info<wbr/>Ext</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Info<wbr/>Ext<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>avatar<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>nickname<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:31</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
68
+ <p>用户信息扩展字段：比如提供用户画像相关的数据。</p>
69
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
70
+ <p>其他用户相关的字段，比如用户职称、住址、联系方式等信息。</p>
71
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> avatar<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
72
+ <p>用户头像。</p>
73
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> nickname<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
74
+ <p>用户昵称。</p>
75
+ </div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="WebSocketError" class="tsd-anchor"></a><h3>Web<wbr/>Socket<wbr/>Error</h3><div class="tsd-signature tsd-kind-icon">Web<wbr/>Socket<wbr/>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>closeError<span class="tsd-signature-symbol">?: </span><a href="../enums/live.WebSocketCloseError.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketCloseError</a><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>target<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CloseEvent</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="../enums/live.WebSocketErrorType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketErrorType</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:31</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> close<wbr/>Error<span class="tsd-signature-symbol">?: </span><a href="../enums/live.WebSocketCloseError.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketCloseError</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> target<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CloseEvent</span></h5></li><li class="tsd-parameter"><h5>type<span class="tsd-signature-symbol">: </span><a href="../enums/live.WebSocketErrorType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketErrorType</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="WebSocketEventType" class="tsd-anchor"></a><h3>Web<wbr/>Socket<wbr/>Event<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Web<wbr/>Socket<wbr/>Event<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ws.afterConnect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.beforeConnect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>ws.readyStateUpdate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:9</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
76
+ <p>WebSocket 相关异步事件</p>
77
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>可以</p>
78
+ </dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>ws.after<wbr/>Connect<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">ws.after<wbr/>Connect<span class="tsd-signature-symbol">(</span>reConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:22</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
79
+ <p>WebSocket 连接后</p>
80
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> reConnect: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>ws.before<wbr/>Connect<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">ws.before<wbr/>Connect<span class="tsd-signature-symbol">(</span>reConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
81
+ <p>WebSocket 连接前</p>
82
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> reConnect: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>ws.error<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">ws.error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><a href="live.html#WebSocketError" class="tsd-signature-type" data-tsd-kind="Type alias">WebSocketError</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:27</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
83
+ <p>WebSocket 连接过程中遭遇的异常情况信息。</p>
84
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <a href="live.html#WebSocketError" class="tsd-signature-type" data-tsd-kind="Type alias">WebSocketError</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
85
+ <p>错误信息。</p>
86
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>ws.message<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">ws.message<span class="tsd-signature-symbol">(</span>liveMsg<span class="tsd-signature-symbol">: </span><a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:32</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
87
+ <p>WebSocket 收到的消息</p>
88
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>liveMsg: <a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
89
+ <p>透传 WebSocket 消息</p>
90
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>ws.ready<wbr/>State<wbr/>Update<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">ws.ready<wbr/>State<wbr/>Update<span class="tsd-signature-symbol">(</span>readyState<span class="tsd-signature-symbol">: </span><a href="../enums/live.WebSocketState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/EventType.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
91
+ <p>WebSocket 状态发生更新</p>
92
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>readyState: <a href="../enums/live.WebSocketState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">WebSocketState</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
93
+ <p>当前状态枚举值。</p>
94
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="createLive" class="tsd-anchor"></a><h3>create<wbr/>Live</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">create<wbr/>Live<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in createLive.ts:229</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
95
+ <p>创建 <code>live</code> 实例。</p>
96
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Snapshot</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="createLiveReact" class="tsd-anchor"></a><h3>create<wbr/>Live<wbr/>React</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">create<wbr/>Live<wbr/>React<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/live.LiveReact.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveReact</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in createLiveReact.tsx:21</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
97
+ <p>创建 <a href="../interfaces/live.LiveReact.html">LiveReact</a> 实例，并提供 <code>React</code> 技术栈相关工具链。</p>
98
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Snapshot</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/live.LiveOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/live.LiveReact.html" class="tsd-signature-type" data-tsd-kind="Interface">LiveReact</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Snapshot</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="parseLiveMsg" class="tsd-anchor"></a><h3>parse<wbr/>Live<wbr/>Msg</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">parse<wbr/>Live<wbr/>Msg<span class="tsd-signature-symbol">(</span>jsonTxt<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="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:135</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
99
+ <p>解析下后端数据格式。</p>
100
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jsonTxt: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
101
+ <p>JSON序列化后的文本。</p>
102
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="live.html#LiveMsg" class="tsd-signature-type" data-tsd-kind="Type alias">LiveMsg</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h4><div><p>false 标识解析失败；解析成功返回 <a href="live.html#LiveMsg">LiveMsg</a> 实例。</p>
103
+ </div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="RTCProtocol.html">RTCProtocol</a></li><li class="current tsd-kind-module"><a href="live.html">live</a></li><li class=" tsd-kind-module"><a href="shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr/>Action<wbr/>Type</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.MemUserStatus.html" class="tsd-kind-icon">Mem<wbr/>User<wbr/>Status</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.MicroStatus.html" class="tsd-kind-icon">Micro<wbr/>Status</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.UserStatus.html" class="tsd-kind-icon">User<wbr/>Status</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Close<wbr/>Error</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error<wbr/>Type</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/live.WebSocketState.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>State</a></li><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/live.Live.html" class="tsd-kind-icon">Live</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/live.LiveOptions.html" class="tsd-kind-icon">Live<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/live.LiveReact.html" class="tsd-kind-icon">Live<wbr/>React</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#KeyframeTypes" class="tsd-kind-icon">Keyframe<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveActionReactCallback" class="tsd-kind-icon">Live<wbr/>Action<wbr/>React<wbr/>Callback</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveEventType" class="tsd-kind-icon">Live<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#LiveMsg" class="tsd-kind-icon">Live<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#LiveProviderPropTypes" class="tsd-kind-icon">Live<wbr/>Provider<wbr/>Prop<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#ReqLiveMsg" class="tsd-kind-icon">Req<wbr/>Live<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#RoomInfo" class="tsd-kind-icon">Room<wbr/>Info</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#UserInfo" class="tsd-kind-icon">User<wbr/>Info</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#UserInfoExt" class="tsd-kind-icon">User<wbr/>Info<wbr/>Ext</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#WebSocketError" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="live.html#WebSocketEventType" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#createLive" class="tsd-kind-icon">create<wbr/>Live</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="live.html#createLiveReact" class="tsd-kind-icon">create<wbr/>Live<wbr/>React</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="live.html#parseLiveMsg" class="tsd-kind-icon">parse<wbr/>Live<wbr/>Msg</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>