@tencent-rtc/mcp 1.2.8 → 1.2.9
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.
- package/package.json +1 -1
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +312 -0
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +430 -0
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +679 -0
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +671 -0
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +271 -0
- package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +849 -0
- package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +1046 -0
- package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +460 -0
- package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +558 -0
- package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +865 -0
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +657 -0
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +437 -0
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +335 -0
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +748 -0
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +327 -0
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +507 -0
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +507 -0
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +659 -0
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +284 -0
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +814 -0
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +1000 -0
- package/tools/definitions/get_native_live_api_def.js +23 -0
- package/tools/definitions/get_native_live_api_def.js.map +1 -0
- package/tools/index.js +4 -0
- package/tools/index.js.map +1 -1
- package/tools/native_live/get-native-live-api.js +31 -0
- package/tools/native_live/get-native-live-api.js.map +1 -0
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
package/package.json
CHANGED
|
@@ -0,0 +1,312 @@
|
|
|
1
|
+
# Tencent Cloud Live Streaming SDK V2TXLiveCode Error Code Documentation
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
`V2TXLiveCode.java` defines the error and warning codes for the Tencent Cloud Live Streaming (CSS) SDK on Android. This file categorizes error codes and provides detailed descriptions for features such as host (push), player (playback), stream mixing, and recording.
|
|
6
|
+
|
|
7
|
+
**File Path**: `com/tencent/live2/V2TXLiveCode.java`
|
|
8
|
+
**Platform Support**: Android
|
|
9
|
+
**Total Error Codes**: 20 core error and warning codes
|
|
10
|
+
|
|
11
|
+
## 📋 Table of Contents
|
|
12
|
+
|
|
13
|
+
### 1. [Error Code Categories](#错误码分类)
|
|
14
|
+
### 2. [General Error Codes](#通用错误码)
|
|
15
|
+
### 3. [Network-Related Warning Codes](#网络相关警告码)
|
|
16
|
+
### 4. [Camera-Related Warning Codes](#摄像头相关警告码)
|
|
17
|
+
### 5. [Microphone-Related Warning Codes](#麦克风相关警告码)
|
|
18
|
+
### 6. [Screen Sharing Warning Codes](#屏幕分享相关警告码)
|
|
19
|
+
### 7. [Codec Warning Codes](#编解码相关警告码)
|
|
20
|
+
### 8. [Error Code Usage Guide](#错误码使用指南)
|
|
21
|
+
### 9. [Error Handling Best Practices](#错误处理最佳实践)
|
|
22
|
+
|
|
23
|
+
## 1. Error Code Categories
|
|
24
|
+
|
|
25
|
+
### 🎯 Error Code Breakdown
|
|
26
|
+
|
|
27
|
+
| Category | Number of Codes | Main Functionality |
|
|
28
|
+
|----------------------------------|----------------|-------------------------------------------|
|
|
29
|
+
| General Error Codes | 9 | API calls, parameter validation, permission checks |
|
|
30
|
+
| Network-Related Warning Codes | 2 | Network status, video stutter monitoring |
|
|
31
|
+
| Camera-Related Warning Codes | 3 | Camera device status monitoring |
|
|
32
|
+
| Microphone-Related Warning Codes | 3 | Microphone device status monitoring |
|
|
33
|
+
| Screen Sharing Warning Codes | 3 | Screen sharing status monitoring |
|
|
34
|
+
| Codec Warning Codes | 2 | Audio/video codec status monitoring |
|
|
35
|
+
|
|
36
|
+
### 🔧 Technical Highlights
|
|
37
|
+
|
|
38
|
+
- **Hierarchical Categorization**: Error codes are organized by functional module.
|
|
39
|
+
- **Detailed Descriptions**: Each error code includes a clear explanation and usage scenario.
|
|
40
|
+
- **Platform-Specific**: Android-only error codes.
|
|
41
|
+
- **Debug-Friendly**: Comprehensive explanations and handling recommendations for each error code.
|
|
42
|
+
|
|
43
|
+
## 2. General Error Codes
|
|
44
|
+
|
|
45
|
+
### ✅ V2TXLIVE_OK - Operation Successful
|
|
46
|
+
|
|
47
|
+
```java
|
|
48
|
+
public static final int V2TXLIVE_OK = 0;
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**Description**: Operation completed successfully; no error occurred.
|
|
52
|
+
|
|
53
|
+
**Typical Use Cases**:
|
|
54
|
+
- API call succeeded
|
|
55
|
+
- Operation executed and confirmed
|
|
56
|
+
- Status check returned normal
|
|
57
|
+
|
|
58
|
+
### ❌ V2TXLIVE_ERROR_FAILED - General Error
|
|
59
|
+
|
|
60
|
+
```java
|
|
61
|
+
public static final int V2TXLIVE_ERROR_FAILED = -1;
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Description**: Unclassified general error.
|
|
65
|
+
|
|
66
|
+
**Possible Causes**:
|
|
67
|
+
- Internal processing exception
|
|
68
|
+
|
|
69
|
+
### ❌ V2TXLIVE_ERROR_INVALID_PARAMETER - Invalid Parameter
|
|
70
|
+
|
|
71
|
+
```java
|
|
72
|
+
public static final int V2TXLIVE_ERROR_INVALID_PARAMETER = -2;
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**Description**: Invalid parameters were provided in the API call.
|
|
76
|
+
|
|
77
|
+
**Common Scenarios**:
|
|
78
|
+
- Incorrect stream push URL format
|
|
79
|
+
- Unsupported parameter value
|
|
80
|
+
|
|
81
|
+
### ❌ V2TXLIVE_ERROR_REFUSED - API Call Refused
|
|
82
|
+
|
|
83
|
+
```java
|
|
84
|
+
public static final int V2TXLIVE_ERROR_REFUSED = -3;
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
**Description**: API call was refused.
|
|
88
|
+
|
|
89
|
+
**Possible Causes**:
|
|
90
|
+
- Incorrect call timing
|
|
91
|
+
|
|
92
|
+
### ❌ V2TXLIVE_ERROR_NOT_SUPPORTED - API Not Supported
|
|
93
|
+
|
|
94
|
+
```java
|
|
95
|
+
public static final int V2TXLIVE_ERROR_NOT_SUPPORTED = -4;
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
**Description**: This API is not supported.
|
|
99
|
+
|
|
100
|
+
**Common Scenarios**:
|
|
101
|
+
- Feature not supported on the current platform
|
|
102
|
+
- SDK version is too low
|
|
103
|
+
- Hardware does not support the feature
|
|
104
|
+
|
|
105
|
+
### ❌ V2TXLIVE_ERROR_INVALID_LICENSE - Invalid License
|
|
106
|
+
|
|
107
|
+
```java
|
|
108
|
+
public static final int V2TXLIVE_ERROR_INVALID_LICENSE = -5;
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
**Description**: License is invalid; the call failed.
|
|
112
|
+
|
|
113
|
+
**Possible Causes**:
|
|
114
|
+
- License file not set
|
|
115
|
+
- License expired
|
|
116
|
+
- License does not match the package name
|
|
117
|
+
|
|
118
|
+
### ❌ V2TXLIVE_ERROR_REQUEST_TIMEOUT - Request Timeout
|
|
119
|
+
|
|
120
|
+
```java
|
|
121
|
+
public static final int V2TXLIVE_ERROR_REQUEST_TIMEOUT = -6;
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**Description**: Request to the server timed out.
|
|
125
|
+
|
|
126
|
+
**Common Scenarios**:
|
|
127
|
+
- Unstable network connection
|
|
128
|
+
- Slow server response
|
|
129
|
+
|
|
130
|
+
### ❌ V2TXLIVE_ERROR_SERVER_PROCESS_FAILED - Server Processing Failed
|
|
131
|
+
|
|
132
|
+
```java
|
|
133
|
+
public static final int V2TXLIVE_ERROR_SERVER_PROCESS_FAILED = -7;
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
**Description**: The server was unable to process your request.
|
|
137
|
+
|
|
138
|
+
**Possible Causes**:
|
|
139
|
+
- Internal server error
|
|
140
|
+
- Incorrect request format
|
|
141
|
+
- Insufficient server resources
|
|
142
|
+
|
|
143
|
+
### ❌ V2TXLIVE_ERROR_DISCONNECTED - Disconnected
|
|
144
|
+
|
|
145
|
+
```java
|
|
146
|
+
public static final int V2TXLIVE_ERROR_DISCONNECTED = -8;
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
**Description**: Network connection was lost.
|
|
150
|
+
|
|
151
|
+
**Common Scenarios**:
|
|
152
|
+
- Push stream network disconnected
|
|
153
|
+
- Playback network disconnected
|
|
154
|
+
|
|
155
|
+
### ❌ V2TXLIVE_ERROR_NO_AVAILABLE_HEVC_DECODERS - No Available HEVC Decoders
|
|
156
|
+
|
|
157
|
+
```java
|
|
158
|
+
public static final int V2TXLIVE_ERROR_NO_AVAILABLE_HEVC_DECODERS = -2304;
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
**Description**: No available HEVC decoders found.
|
|
162
|
+
|
|
163
|
+
**Possible Causes**:
|
|
164
|
+
- Device does not support HEVC Hardware Decoding
|
|
165
|
+
- HEVC decoder initialization failed
|
|
166
|
+
- System version is too low
|
|
167
|
+
|
|
168
|
+
## 3. Network-Related Warning Codes
|
|
169
|
+
|
|
170
|
+
### ⚠️ V2TXLIVE_WARNING_NETWORK_BUSY - Network Busy
|
|
171
|
+
|
|
172
|
+
```java
|
|
173
|
+
public static final int V2TXLIVE_WARNING_NETWORK_BUSY = 1101;
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Description**: Poor network conditions detected; insufficient upstream bandwidth is causing data upload to be blocked.
|
|
177
|
+
|
|
178
|
+
**Monitoring Indicators**:
|
|
179
|
+
- Upstream bandwidth limitations
|
|
180
|
+
- Increased network latency
|
|
181
|
+
- High packet loss rate
|
|
182
|
+
|
|
183
|
+
### ⚠️ V2TXLIVE_WARNING_VIDEO_BLOCK - Video Stutter
|
|
184
|
+
|
|
185
|
+
```java
|
|
186
|
+
public static final int V2TXLIVE_WARNING_VIDEO_BLOCK = 2105;
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
**Description**: Video playback is experiencing stutter.
|
|
190
|
+
|
|
191
|
+
**Possible Causes**:
|
|
192
|
+
- Insufficient network bandwidth
|
|
193
|
+
- Decoding performance bottleneck
|
|
194
|
+
- Rendering performance issues
|
|
195
|
+
|
|
196
|
+
## 4. Camera-Related Warning Codes
|
|
197
|
+
|
|
198
|
+
### ⚠️ V2TXLIVE_WARNING_CAMERA_START_FAILED - Camera Start Failed
|
|
199
|
+
|
|
200
|
+
```java
|
|
201
|
+
public static final int V2TXLIVE_WARNING_CAMERA_START_FAILED = -1301;
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
**Description**: Failed to start the camera.
|
|
205
|
+
|
|
206
|
+
**Possible Causes**:
|
|
207
|
+
- Hardware malfunction
|
|
208
|
+
- Driver issues
|
|
209
|
+
- Resource conflicts
|
|
210
|
+
|
|
211
|
+
### ⚠️ V2TXLIVE_WARNING_CAMERA_OCCUPIED - Camera Occupied
|
|
212
|
+
|
|
213
|
+
```java
|
|
214
|
+
public static final int V2TXLIVE_WARNING_CAMERA_OCCUPIED = -1316;
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
**Description**: Camera is currently in use.
|
|
218
|
+
|
|
219
|
+
**Possible Scenarios**:
|
|
220
|
+
- Another app is using the camera
|
|
221
|
+
- System camera app is running
|
|
222
|
+
- Video call is in progress
|
|
223
|
+
|
|
224
|
+
### ⚠️ V2TXLIVE_WARNING_CAMERA_NO_PERMISSION - Camera Not Authorized
|
|
225
|
+
|
|
226
|
+
```java
|
|
227
|
+
public static final int V2TXLIVE_WARNING_CAMERA_NO_PERMISSION = -1314;
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
**Description**: Camera access not authorized. This typically occurs on mobile devices when the user denies permission.
|
|
231
|
+
|
|
232
|
+
## 5. Microphone-Related Warning Codes
|
|
233
|
+
|
|
234
|
+
### ⚠️ V2TXLIVE_WARNING_MICROPHONE_START_FAILED - Microphone Start Failed
|
|
235
|
+
|
|
236
|
+
```java
|
|
237
|
+
public static final int V2TXLIVE_WARNING_MICROPHONE_START_FAILED = -1302;
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
**Description**: Failed to start the microphone.
|
|
241
|
+
|
|
242
|
+
**Possible Causes**:
|
|
243
|
+
- Hardware connection issues
|
|
244
|
+
- Abnormal system audio settings
|
|
245
|
+
- Audio session initialization failed
|
|
246
|
+
|
|
247
|
+
### ⚠️ V2TXLIVE_WARNING_MICROPHONE_OCCUPIED - Microphone Occupied
|
|
248
|
+
|
|
249
|
+
```java
|
|
250
|
+
public static final int V2TXLIVE_WARNING_MICROPHONE_OCCUPIED = -1319;
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
**Description**: Microphone is currently in use. For example, opening the microphone will fail if the device is in a call.
|
|
254
|
+
|
|
255
|
+
**Possible Scenarios**:
|
|
256
|
+
- Device is in a call
|
|
257
|
+
- Another audio app is using the microphone
|
|
258
|
+
- Audio session conflict
|
|
259
|
+
|
|
260
|
+
### ⚠️ V2TXLIVE_WARNING_MICROPHONE_NO_PERMISSION - Microphone Not Authorized
|
|
261
|
+
|
|
262
|
+
```java
|
|
263
|
+
public static final int V2TXLIVE_WARNING_MICROPHONE_NO_PERMISSION = -1317;
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
**Description**: Microphone access not authorized. This typically occurs on mobile devices when the user denies permission.
|
|
267
|
+
|
|
268
|
+
## 6. Screen Sharing Warning Codes
|
|
269
|
+
|
|
270
|
+
### ⚠️ V2TXLIVE_WARNING_SCREEN_CAPTURE_NOT_SUPPORTED - Screen Sharing Not Supported by System
|
|
271
|
+
|
|
272
|
+
```java
|
|
273
|
+
public static final int V2TXLIVE_WARNING_SCREEN_CAPTURE_NOT_SUPPORTED = -1309;
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
**Description**: The current system does not support screen sharing.
|
|
277
|
+
|
|
278
|
+
### ⚠️ V2TXLIVE_WARNING_SCREEN_CAPTURE_START_FAILED - Failed to Start Screen Capture
|
|
279
|
+
|
|
280
|
+
```java
|
|
281
|
+
public static final int V2TXLIVE_WARNING_SCREEN_CAPTURE_START_FAILED = -1308;
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
**Description**: Failed to start screen capture. On mobile devices, this may be due to the user denying permission.
|
|
285
|
+
|
|
286
|
+
### ⚠️ V2TXLIVE_WARNING_SCREEN_CAPTURE_INTERRUPTED - Screen Capture Interrupted by System
|
|
287
|
+
|
|
288
|
+
```java
|
|
289
|
+
public static final int V2TXLIVE_WARNING_SCREEN_CAPTURE_INTERRUPTED = -7001;
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
**Description**: Screen capture was interrupted by the system.
|
|
293
|
+
|
|
294
|
+
## 7. Codec Warning Codes
|
|
295
|
+
|
|
296
|
+
### ⚠️ V2TXLIVE_WARNING_CURRENT_ENCODE_TYPE_CHANGED - Encoder Changed
|
|
297
|
+
|
|
298
|
+
```java
|
|
299
|
+
public static final int V2TXLIVE_WARNING_CURRENT_ENCODE_TYPE_CHANGED = 1104;
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
**Description**: The encoder has changed. You can get the current codec format from the `codec_type` field in the extension info of the `onWarning` callback.
|
|
303
|
+
|
|
304
|
+
### ⚠️ V2TXLIVE_WARNING_CURRENT_DECODE_TYPE_CHANGED - Decoder Changed
|
|
305
|
+
|
|
306
|
+
```java
|
|
307
|
+
public static final int V2TXLIVE_WARNING_CURRENT_DECODE_TYPE_CHANGED = 2008;
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
**Description**: The decoder has changed. You can get the current decoding format from the `codec_type` field in the extension info of the `onWarning` callback.
|
|
311
|
+
|
|
312
|
+
**Note**: The extension info for this warning code is not supported on Windows.
|