@byteplus/react-native-rtc 1.0.0 → 1.0.2
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/android/build.gradle +1 -1
- package/android/src/main/java/com/volcengine/reactnative/vertc/vod/VertcVod.java +10 -26
- package/android/src/main/java/com/volcengine/reactnative/vertc/vod/VideoAudioProcessor.java +8 -9
- package/android/src/main/java/com/volcengine/reactnative/vertc/vod/VodAudioProxy.java +44 -0
- package/android/src/main/java/com/volcengine/reactnative/vertc/vod/VodAudioVoiceWrapperObject.java +355 -0
- package/android/src/main/java/com/volcengine/reactnative/vertc/vod/VodMock.java +6 -17
- package/android/src/main/java/com/volcengine/reactnative/vertc/vod/VodVideoProxy.java +97 -0
- package/ios/vod/VertcVod.m +3 -10
- package/ios/vod/VodAudioProcessor.h +1 -1
- package/ios/vod/VodAudioProcessor.mm +1 -3
- package/ios/vod/VodVideoProcessor.h +1 -3
- package/ios/vod/VodVideoProcessor.m +2 -22
- package/lib/commonjs/index.js +871 -865
- package/lib/module/index.js +871 -865
- package/lib/typescript/codegen/pack/api.d.ts +634 -637
- package/lib/typescript/codegen/pack/callback.d.ts +248 -251
- package/lib/typescript/codegen/pack/errorcode.d.ts +36 -36
- package/lib/typescript/codegen/pack/keytype.d.ts +181 -181
- package/lib/typescript/core/rtc-video.d.ts +1 -7
- package/lib/typescript/core.d.ts +4 -4
- package/lib/typescript/interface.d.ts +63 -64
- package/lib/typescript/platforms/android/vod.d.ts +2 -2
- package/package.json +2 -2
- package/react-native-rtc.podspec +6 -5
- package/android/src/main/java/com/volcengine/reactnative/vertc/vod/VodVideoEngineCallbackProxy.java +0 -94
|
@@ -18,7 +18,7 @@ export declare class ISpatialAudio {
|
|
|
18
18
|
* @param enable Whether to enable spatial audio function: <br>
|
|
19
19
|
* - true:Enable
|
|
20
20
|
* - false:Disable(Default setting)
|
|
21
|
-
* @note You need to call
|
|
21
|
+
* @note You need to call {@link updatePosition updatePosition} as well to really enjoy the spatial audio effect.
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
24
24
|
enableSpatialAudio(enable: boolean): void;
|
|
@@ -30,7 +30,7 @@ export declare class ISpatialAudio {
|
|
|
30
30
|
* After the effect is off, all the other users in the room listen to the local user as if the local user is in right front of each of them.
|
|
31
31
|
* @note
|
|
32
32
|
* - After the orientation effect as the sound source is disabled, you cannot enable it during the lifetime of the `SpatialAudio` instance.
|
|
33
|
-
* - Calling this API does not affect the orientation effect of the local user as a listener. See
|
|
33
|
+
* - Calling this API does not affect the orientation effect of the local user as a listener. See {@link updateSelfPosition updateSelfPosition} and {@link updateRemotePosition updateRemotePosition}.
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
disableRemoteOrientation(): void;
|
|
@@ -40,14 +40,14 @@ export declare class ISpatialAudio {
|
|
|
40
40
|
* @region Audio management
|
|
41
41
|
* @author wangjunzheng
|
|
42
42
|
* @brief Sets the coordinate and orientation of the local user as a listener in the rectangular coordinate system the local user built to achieve expected spatial audio effects.
|
|
43
|
-
* @param positionInfo Information on the local user's position. Refer to
|
|
43
|
+
* @param positionInfo Information on the local user's position. Refer to {@link PositionInfo PositionInfo} for details.
|
|
44
44
|
* @return
|
|
45
45
|
* - 0: Success.
|
|
46
46
|
* - <0: Failure.
|
|
47
47
|
* - -2: Failure. The reason is that any two of the 3D coordinate vectors of your position are not perpendicular to each other.
|
|
48
48
|
* @note
|
|
49
49
|
* - You need to call this API after joining the room.
|
|
50
|
-
* - Before calling this API, you should call
|
|
50
|
+
* - Before calling this API, you should call {@link enableSpatialAudio enableSpatialAudio} first to enable the spatial audio function.
|
|
51
51
|
* - The settings made locally will not influence other users' spatial audio experience.
|
|
52
52
|
*
|
|
53
53
|
*/
|
|
@@ -59,7 +59,7 @@ export declare class ISpatialAudio {
|
|
|
59
59
|
* @author wangjunzheng
|
|
60
60
|
* @brief Sets the coordinate and orientation of the remote user as a speaker in the rectangular coordinate system of the local user. In this case, the local user hears from the remote user with the expected spatial audio effects.
|
|
61
61
|
* @param uid User ID
|
|
62
|
-
* @param positionInfo Information on the remote user's position. Refer to
|
|
62
|
+
* @param positionInfo Information on the remote user's position. Refer to {@link PositionInfo PositionInfo} for details.
|
|
63
63
|
* @return
|
|
64
64
|
* - 0: Success.
|
|
65
65
|
* - <0: Failure.
|
|
@@ -75,7 +75,7 @@ export declare class ISpatialAudio {
|
|
|
75
75
|
* @detail api
|
|
76
76
|
* @region Audio management
|
|
77
77
|
* @author wangjunzheng
|
|
78
|
-
* @brief Disables all spatial audio effects set by calling
|
|
78
|
+
* @brief Disables all spatial audio effects set by calling {@link updateRemotePosition updateRemotePosition} for a certain remote user.
|
|
79
79
|
* @param uid User ID of the remote user.
|
|
80
80
|
* @return
|
|
81
81
|
* - 0: Success.
|
|
@@ -88,7 +88,7 @@ export declare class ISpatialAudio {
|
|
|
88
88
|
* @detail api
|
|
89
89
|
* @region Audio management
|
|
90
90
|
* @author wangjunzheng
|
|
91
|
-
* @brief Disables all spatial audio effects set by calling
|
|
91
|
+
* @brief Disables all spatial audio effects set by calling {@link updateRemotePosition updateRemotePosition} for all remote users.
|
|
92
92
|
* @return
|
|
93
93
|
* - 0: Success.
|
|
94
94
|
* - <0: Failure.
|
|
@@ -107,7 +107,7 @@ export declare class IVideoDeviceManager {
|
|
|
107
107
|
* @region Video Facility Management
|
|
108
108
|
* @author likai.666
|
|
109
109
|
* @brief Get a list of video capture devices in the current system.
|
|
110
|
-
* @return Contains a list of all video capture devices in the system. See
|
|
110
|
+
* @return Contains a list of all video capture devices in the system. See {@link VideoDeviceInfo VideoDeviceInfo}.
|
|
111
111
|
*
|
|
112
112
|
*/
|
|
113
113
|
android_enumerateVideoCaptureDevices(): $p_a.List<$p_a.VideoDeviceInfo>;
|
|
@@ -117,7 +117,7 @@ export declare class IVideoDeviceManager {
|
|
|
117
117
|
* @region Video Facility Management
|
|
118
118
|
* @author likai.666
|
|
119
119
|
* @brief Set the current video capture device
|
|
120
|
-
* @param deviceId Video device ID, which can be obtained through
|
|
120
|
+
* @param deviceId Video device ID, which can be obtained through {@link enumerateVideoCaptureDevices enumerateVideoCaptureDevices}
|
|
121
121
|
* @return
|
|
122
122
|
* - 0: Success.
|
|
123
123
|
* +! 0: failure
|
|
@@ -154,7 +154,7 @@ export declare class IKTVPlayer {
|
|
|
154
154
|
* @detail api
|
|
155
155
|
* @author lihuan.wuti2ha
|
|
156
156
|
* @brief Sets the KTV player event handler.
|
|
157
|
-
* @param playerEventHandler KTV player event handler. See
|
|
157
|
+
* @param playerEventHandler KTV player event handler. See {@link IKTVPlayerEventHandler IKTVPlayerEventHandler}.
|
|
158
158
|
*
|
|
159
159
|
*/
|
|
160
160
|
android_setPlayerEventHandler(playerEventHandler: $p_a.IKTVPlayerEventHandler): void;
|
|
@@ -164,13 +164,13 @@ export declare class IKTVPlayer {
|
|
|
164
164
|
* @brief Plays the music.
|
|
165
165
|
* @param musicId Music ID. <br>
|
|
166
166
|
* If the song with the same musicId is playing when you call this API, the music will restart from the starting position. An error will be triggered if the audio file corresponding to musicId does not exist.
|
|
167
|
-
* @param trackType Audio track type of the KTV player. See
|
|
168
|
-
* @param playType Audio play type. See
|
|
167
|
+
* @param trackType Audio track type of the KTV player. See {@link AudioTrackType AudioTrackType}.
|
|
168
|
+
* @param playType Audio play type. See {@link AudioPlayType AudioPlayType}.
|
|
169
169
|
* @note
|
|
170
|
-
* - After calling this API, you will receive the music play state through
|
|
171
|
-
* - If the music ID is invalid, you will receive the
|
|
172
|
-
* - If you didn't join the room, you will receive the
|
|
173
|
-
* - If the music file does not exist, you will receive the
|
|
170
|
+
* - After calling this API, you will receive the music play state through {@link onPlayStateChanged onPlayStateChanged} callback.
|
|
171
|
+
* - If the music ID is invalid, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3023 and a playState of 4.
|
|
172
|
+
* - If you didn't join the room, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3022 and a playState of 4.
|
|
173
|
+
* - If the music file does not exist, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3020 and a playState of 4.
|
|
174
174
|
*
|
|
175
175
|
*/
|
|
176
176
|
playMusic(musicId: string, trackType: AudioTrackType, playType: AudioPlayType): void;
|
|
@@ -180,9 +180,9 @@ export declare class IKTVPlayer {
|
|
|
180
180
|
* @brief Pauses the music.
|
|
181
181
|
* @param musicId Music ID.
|
|
182
182
|
* @note
|
|
183
|
-
* - After calling this API, you will receive the music play state through
|
|
184
|
-
* - If the music ID is invalid, you will receive the
|
|
185
|
-
* - If you didn't join the room, you will receive the
|
|
183
|
+
* - After calling this API, you will receive the music play state through {@link onPlayStateChanged onPlayStateChanged} callback.
|
|
184
|
+
* - If the music ID is invalid, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3023 and a playState of 4.
|
|
185
|
+
* - If you didn't join the room, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3022 and a playState of 4.
|
|
186
186
|
*
|
|
187
187
|
*/
|
|
188
188
|
pauseMusic(musicId: string): void;
|
|
@@ -192,9 +192,9 @@ export declare class IKTVPlayer {
|
|
|
192
192
|
* @brief Resumes playing the music.
|
|
193
193
|
* @param musicId Music ID.
|
|
194
194
|
* @note
|
|
195
|
-
* - After calling this API, you will receive the music play state through
|
|
196
|
-
* - If the music ID is invalid, you will receive the
|
|
197
|
-
* - If you didn't join the room, you will receive the
|
|
195
|
+
* - After calling this API, you will receive the music play state through {@link onPlayStateChanged onPlayStateChanged} callback.
|
|
196
|
+
* - If the music ID is invalid, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3023 and a playState of 4.
|
|
197
|
+
* - If you didn't join the room, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3022 and a playState of 4.
|
|
198
198
|
*
|
|
199
199
|
*/
|
|
200
200
|
resumeMusic(musicId: string): void;
|
|
@@ -204,9 +204,9 @@ export declare class IKTVPlayer {
|
|
|
204
204
|
* @brief Stops playing the music.
|
|
205
205
|
* @param musicId Music ID.
|
|
206
206
|
* @note
|
|
207
|
-
* - After calling this API, you will receive the music play state through
|
|
208
|
-
* - If the music ID is invalid, you will receive the
|
|
209
|
-
* - If you didn't join the room, you will receive the
|
|
207
|
+
* - After calling this API, you will receive the music play state through {@link onPlayStateChanged onPlayStateChanged} callback.
|
|
208
|
+
* - If the music ID is invalid, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3023 and a playState of 4.
|
|
209
|
+
* - If you didn't join the room, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3022 and a playState of 4.
|
|
210
210
|
*
|
|
211
211
|
*/
|
|
212
212
|
stopMusic(musicId: string): void;
|
|
@@ -218,9 +218,9 @@ export declare class IKTVPlayer {
|
|
|
218
218
|
* @param position The starting position of the music file in milliseconds. The value must be less than the total length of the music.
|
|
219
219
|
* @note
|
|
220
220
|
* - The music must be playing when you call this API.
|
|
221
|
-
* - After calling this API, you will receive the music play state through
|
|
222
|
-
* - If the music ID is invalid, you will receive the
|
|
223
|
-
* - If you didn't join the room, you will receive the
|
|
221
|
+
* - After calling this API, you will receive the music play state through {@link onPlayStateChanged onPlayStateChanged} callback.
|
|
222
|
+
* - If the music ID is invalid, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3023 and a playState of 4.
|
|
223
|
+
* - If you didn't join the room, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3022 and a playState of 4.
|
|
224
224
|
*
|
|
225
225
|
*/
|
|
226
226
|
seekMusic(musicId: string, position: number): void;
|
|
@@ -236,8 +236,8 @@ export declare class IKTVPlayer {
|
|
|
236
236
|
* @note
|
|
237
237
|
* - The music must be playing when you call this API.
|
|
238
238
|
* - If the set volume is greater than 400, it will be adjusted by the maximum value of 400; if the set volume is less than 0, it will be adjusted by the minimum value of 0.
|
|
239
|
-
* - If the music ID is invalid, you will receive the
|
|
240
|
-
* - If you didn't join the room, you will receive the
|
|
239
|
+
* - If the music ID is invalid, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3023 and a playState of 4.
|
|
240
|
+
* - If you didn't join the room, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3022 and a playState of 4.
|
|
241
241
|
*
|
|
242
242
|
*/
|
|
243
243
|
setMusicVolume(musicId: string, volume: number): void;
|
|
@@ -260,8 +260,8 @@ export declare class IKTVPlayer {
|
|
|
260
260
|
* @note
|
|
261
261
|
* - The music must be in the playing when you call this API.
|
|
262
262
|
* - If the set pitch is greater than 12, it will be adjusted by the maximum value of 12; if the set pitch is less than –12, it will be adjusted by the minimum value of –12.
|
|
263
|
-
* - If the music ID is invalid, you will receive the
|
|
264
|
-
* - If you didn't join the room, you will receive the
|
|
263
|
+
* - If the music ID is invalid, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3023 and a playState of 4.
|
|
264
|
+
* - If you didn't join the room, you will receive the {@link onPlayStateChanged onPlayStateChanged} callback, with an errorCode of -3022 and a playState of 4.
|
|
265
265
|
*
|
|
266
266
|
*/
|
|
267
267
|
setMusicPitch(musicId: string, pitch: number): void;
|
|
@@ -295,9 +295,9 @@ export declare class IVideoEffect {
|
|
|
295
295
|
* - –1002: Your Effects SDK's version is incompatible.
|
|
296
296
|
* - < 0: Other error. See [error code table](https://docs.byteplus.com/effects/docs/error-code-table) for specific instructions.
|
|
297
297
|
* @note
|
|
298
|
-
* - You must call
|
|
299
|
-
* - This API does not turn on video effects directly, you must call
|
|
300
|
-
* - Call
|
|
298
|
+
* - You must call {@link initCVResource initCVResource} before calling this API.
|
|
299
|
+
* - This API does not turn on video effects directly, you must call {@link setEffectNodes setEffectNodes} or {@link setColorFilter setColorFilter} next.
|
|
300
|
+
* - Call {@link disableVideoEffect disableVideoEffect} to turn off video effects.
|
|
301
301
|
*
|
|
302
302
|
*/
|
|
303
303
|
enableVideoEffect(): number;
|
|
@@ -311,7 +311,7 @@ export declare class IVideoEffect {
|
|
|
311
311
|
* - –1001: This API is unavailable for your Effects SDK.
|
|
312
312
|
* - –1002: Your Effects SDK's version is incompatible.
|
|
313
313
|
* - < 0: Other error. See [error code table](https://docs.byteplus.com/effects/docs/error-code-table) for specific instructions.
|
|
314
|
-
* @note Call
|
|
314
|
+
* @note Call {@link enableVideoEffect enableVideoEffect} to enable video effects.
|
|
315
315
|
*
|
|
316
316
|
*/
|
|
317
317
|
disableVideoEffect(): number;
|
|
@@ -327,7 +327,7 @@ export declare class IVideoEffect {
|
|
|
327
327
|
* - –1001: This API is unavailable for your Effects SDK.
|
|
328
328
|
* - –1002: Your Effects SDK's version is incompatible.
|
|
329
329
|
* - < 0: Other error. See [error code table](https://docs.byteplus.com/effects/docs/error-code-table) for specific instructions.
|
|
330
|
-
* @note You must call
|
|
330
|
+
* @note You must call {@link enableVideoEffect enableVideoEffect} before calling this API.
|
|
331
331
|
*
|
|
332
332
|
*/
|
|
333
333
|
setEffectNodes(effectNodes: Array<string>): number;
|
|
@@ -358,7 +358,7 @@ export declare class IVideoEffect {
|
|
|
358
358
|
* - –1001: This API is unavailable for your Effects SDK.
|
|
359
359
|
* - –1002: Your Effects SDK's version is incompatible.
|
|
360
360
|
* - < 0: Other error. See [error code table](https://docs.byteplus.com/effects/docs/error-code-table) for specific instructions.
|
|
361
|
-
* @note Call
|
|
361
|
+
* @note Call {@link setColorFilterIntensity setColorFilterIntensity} to set the intensity of the color filter enabled. Set the intensity to 0 to turn off color filter.
|
|
362
362
|
*
|
|
363
363
|
*/
|
|
364
364
|
setColorFilter(filterRes: string): number;
|
|
@@ -382,7 +382,7 @@ export declare class IVideoEffect {
|
|
|
382
382
|
* @author zhushufan.ref
|
|
383
383
|
* @brief Sets the original background to a specified image or a solid color.
|
|
384
384
|
* @param backgroundStickerRes The absolute path of virtual background effects.
|
|
385
|
-
* @param source Virtual background source. See
|
|
385
|
+
* @param source Virtual background source. See {@link VirtualBackgroundSource VirtualBackgroundSource}.
|
|
386
386
|
* @return
|
|
387
387
|
* - 0: Success.
|
|
388
388
|
* - –1000: The Effects SDK is not integrated.
|
|
@@ -390,8 +390,8 @@ export declare class IVideoEffect {
|
|
|
390
390
|
* - –1002: Your Effects SDK's version is incompatible.
|
|
391
391
|
* - < 0: Other error. See [error code table](https://docs.byteplus.com/effects/docs/error-code-table) for specific instructions.
|
|
392
392
|
* @note
|
|
393
|
-
* - You must call
|
|
394
|
-
* - Call
|
|
393
|
+
* - You must call {@link initCVResource initCVResource} before calling this API.
|
|
394
|
+
* - Call {@link disableVirtualBackground disableVirtualBackground} to turn off the virtual background.
|
|
395
395
|
*
|
|
396
396
|
*/
|
|
397
397
|
enableVirtualBackground(backgroundStickerRes: string, source: VirtualBackgroundSource): number;
|
|
@@ -405,7 +405,7 @@ export declare class IVideoEffect {
|
|
|
405
405
|
* - –1001: This API is unavailable for your Effects SDK.
|
|
406
406
|
* - –1002: Your Effects SDK's version is incompatible.
|
|
407
407
|
* - < 0: Other error. See [error code table](https://docs.byteplus.com/effects/docs/error-code-table) for specific instructions.
|
|
408
|
-
* @note After calling
|
|
408
|
+
* @note After calling {@link enableVirtualBackground enableVirtualBackground} to enable the virtual background function, you can call this API to turn it off.
|
|
409
409
|
*
|
|
410
410
|
*/
|
|
411
411
|
disableVirtualBackground(): number;
|
|
@@ -413,8 +413,8 @@ export declare class IVideoEffect {
|
|
|
413
413
|
* @detail api
|
|
414
414
|
* @author wangjunlin.3182
|
|
415
415
|
* @brief Starts face detection and registers the observer for the result. <br>
|
|
416
|
-
* With this observer, you will receive
|
|
417
|
-
* @param observer See
|
|
416
|
+
* With this observer, you will receive {@link onFaceDetectResult onFaceDetectResult} periodically.
|
|
417
|
+
* @param observer See {@link IFaceDetectionObserver IFaceDetectionObserver}.
|
|
418
418
|
* @param intervalMs The minimum time interval between two callbacks in milliseconds. The value should be greater than 0. The actual time interval is between interval_ms and interval_ms+the time slot of a captured video frame.
|
|
419
419
|
* @param faceModelPath The absolute path of the face detection algorithm file. Typically it is the tt_face_vXXX.model file in the ttfacemodel folder.
|
|
420
420
|
* @return
|
|
@@ -451,12 +451,12 @@ export declare class RTCVideo {
|
|
|
451
451
|
* This is the very first API that you must call if you want to use all the RTC capabilities. <br>
|
|
452
452
|
* If there is no engine instance in current process, calling this API will create one. If an engine instance has been created, calling this API again will have the created engine instance returned.
|
|
453
453
|
* @param context Android application context
|
|
454
|
-
* @param handler Handler sent from SDK to App. See
|
|
455
|
-
* @param config SDK Engine Config,see
|
|
454
|
+
* @param handler Handler sent from SDK to App. See {@link IRTCVideoEventHandler IRTCVideoEventHandler}
|
|
455
|
+
* @param config SDK Engine Config,see {@link EngineConfig EngineConfig}
|
|
456
456
|
* @return
|
|
457
457
|
* - RTCVideo: A successfully created engine instance.
|
|
458
|
-
* - Null: EngineConfig is inValid see
|
|
459
|
-
* @note The lifecycle of the handler must be longer than that of the RTCVideo, i.e. the handler must be created before calling
|
|
458
|
+
* - Null: EngineConfig is inValid see {@link EngineConfig EngineConfig}. Failed to load the so file
|
|
459
|
+
* @note The lifecycle of the handler must be longer than that of the RTCVideo, i.e. the handler must be created before calling {@link createRTCVideo createRTCVideo} and destroyed after calling {@link destroyRTCVideo destroyRTCVideo}.
|
|
460
460
|
* @order 1
|
|
461
461
|
*
|
|
462
462
|
*/
|
|
@@ -465,7 +465,7 @@ export declare class RTCVideo {
|
|
|
465
465
|
* @detail api
|
|
466
466
|
* @region Engine management
|
|
467
467
|
* @author wangzhanqiang
|
|
468
|
-
* @brief Destroy the engine instance created by
|
|
468
|
+
* @brief Destroy the engine instance created by {@link createRTCVideo createRTCVideo}, and release all related resources.
|
|
469
469
|
* @note
|
|
470
470
|
* - Call this API after all business scenarios related to the engine instance are destroyed.
|
|
471
471
|
* - When the API is called, RTC SDK destroys all memory associated with the engine instance and stops any interaction with the media server.
|
|
@@ -489,12 +489,12 @@ export declare class RTCVideo {
|
|
|
489
489
|
* @region Engine Management
|
|
490
490
|
* @author caofanglu
|
|
491
491
|
* @brief Configures the local log parameters of RTC SDK, including the logging level, directory, the limits for total log file size, and the prefix to the log file.
|
|
492
|
-
* @param logConfig Local log parameters. See
|
|
492
|
+
* @param logConfig Local log parameters. See {@link RTCLogConfig RTCLogConfig}.
|
|
493
493
|
* @return
|
|
494
494
|
* - 0: Success.
|
|
495
495
|
* - –1: Failure. This API must be called before creating engine.
|
|
496
496
|
* - –2: Failure. Invalid parameters.
|
|
497
|
-
* @note This API must be called before
|
|
497
|
+
* @note This API must be called before {@link createRTCVideo createRTCVideo}.
|
|
498
498
|
* @order 30
|
|
499
499
|
*
|
|
500
500
|
*/
|
|
@@ -504,8 +504,8 @@ export declare class RTCVideo {
|
|
|
504
504
|
* @region Engine management
|
|
505
505
|
* @author panjian.fishing
|
|
506
506
|
* @brief Gets the description text of different error codes and warning codes in the SDK.
|
|
507
|
-
* @param code The values obtained through
|
|
508
|
-
* For details, please refer to
|
|
507
|
+
* @param code The values obtained through {@link onWarning onWarning} and {@link onError onError} callbacks, <br>
|
|
508
|
+
* For details, please refer to {@link ErrorCode ErrorCode} and {@link WarningCode WarningCode}
|
|
509
509
|
* @return String Description text
|
|
510
510
|
* @order 15
|
|
511
511
|
*
|
|
@@ -520,14 +520,14 @@ export declare class RTCVideo {
|
|
|
520
520
|
* @detail api
|
|
521
521
|
* @region Engine Management
|
|
522
522
|
* @author wangzhanqiang
|
|
523
|
-
* @brief The receiving class that sets engine event callbacks must inherit from
|
|
523
|
+
* @brief The receiving class that sets engine event callbacks must inherit from {@link IRTCVideoEventHandler IRTCVideoEventHandler}.
|
|
524
524
|
* @param engineEventHandler <br>
|
|
525
|
-
* Event processor interface class. See
|
|
525
|
+
* Event processor interface class. See {@link IRTCVideoEventHandler IRTCVideoEventHandler}.
|
|
526
526
|
* @return
|
|
527
527
|
* - 0: Success.
|
|
528
|
-
* - < 0 : Fail. See
|
|
528
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
529
529
|
* @note
|
|
530
|
-
* - The caller needs to implement a class that inherits from
|
|
530
|
+
* - The caller needs to implement a class that inherits from {@link IRTCVideoEventHandler IRTCVideoEventHandler} and override the events that need attention.
|
|
531
531
|
* - The callback is asynchronous recall
|
|
532
532
|
* - All event callbacks will be triggered in a separate callback thread. Please pay attention to all operations related to the thread running environment when receiving callback events, such as operations that need to be performed in the UI thread.
|
|
533
533
|
* Do not directly operate in the implementation of the callback function.
|
|
@@ -540,7 +540,7 @@ export declare class RTCVideo {
|
|
|
540
540
|
* @detail api
|
|
541
541
|
* @author dixing
|
|
542
542
|
* @brief Gets audio device management API class.
|
|
543
|
-
* @return See
|
|
543
|
+
* @return See {@link IRTCAudioDeviceManager IRTCAudioDeviceManager}.
|
|
544
544
|
*
|
|
545
545
|
*/
|
|
546
546
|
android_getAudioDeviceManager(): $p_a.IRTCAudioDeviceManager;
|
|
@@ -550,17 +550,17 @@ export declare class RTCVideo {
|
|
|
550
550
|
* @author zhangzhenyu.samuel
|
|
551
551
|
* @brief Enable internal video capture immediately. The default setting is off. <br>
|
|
552
552
|
* Internal video capture refers to: capturing video using the built-in module. <br>
|
|
553
|
-
* The local client will be informed via
|
|
554
|
-
* The remote clients in the room will be informed of the state change via
|
|
553
|
+
* The local client will be informed via {@link onVideoDeviceStateChanged onVideoDeviceStateChanged} after starting video capture by calling this API. <br>
|
|
554
|
+
* The remote clients in the room will be informed of the state change via {@link onUserStartVideoCapture onUserStartVideoCapture} after the visible client starts video capture by calling this API.
|
|
555
555
|
* @return
|
|
556
556
|
* - 0: Success.
|
|
557
|
-
* - < 0 : Fail. See
|
|
557
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
558
558
|
* @note
|
|
559
559
|
* - Since the upgrade in v3.37.0, you need to add Kotlin plugin to Gradle in the project to use this API.
|
|
560
|
-
* - Call
|
|
560
|
+
* - Call {@link stopVideoCapture stopVideoCapture} to stop the internal video capture. Otherwise, the internal video capture will sustain until you destroy the engine instance.
|
|
561
561
|
* - Once you create the engine instance, you can start internal video capture regardless of the video publishing state. The video stream will start publishing only after the video capture starts.
|
|
562
562
|
* - To switch from custom to internal video capture, stop publishing before disabling the custom video capture module and then call this API to enable the internal video capture.
|
|
563
|
-
* - Call
|
|
563
|
+
* - Call {@link switchCamera switchCamera} to switch the camera used by the internal video capture module.
|
|
564
564
|
* - If the default video format can not meet your requirement, contact our technical specialist to help you with Cloud Config. After that, you can push and apply these configurations to Android clients at any time.
|
|
565
565
|
*
|
|
566
566
|
*/
|
|
@@ -571,13 +571,13 @@ export declare class RTCVideo {
|
|
|
571
571
|
* @author zhangzhenyu.samuel
|
|
572
572
|
* @brief Disable internal video capture immediately. The default is off. <br>
|
|
573
573
|
* Internal video capture refers to: capturing video using the built-in module. <br>
|
|
574
|
-
* The local client will be informed via
|
|
575
|
-
* The remote clients in the room will be informed of the state change via
|
|
574
|
+
* The local client will be informed via {@link onVideoDeviceStateChanged onVideoDeviceStateChanged} after stopping video capture by calling this API. <br>
|
|
575
|
+
* The remote clients in the room will be informed of the state change via {@link onUserStopVideoCapture onUserStopVideoCapture} after the visible client stops video capture by calling this API.
|
|
576
576
|
* @return
|
|
577
577
|
* - 0: Success.
|
|
578
|
-
* - < 0 : Fail. See
|
|
578
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
579
579
|
* @note
|
|
580
|
-
* - Call startVideoCapture {@link
|
|
580
|
+
* - Call startVideoCapture {@link startVideoCapture} to enable the internal video capture.
|
|
581
581
|
* - Without calling this API the internal video capture will sustain until you destroy the engine instance.
|
|
582
582
|
*
|
|
583
583
|
*/
|
|
@@ -588,15 +588,15 @@ export declare class RTCVideo {
|
|
|
588
588
|
* @author dixing
|
|
589
589
|
* @brief Start internal audio capture. The default is off. <br>
|
|
590
590
|
* Internal audio capture refers to: capturing audio using the built-in module. <br>
|
|
591
|
-
* The local client will be informed via
|
|
592
|
-
* The remote clients in the room will be informed of the state change via
|
|
591
|
+
* The local client will be informed via {@link onAudioDeviceStateChanged onAudioDeviceStateChanged} after starting audio capture by calling this API. <br>
|
|
592
|
+
* The remote clients in the room will be informed of the state change via {@link onUserStartAudioCapture onUserStartAudioCapture} after the visible user starts audio capture by calling this API.
|
|
593
593
|
* @return
|
|
594
594
|
* - 0: Success.
|
|
595
|
-
* - < 0 : Fail. See
|
|
595
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
596
596
|
* @note
|
|
597
|
-
* - To enable a microphone without the user's permission will trigger
|
|
598
|
-
* - Call
|
|
599
|
-
* - To mute and unmute microphones, we recommend using
|
|
597
|
+
* - To enable a microphone without the user's permission will trigger {@link onAudioDeviceStateChanged onAudioDeviceStateChanged}.
|
|
598
|
+
* - Call {@link stopAudioCapture stopAudioCapture} to stop the internal audio capture. Otherwise, the internal audio capture will sustain until you destroy the engine instance.
|
|
599
|
+
* - To mute and unmute microphones, we recommend using {@link publishStream publishStream} and {@link unpublishStream unpublishStream}, other than {@link stopAudioCapture stopAudioCapture} and this API. Because starting and stopping capture devices often need some time waiting for the response of the device, that may lead to a short silence during the communication.
|
|
600
600
|
* - To switch from custom to internal audio capture, stop publishing before disabling the custom audio capture module and then call this API to enable the internal audio capture.
|
|
601
601
|
*
|
|
602
602
|
*/
|
|
@@ -607,13 +607,13 @@ export declare class RTCVideo {
|
|
|
607
607
|
* @author dixing
|
|
608
608
|
* @brief Stop internal audio capture. The default is off. <br>
|
|
609
609
|
* Internal audio capture refers to: capturing audio using the built-in module. <br>
|
|
610
|
-
* The local client will be informed via
|
|
611
|
-
* The remote clients in the room will be informed of the state change via
|
|
610
|
+
* The local client will be informed via {@link onAudioDeviceStateChanged onAudioDeviceStateChanged} after stopping audio capture by calling this API. <br>
|
|
611
|
+
* The remote clients in the room will be informed of the state change via {@link onUserStopAudioCapture onUserStopAudioCapture} after the visible client stops audio capture by calling this API.
|
|
612
612
|
* @return
|
|
613
613
|
* - 0: Success.
|
|
614
|
-
* - < 0 : Fail. See
|
|
614
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
615
615
|
* @note
|
|
616
|
-
* - Call
|
|
616
|
+
* - Call {@link startAudioCapture startAudioCapture} to enable the internal audio capture.
|
|
617
617
|
* - Without calling this API the internal audio capture will sustain until you destroy the engine instance.
|
|
618
618
|
*
|
|
619
619
|
*/
|
|
@@ -625,10 +625,10 @@ export declare class RTCVideo {
|
|
|
625
625
|
* @brief Sets the audio scenarios. <br>
|
|
626
626
|
* You can choose the appropriate audio scenario according to your application. <br>
|
|
627
627
|
* After selecting the audio scenario, the SDK will automatically apply the call volume/media volume based on the client's audio capture and playback devices and status, and synchronously change the corresponding audio-related algorithm configurations and capture settings.
|
|
628
|
-
* @param audioScenario Audio scenarios. See
|
|
628
|
+
* @param audioScenario Audio scenarios. See {@link AudioScenarioType AudioScenarioType}.
|
|
629
629
|
* @return
|
|
630
630
|
* - 0: Success.
|
|
631
|
-
* - < 0 : Fail. See
|
|
631
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
632
632
|
* @note
|
|
633
633
|
* - It is recommended to call this API before joining the room and calling other audio related interfaces. If this API is called afterwards, audio lag may be introduced.
|
|
634
634
|
* - Call volume is more suitable for calls, meetings and other scenarios that demand information accuracy. Call volume will activate the system hardware signal processor, making the sound clearer. The volume cannot be reduced to 0.
|
|
@@ -640,11 +640,11 @@ export declare class RTCVideo {
|
|
|
640
640
|
* @detail api
|
|
641
641
|
* @region audio management
|
|
642
642
|
* @author zhangyuanyuan.0101
|
|
643
|
-
* @brief Sets the sound quality. Call this API to change the sound quality if the audio settings in the current
|
|
644
|
-
* @param audioProfile Sound quality. See
|
|
643
|
+
* @brief Sets the sound quality. Call this API to change the sound quality if the audio settings in the current {@link ChannelProfile ChannelProfile} can not meet your requirements.
|
|
644
|
+
* @param audioProfile Sound quality. See {@link AudioProfileType AudioProfileType}
|
|
645
645
|
* @return
|
|
646
646
|
* - 0: Success.
|
|
647
|
-
* - < 0 : Fail. See
|
|
647
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
648
648
|
* @note
|
|
649
649
|
* - This method can be called before and after entering the room.
|
|
650
650
|
* - Support dynamic switching of sound quality during a call.
|
|
@@ -656,14 +656,14 @@ export declare class RTCVideo {
|
|
|
656
656
|
* @region audio management
|
|
657
657
|
* @author liuchuang
|
|
658
658
|
* @brief Set the Active Noise Cancellation(ANC) mode during audio and video communications.
|
|
659
|
-
* @param ansMode ANC modes. See
|
|
659
|
+
* @param ansMode ANC modes. See {@link AnsMode AnsMode}.
|
|
660
660
|
* @return
|
|
661
661
|
* - 0: Success.
|
|
662
|
-
* - < 0 : Fail. See
|
|
662
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
663
663
|
* @note
|
|
664
664
|
* - You can call this API before or after entering a room. When you repeatedly call it, only the last call takes effect.
|
|
665
665
|
* - The noise reduction algorithm includes both traditional noise reduction and AI noise reduction. Traditional noise reduction is primarily aimed at suppressing steady noises, such as the hum of air conditioners and the whir of fans. AI noise reduction, on the other hand, is mainly designed to suppress non-stationary noises, like the tapping of keyboards and the clattering of tables and chairs.
|
|
666
|
-
* - Before version V3.57.1, AI noise reduction can only be enabled through this interface when the following
|
|
666
|
+
* - Before version V3.57.1, AI noise reduction can only be enabled through this interface when the following {@link ChannelProfile ChannelProfile} scenarios are engaged:
|
|
667
667
|
* - Gaming voice mode: `CHANNEL_PROFILE_GAME(2)`
|
|
668
668
|
* - High-fidelity gaming mode: `CHANNEL_PROFILE_GAME_HD(8)`
|
|
669
669
|
* - Cloud gaming mode: `CHANNEL_PROFILE_CLOUD_GAME(3)`
|
|
@@ -681,16 +681,16 @@ export declare class RTCVideo {
|
|
|
681
681
|
* @region American Sound Effect Management
|
|
682
682
|
* @author wangjunzheng
|
|
683
683
|
* @brief Set the sound change effect type
|
|
684
|
-
* @param voiceChanger The sound change effect type. See
|
|
684
|
+
* @param voiceChanger The sound change effect type. See {@link VoiceChangerType VoiceChangerType}
|
|
685
685
|
* @return API call result: <br>
|
|
686
686
|
* - 0: Success.
|
|
687
|
-
* - <0: Failure. See
|
|
687
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
688
688
|
* @note
|
|
689
689
|
* - To use this feature, you need to integrate the SAMI library. See [On-Demand Plugin Integration](#1108726).
|
|
690
690
|
* - You can call it before and after entering the room.
|
|
691
691
|
* - Effective for both internal and external audio source.
|
|
692
692
|
* - Only valid for mono-channel audio.
|
|
693
|
-
* - Mutually exclusive with
|
|
693
|
+
* - Mutually exclusive with {@link setVoiceReverbType setVoiceReverbType}, and the effects set later will override the effects set first.
|
|
694
694
|
*
|
|
695
695
|
*/
|
|
696
696
|
setVoiceChangerType(voiceChanger: VoiceChangerType): number;
|
|
@@ -700,15 +700,15 @@ export declare class RTCVideo {
|
|
|
700
700
|
* @region Bel Sound Effect Management
|
|
701
701
|
* @author wangjunzheng
|
|
702
702
|
* @brief Set the reverb effect type
|
|
703
|
-
* @param voiceReverb Reverb effect type. See
|
|
703
|
+
* @param voiceReverb Reverb effect type. See {@link VoiceReverbType VoiceReverbType}
|
|
704
704
|
* @return API call result: <br>
|
|
705
705
|
* - 0: Success.
|
|
706
|
-
* - <0: Failure. See
|
|
706
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
707
707
|
* @note
|
|
708
708
|
* - You can call it before and after entering the room.
|
|
709
709
|
* - Effective for both internal and external audio source.
|
|
710
710
|
* - Only valid for mono-channel audio.
|
|
711
|
-
* - Mutually exclusive with
|
|
711
|
+
* - Mutually exclusive with {@link setVoiceChangerType setVoiceChangerType}, and the effects set later will override the effects set first.
|
|
712
712
|
*
|
|
713
713
|
*/
|
|
714
714
|
setVoiceReverbType(voiceReverb: VoiceReverbType): number;
|
|
@@ -716,7 +716,7 @@ export declare class RTCVideo {
|
|
|
716
716
|
* @detail api
|
|
717
717
|
* @author wangjunzheng
|
|
718
718
|
* @brief Set the equalization effect for the local captured audio. The audio includes both internal captured audio and external captured voice, but not the mixing audio file.
|
|
719
|
-
* @param voiceEqualizationConfig See
|
|
719
|
+
* @param voiceEqualizationConfig See {@link VoiceEqualizationConfig VoiceEqualizationConfig}.
|
|
720
720
|
* @return
|
|
721
721
|
* - 0: Success.
|
|
722
722
|
* - < 0: Failure.
|
|
@@ -728,11 +728,11 @@ export declare class RTCVideo {
|
|
|
728
728
|
* @detail api
|
|
729
729
|
* @author wangjunzheng
|
|
730
730
|
* @brief Set the reverb effect for the local captured audio. The audio includes both internal captured audio and external captured voice, but not the mixing audio file.
|
|
731
|
-
* @param config See
|
|
731
|
+
* @param config See {@link VoiceReverbConfig VoiceReverbConfig}.
|
|
732
732
|
* @return
|
|
733
733
|
* - 0: Success.
|
|
734
734
|
* - < 0: Failure.
|
|
735
|
-
* @note Call
|
|
735
|
+
* @note Call {@link enableLocalVoiceReverb enableLocalVoiceReverb} to enable the reverb effect.
|
|
736
736
|
*
|
|
737
737
|
*/
|
|
738
738
|
setLocalVoiceReverbParam(config: VoiceReverbConfig): number;
|
|
@@ -744,7 +744,7 @@ export declare class RTCVideo {
|
|
|
744
744
|
* @return
|
|
745
745
|
* - 0: Success.
|
|
746
746
|
* - < 0: Failure.
|
|
747
|
-
* @note Call
|
|
747
|
+
* @note Call {@link setLocalVoiceReverbParam setLocalVoiceReverbParam} to set the reverb effect.
|
|
748
748
|
*
|
|
749
749
|
*/
|
|
750
750
|
enableLocalVoiceReverb(enable: boolean): number;
|
|
@@ -754,7 +754,7 @@ export declare class RTCVideo {
|
|
|
754
754
|
* @author sunhang.io
|
|
755
755
|
* @brief Sets the view to be used for local video rendering and the rendering mode.
|
|
756
756
|
* @param streamIndex Video stream type. See [StreamIndex](70083#streamindex-2).
|
|
757
|
-
* @param videoCanvas View information and rendering mode. See
|
|
757
|
+
* @param videoCanvas View information and rendering mode. See {@link VideoCanvas VideoCanvas}.
|
|
758
758
|
* @return
|
|
759
759
|
* - 0: Success
|
|
760
760
|
* - -1: videoCanvas is empty
|
|
@@ -770,11 +770,11 @@ export declare class RTCVideo {
|
|
|
770
770
|
* @author wangfujun.911
|
|
771
771
|
* @brief Update the render mode and background color of local video rendering
|
|
772
772
|
* @param streamIndex See [StreamIndex](70083#streamindex-2)
|
|
773
|
-
* @param renderMode See
|
|
774
|
-
* @param backgroundColor See
|
|
773
|
+
* @param renderMode See {@link VideoCanvas VideoCanvas}.renderMode
|
|
774
|
+
* @param backgroundColor See {@link VideoCanvas VideoCanvas}.backgroundColor
|
|
775
775
|
* @return
|
|
776
776
|
* - 0: Success.
|
|
777
|
-
* - < 0 : Fail. See
|
|
777
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
778
778
|
* @note Calling this API during local video rendering will be effective immediately.
|
|
779
779
|
*
|
|
780
780
|
*/
|
|
@@ -785,13 +785,13 @@ export declare class RTCVideo {
|
|
|
785
785
|
* @region Video management
|
|
786
786
|
* @author zhongshenyou
|
|
787
787
|
* @brief Modifies remote video frame rendering settings, including render mode, background color, and rotation angle, while using the internal rendering of the SDK.
|
|
788
|
-
* @param streamKey Information about the remote stream. See
|
|
789
|
-
* @param remoteVideoRenderConfig Video rendering settings. See
|
|
788
|
+
* @param streamKey Information about the remote stream. See {@link RemoteStreamKey RemoteStreamKey}.
|
|
789
|
+
* @param remoteVideoRenderConfig Video rendering settings. See {@link RemoteVideoRenderConfig RemoteVideoRenderConfig}.
|
|
790
790
|
* @return
|
|
791
791
|
* - 0: Success.
|
|
792
|
-
* - < 0 : Failure. See
|
|
792
|
+
* - < 0 : Failure. See {@link ReturnStatus ReturnStatus} for more details
|
|
793
793
|
* @note
|
|
794
|
-
* - After setting the rendering configuration for the remote video frame with
|
|
794
|
+
* - After setting the rendering configuration for the remote video frame with {@link setRemoteVideoCanvas setRemoteVideoCanvas}, you can call this API to update settings including render mode, background color, and rotation angle.
|
|
795
795
|
* - Calling this API during remote video rendering will be effective immediately.
|
|
796
796
|
*
|
|
797
797
|
*/
|
|
@@ -802,11 +802,11 @@ export declare class RTCVideo {
|
|
|
802
802
|
* @author sunhang.io
|
|
803
803
|
* @brief Sets the view to be used for remote video rendering and the rendering mode. <br>
|
|
804
804
|
* To unbind the canvas, set `videoCanvas` to Null.
|
|
805
|
-
* @param streamKey See
|
|
806
|
-
* @param videoCanvas View information and rendering mode. See
|
|
805
|
+
* @param streamKey See {@link RemoteStreamKey RemoteStreamKey}.
|
|
806
|
+
* @param videoCanvas View information and rendering mode. See {@link VideoCanvas VideoCanvas}. Starting from version 3.56, you can set the rotation angle of the remote video rendering using `renderRotation`.
|
|
807
807
|
* @return
|
|
808
808
|
* - 0: Success.
|
|
809
|
-
* - < 0 : Fail. See
|
|
809
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
810
810
|
* @note When the local user leaves the room, the setting will be invalid. The remote user leaving the room does not affect the setting.
|
|
811
811
|
*
|
|
812
812
|
*/
|
|
@@ -817,14 +817,14 @@ export declare class RTCVideo {
|
|
|
817
817
|
* @region Audio & Video Processing
|
|
818
818
|
* @author yinkaisheng
|
|
819
819
|
* @brief Sets the super resolution mode for remote video stream.
|
|
820
|
-
* @param streamKey Remote stream information that specifies the source and type of the video stream. See
|
|
821
|
-
* @param mode Super resolution mode. See
|
|
820
|
+
* @param streamKey Remote stream information that specifies the source and type of the video stream. See {@link RemoteStreamKey RemoteStreamKey}.
|
|
821
|
+
* @param mode Super resolution mode. See {@link VideoSuperResolutionMode VideoSuperResolutionMode}.
|
|
822
822
|
* @return. <br>
|
|
823
|
-
* - 0: RETURN_STATUS_SUCCESS. It does not indicate the actual status of the super resolution mode, you should refer to
|
|
823
|
+
* - 0: RETURN_STATUS_SUCCESS. It does not indicate the actual status of the super resolution mode, you should refer to {@link onRemoteVideoSuperResolutionModeChanged onRemoteVideoSuperResolutionModeChanged} callback.
|
|
824
824
|
* - -1: RETURN_STATUS_NATIVE_IN_VALID. Native library is not loaded.
|
|
825
825
|
* - -2: RETURN_STATUS_PARAMETER_ERR. Invalid parameter.
|
|
826
826
|
* - -9: RETURN_STATUS_SCREEN_NOT_SUPPORT. Failure. Screen stream is not supported.
|
|
827
|
-
* See
|
|
827
|
+
* See {@link ReturnStatus ReturnStatus} for more return value indications.
|
|
828
828
|
* @note
|
|
829
829
|
* - Call this API after joining room.
|
|
830
830
|
* - The original resolution of the remote video stream should not exceed 640 × 360 pixels.
|
|
@@ -839,9 +839,9 @@ export declare class RTCVideo {
|
|
|
839
839
|
* @region Audio & Video Processing
|
|
840
840
|
* @author Yujianli
|
|
841
841
|
* @brief Sets the video noise reduction mode.
|
|
842
|
-
* @param mode Video noise reduction mode. Refer to
|
|
842
|
+
* @param mode Video noise reduction mode. Refer to {@link VideoDenoiseMode VideoDenoiseMode} for more details.
|
|
843
843
|
* @return
|
|
844
|
-
* - 0: Success. Please refer to
|
|
844
|
+
* - 0: Success. Please refer to {@link onVideoDenoiseModeChanged onVideoDenoiseModeChanged} callback for the actual state of video noise reduction mode.
|
|
845
845
|
* - < 0: Failure.
|
|
846
846
|
*
|
|
847
847
|
*/
|
|
@@ -851,10 +851,10 @@ export declare class RTCVideo {
|
|
|
851
851
|
* @region Video management
|
|
852
852
|
* @author wangjunlin.3182
|
|
853
853
|
* @brief Sets the mirror mode for the captured video stream.
|
|
854
|
-
* @param mirrorType Mirror type. See
|
|
854
|
+
* @param mirrorType Mirror type. See {@link MirrorType MirrorType}.
|
|
855
855
|
* @return
|
|
856
856
|
* - 0: Success.
|
|
857
|
-
* - < 0 : Fail. See
|
|
857
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
858
858
|
* @note
|
|
859
859
|
* - Switching video streams does not affect the settings of the mirror type.
|
|
860
860
|
* - This API is not applicable to screen-sharing streams.
|
|
@@ -873,11 +873,11 @@ export declare class RTCVideo {
|
|
|
873
873
|
* @valid since 3.57
|
|
874
874
|
* @region Video Management
|
|
875
875
|
* @brief When using internal rendering, enable mirroring for the remote stream.
|
|
876
|
-
* @param remoteStreamKey Information about the remote stream, used to specify the source and attributes of the video stream that needs to be mirrored, see
|
|
877
|
-
* @param mirrorType The mirror type for the remote stream, see
|
|
876
|
+
* @param remoteStreamKey Information about the remote stream, used to specify the source and attributes of the video stream that needs to be mirrored, see {@link RemoteStreamKey RemoteStreamKey}.
|
|
877
|
+
* @param mirrorType The mirror type for the remote stream, see {@link RemoteMirrorType RemoteMirrorType}.
|
|
878
878
|
* @return
|
|
879
879
|
* - 0: Successful call.
|
|
880
|
-
* - < 0: Call failed, see
|
|
880
|
+
* - < 0: Call failed, see {@link ReturnStatus ReturnStatus} for more error details.
|
|
881
881
|
*
|
|
882
882
|
*/
|
|
883
883
|
setRemoteVideoMirrorType(remoteStreamKey: RemoteStreamKey, mirrorType: RemoteMirrorType): number;
|
|
@@ -886,10 +886,10 @@ export declare class RTCVideo {
|
|
|
886
886
|
* @region Video Management
|
|
887
887
|
* @brief Set the orientation of the video capture. By default, the App direction is used as the orientation reference. <br>
|
|
888
888
|
* During rendering, the receiving client rotates the video in the same way as the sending client did.
|
|
889
|
-
* @param rotationMode Rotation reference can be the orientation of the App or gravity. Refer to
|
|
889
|
+
* @param rotationMode Rotation reference can be the orientation of the App or gravity. Refer to {@link VideoRotationMode VideoRotationMode} for details.
|
|
890
890
|
* @return
|
|
891
891
|
* - 0: Success.
|
|
892
|
-
* - < 0 : Fail. See
|
|
892
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
893
893
|
* @note
|
|
894
894
|
* - The orientation setting is effective for internal video capture only. That is, the orientation setting is not effective to the custom video source or the screen-sharing stream.
|
|
895
895
|
* - If the video capture is on, the setting will be effective once you call this API. If the video capture is off, the setting will be effective on when capture starts.
|
|
@@ -901,8 +901,8 @@ export declare class RTCVideo {
|
|
|
901
901
|
* @region Video Management
|
|
902
902
|
* @author zhangzhenyu.samuel
|
|
903
903
|
* @brief Switch to the front-facing/back-facing camera used in the internal video capture <br>
|
|
904
|
-
* The local client will be informed via
|
|
905
|
-
* @param cameraId Camera ID. Refer to
|
|
904
|
+
* The local client will be informed via {@link onVideoDeviceStateChanged onVideoDeviceStateChanged} after calling this API.
|
|
905
|
+
* @param cameraId Camera ID. Refer to {@link CameraId CameraId} for more details.
|
|
906
906
|
* @return
|
|
907
907
|
* - 0: Success
|
|
908
908
|
* - < 0: Failure
|
|
@@ -915,17 +915,17 @@ export declare class RTCVideo {
|
|
|
915
915
|
/** {en}
|
|
916
916
|
* @detail api
|
|
917
917
|
* @author dixing
|
|
918
|
-
* @brief Set the current audio playback route. The default device is set via
|
|
919
|
-
* When the audio playback route changes, you will receive
|
|
920
|
-
* @param audioRoute Audio route. Refer to
|
|
918
|
+
* @brief Set the current audio playback route. The default device is set via {@link setDefaultAudioRoute setDefaultAudioRoute}. <br>
|
|
919
|
+
* When the audio playback route changes, you will receive {@link onAudioRouteChanged onAudioRouteChanged}.
|
|
920
|
+
* @param audioRoute Audio route. Refer to {@link AudioRoute AudioRoute}. <br>
|
|
921
921
|
* For Android device, the valid audio playback devices may vary due to different audio device connection status. See [Set the Audio Route](https://docs.byteplus.com/byteplus-rtc/docs/117836).
|
|
922
922
|
* @return
|
|
923
923
|
* - 0: Success.
|
|
924
|
-
* - < 0 : Fail. See
|
|
924
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
925
925
|
* @note
|
|
926
|
-
* - You can implement most scenarios by calling
|
|
927
|
-
* - This interface is only supported in the `AUDIO_SCENARIO_COMMUNICATION` audio scenario. Call
|
|
928
|
-
* - For the volume type in different audio scenarios, refer to
|
|
926
|
+
* - You can implement most scenarios by calling {@link setDefaultAudioRoute setDefaultAudioRoute} and the default audio route switching strategy of the RTC SDK. For details about the strategy, see [Set the Audio Route](https://docs.byteplus.com/byteplus-rtc/docs/117836). You should use this API in a few exceptional scenarios like manually switching audio route with external audio device connected.
|
|
927
|
+
* - This interface is only supported in the `AUDIO_SCENARIO_COMMUNICATION` audio scenario. Call {@link setAudioScenario setAudioScenario} to switch between different audio scenarios.
|
|
928
|
+
* - For the volume type in different audio scenarios, refer to {@link AudioScenarioType AudioScenarioType}.
|
|
929
929
|
*
|
|
930
930
|
*/
|
|
931
931
|
setAudioRoute(audioRoute: AudioRoute): number;
|
|
@@ -934,8 +934,8 @@ export declare class RTCVideo {
|
|
|
934
934
|
* @region Audio management
|
|
935
935
|
* @author dixing
|
|
936
936
|
* @brief Get the information of currently-using playback route.
|
|
937
|
-
* @return See
|
|
938
|
-
* @note To set the audio playback route, see
|
|
937
|
+
* @return See {@link AudioRoute AudioRoute}.
|
|
938
|
+
* @note To set the audio playback route, see {@link setAudioRoute setAudioRoute}.
|
|
939
939
|
*
|
|
940
940
|
*/
|
|
941
941
|
getAudioRoute(): AudioRoute;
|
|
@@ -943,7 +943,7 @@ export declare class RTCVideo {
|
|
|
943
943
|
* @detail api
|
|
944
944
|
* @author dixing
|
|
945
945
|
* @brief Set the speaker or earpiece as the default audio playback device.
|
|
946
|
-
* @param route Audio playback device. Refer to
|
|
946
|
+
* @param route Audio playback device. Refer to {@link AudioRoute AudioRoute}. You can only use earpiece and speakerphone.
|
|
947
947
|
* @return
|
|
948
948
|
* - 0: Success.
|
|
949
949
|
* - < 0: failure. It fails when the device designated is neither a speaker nor an earpiece.
|
|
@@ -960,7 +960,7 @@ export declare class RTCVideo {
|
|
|
960
960
|
* - false: disable (by default)
|
|
961
961
|
* @return
|
|
962
962
|
* - 0: Success.
|
|
963
|
-
* - < 0 : Fail. See
|
|
963
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
964
964
|
* @note
|
|
965
965
|
* - When you use external sound card for audio capture, enable this mode for better audio quality.
|
|
966
966
|
* - When using the mode, you can only use earphones. If you need to use internal or external speaker, disable this mode.
|
|
@@ -979,11 +979,11 @@ export declare class RTCVideo {
|
|
|
979
979
|
* - False: (Default) Enable microphone
|
|
980
980
|
* @return
|
|
981
981
|
* - 0: Success.
|
|
982
|
-
* - < 0 : Failure. See
|
|
982
|
+
* - < 0 : Failure. See {@link ReturnStatus ReturnStatus} for more details.
|
|
983
983
|
* @note
|
|
984
984
|
* - Calling this API does not affect the status of SDK audio stream publishing.
|
|
985
|
-
* - Adjusting the volume by calling
|
|
986
|
-
* - You can use this interface to set the capture volume before or after calling
|
|
985
|
+
* - Adjusting the volume by calling {@link setCaptureVolume setCaptureVolume} after muting will not cancel the mute state. The volume state will be retained until unmuted.
|
|
986
|
+
* - You can use this interface to set the capture volume before or after calling {@link startAudioCapture startAudioCapture} to enable audio capture.
|
|
987
987
|
*
|
|
988
988
|
*/
|
|
989
989
|
muteAudioCapture(index: StreamIndex, mute: boolean): number;
|
|
@@ -1001,7 +1001,7 @@ export declare class RTCVideo {
|
|
|
1001
1001
|
* - 400: Four times the original volume with signal-clipping protection.
|
|
1002
1002
|
* @return
|
|
1003
1003
|
* - 0: Success.
|
|
1004
|
-
* - < 0 : Fail. See
|
|
1004
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1005
1005
|
* @note Call this API to set the volume of the audio capture before or during the audio capture.
|
|
1006
1006
|
*
|
|
1007
1007
|
*/
|
|
@@ -1018,8 +1018,8 @@ export declare class RTCVideo {
|
|
|
1018
1018
|
* - 400: Four times the original volume with signal-clipping protection.
|
|
1019
1019
|
* @return
|
|
1020
1020
|
* - 0: Success.
|
|
1021
|
-
* - < 0 : Fail. See
|
|
1022
|
-
* @note Suppose a remote user A is always within the range of the target user whose playback volume will be adjusted, if you use both this method and
|
|
1021
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1022
|
+
* @note Suppose a remote user A is always within the range of the target user whose playback volume will be adjusted, if you use both this method and {@link setRemoteAudioPlaybackVolume setRemoteAudioPlaybackVolume}{@link setRemoteRoomAudioPlaybackVolume /setRemoteRoomAudioPlaybackVolume}, the volume that the local user hears from user A is the overlay of both settings.
|
|
1023
1023
|
*
|
|
1024
1024
|
*/
|
|
1025
1025
|
setPlaybackVolume(volume: number): number;
|
|
@@ -1031,10 +1031,10 @@ export declare class RTCVideo {
|
|
|
1031
1031
|
* You can adjust the pitch of local voice such as ascending or descending with this method.
|
|
1032
1032
|
* @param pitch The value that is higher or lower than the original local voice within a range from -12 to 12. The default value is 0, i.e. No adjustment is made. <br>
|
|
1033
1033
|
* The difference in pitch between two adjacent values within the value range is a semitone, with positive values indicating an ascending tone and negative values indicating a descending tone, and the larger the absolute value set, the more the pitch is raised or lowered. <br>
|
|
1034
|
-
* Out of the value range, the setting fails and triggers
|
|
1034
|
+
* Out of the value range, the setting fails and triggers {@link onWarning onWarning} callback, indicating `WARNING_CODE_SET_SCREEN_STREAM_INVALID_VOICE_PITCH` for invalid value setting with {@link WarningCode WarningCode}.
|
|
1035
1035
|
* @return
|
|
1036
1036
|
* - 0: Success.
|
|
1037
|
-
* - < 0 : Fail. See
|
|
1037
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1038
1038
|
*
|
|
1039
1039
|
*/
|
|
1040
1040
|
setLocalVoicePitch(pitch: number): number;
|
|
@@ -1043,14 +1043,14 @@ export declare class RTCVideo {
|
|
|
1043
1043
|
* @region Audio Management
|
|
1044
1044
|
* @author majun.lvhiei
|
|
1045
1045
|
* @brief Enables/disables the loudness equalization function. <br>
|
|
1046
|
-
* If you call this API with the parameter set to True, the loudness of user's voice will be adjusted to -16lufs. If then you also call
|
|
1046
|
+
* If you call this API with the parameter set to True, the loudness of user's voice will be adjusted to -16lufs. If then you also call {@link setAudioMixingLoudness setAudioMixingLoudness} and import the original loudness of the audio data used in audio mixing, the loudness will be adjusted to -20lufs when the audio data starts to play.
|
|
1047
1047
|
* @param enable Whether to enable loudness equalization function: <br>
|
|
1048
1048
|
* - true: Yes
|
|
1049
1049
|
* - false: No
|
|
1050
1050
|
* @return
|
|
1051
1051
|
* - 0: Success.
|
|
1052
|
-
* - < 0 : Fail. See
|
|
1053
|
-
* @note You must call this API before starting to play the audio file with
|
|
1052
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1053
|
+
* @note You must call this API before starting to play the audio file with {@link startAudioMixing startAudioMixing}.
|
|
1054
1054
|
*
|
|
1055
1055
|
*/
|
|
1056
1056
|
enableVocalInstrumentBalance(enable: boolean): number;
|
|
@@ -1065,7 +1065,7 @@ export declare class RTCVideo {
|
|
|
1065
1065
|
* - false: No
|
|
1066
1066
|
* @return
|
|
1067
1067
|
* - 0: Success.
|
|
1068
|
-
* - < 0 : Fail. See
|
|
1068
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1069
1069
|
*
|
|
1070
1070
|
*/
|
|
1071
1071
|
enablePlaybackDucking(enable: boolean): number;
|
|
@@ -1073,8 +1073,8 @@ export declare class RTCVideo {
|
|
|
1073
1073
|
* @detail api
|
|
1074
1074
|
* @region Real-time messaging
|
|
1075
1075
|
* @author hanchenchen.c
|
|
1076
|
-
* @brief Log in first to call
|
|
1077
|
-
* To log out, call
|
|
1076
|
+
* @brief Log in first to call {@link sendUserMessageOutsideRoom sendUserMessageOutsideRoom} and {@link sendServerMessage sendServerMessage} to send P2P messages or send messages to a server without joining the RTC room. <br>
|
|
1077
|
+
* To log out, call {@link logout logout}.
|
|
1078
1078
|
* @param token <br>
|
|
1079
1079
|
* Token is required during login for authentication. <br>
|
|
1080
1080
|
* This Token is different from that required by calling joinRoom. You can assign any value even null to `roomId` to generate a login token. During developing and testing, you can use temporary tokens generated on the console. Deploy the token generating application on your server.
|
|
@@ -1083,8 +1083,8 @@ export declare class RTCVideo {
|
|
|
1083
1083
|
* User ID is unique within one appid.
|
|
1084
1084
|
* @return
|
|
1085
1085
|
* - 0: Success.
|
|
1086
|
-
* - <0: Failure. See
|
|
1087
|
-
* @note You will receive
|
|
1086
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
1087
|
+
* @note You will receive {@link onLoginResult onLoginResult} after calling this API and log in successfully. But remote users will not receive notification about that.
|
|
1088
1088
|
*
|
|
1089
1089
|
*/
|
|
1090
1090
|
login(token: string, uid: string): number;
|
|
@@ -1095,10 +1095,10 @@ export declare class RTCVideo {
|
|
|
1095
1095
|
* @brief Call this method to log out, it is impossible to call methods related to out-of-room messages and end-to-server messages or receive related callbacks.
|
|
1096
1096
|
* @return
|
|
1097
1097
|
* - 0: Success.
|
|
1098
|
-
* - < 0 : Fail. See
|
|
1098
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1099
1099
|
* @note
|
|
1100
|
-
* - After calling this interface to log out, you must first call
|
|
1101
|
-
* - After local users call this method to log out, they will receive the result of the
|
|
1100
|
+
* - After calling this interface to log out, you must first call {@link login login} to log in.
|
|
1101
|
+
* - After local users call this method to log out, they will receive the result of the {@link onLogout onLogout} callback notification, and remote users will not receive the notification.
|
|
1102
1102
|
*
|
|
1103
1103
|
*/
|
|
1104
1104
|
logout(): number;
|
|
@@ -1108,14 +1108,14 @@ export declare class RTCVideo {
|
|
|
1108
1108
|
* @author hanchenchen.c
|
|
1109
1109
|
* @brief Update the Token <br>
|
|
1110
1110
|
* Token used by the user for login has a certain valid period. When the Token expires, you need to call this method to update the login Token information. <br>
|
|
1111
|
-
* When calling the
|
|
1111
|
+
* When calling the {@link login login} method to log in, if an expired token is used, the login will fail and you will receive an {@link onLoginResult onLoginResult} callback notification with an error code of 'LOGIN_ERROR_CODE_INVALID_TOKEN'. You need to reacquire the token and call this method to update the token.
|
|
1112
1112
|
* @param token <br>
|
|
1113
1113
|
* Updated dynamic key
|
|
1114
1114
|
* @return
|
|
1115
1115
|
* - 0: Success.
|
|
1116
|
-
* - < 0 : Fail. See
|
|
1116
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1117
1117
|
* @note
|
|
1118
|
-
* - If the token is invalid and the login fails, the SDK will automatically log in again after updating the token by calling this method, and the user does not need to call the
|
|
1118
|
+
* - If the token is invalid and the login fails, the SDK will automatically log in again after updating the token by calling this method, and the user does not need to call the {@link login login} method himself.
|
|
1119
1119
|
* - Token expires, if you have successfully logged in, it will not be affected. An expired Token error will be notified to the user the next time you log in with an expired Token, or when you log in again due to a disconnection due to poor local network conditions.
|
|
1120
1120
|
*
|
|
1121
1121
|
*/
|
|
@@ -1125,17 +1125,17 @@ export declare class RTCVideo {
|
|
|
1125
1125
|
* @region Real-time messaging
|
|
1126
1126
|
* @author hanchenchen.c
|
|
1127
1127
|
* @brief Set application server parameters <br>
|
|
1128
|
-
* Client side calls
|
|
1128
|
+
* Client side calls {@link sendServerMessage sendServerMessage} or {@link sendServerBinaryMessage sendServerBinaryMessage} Before sending a message to the application server, you must set a valid signature and application server address.
|
|
1129
1129
|
* @param signature Dynamic signature. The App server may use the signature to verify the source of messages. <br>
|
|
1130
1130
|
* You need to define the signature yourself. It can be any non-empty string. It is recommended to encode information such as UID into the signature. <br>
|
|
1131
1131
|
* The signature will be sent to the address set through the "url" parameter in the form of a POST request.
|
|
1132
1132
|
* @param url The address of the application server
|
|
1133
1133
|
* @return
|
|
1134
1134
|
* - 0: Success.
|
|
1135
|
-
* - < 0 : Fail. See
|
|
1135
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1136
1136
|
* @note
|
|
1137
|
-
* - The user must call
|
|
1138
|
-
* - After calling this interface, the SDK will use
|
|
1137
|
+
* - The user must call {@link login login} to log in before calling this interface.
|
|
1138
|
+
* - After calling this interface, the SDK will use {@link onServerParamsSetResult onServerParamsSetResult} to return the corresponding result.
|
|
1139
1139
|
*
|
|
1140
1140
|
*/
|
|
1141
1141
|
setServerParams(signature: string, url: string): number;
|
|
@@ -1147,10 +1147,10 @@ export declare class RTCVideo {
|
|
|
1147
1147
|
* @param peerUserID The user ID to be queried
|
|
1148
1148
|
* @return
|
|
1149
1149
|
* - 0: Success.
|
|
1150
|
-
* - < 0 : Fail. See
|
|
1150
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1151
1151
|
* @note
|
|
1152
|
-
* - You must call
|
|
1153
|
-
* - After calling this interface, the SDK notifies the query result using the
|
|
1152
|
+
* - You must call {@link login login} to log in before calling this interface.
|
|
1153
|
+
* - After calling this interface, the SDK notifies the query result using the {@link onGetPeerOnlineStatus onGetPeerOnlineStatus} callback.
|
|
1154
1154
|
* - Before sending an out-of-room message, the user can know whether the peer user is logged in through this interface to decide whether to send a message. You can also check your login status through this interface.
|
|
1155
1155
|
*
|
|
1156
1156
|
*/
|
|
@@ -1164,15 +1164,15 @@ export declare class RTCVideo {
|
|
|
1164
1164
|
* @param message <br>
|
|
1165
1165
|
* Text message content sent. <br>
|
|
1166
1166
|
* Message does not exceed 64 KB.
|
|
1167
|
-
* @param config Message type, see
|
|
1167
|
+
* @param config Message type, see {@link MessageConfig MessageConfig}.
|
|
1168
1168
|
* @return
|
|
1169
1169
|
* - > 0: Sent successfully, return the number of the sent message, increment from 1
|
|
1170
1170
|
* - -1: Sent failed, RTCVideo instance not created
|
|
1171
1171
|
* - -2: Sent failed, uid is empty
|
|
1172
1172
|
* @note
|
|
1173
|
-
* - Before sending an out-of-room text message, you must call
|
|
1174
|
-
* - After the user calls this interface to send a text message, he will receive an
|
|
1175
|
-
* - If the text message is sent successfully, the user specified by uid receives the message via the
|
|
1173
|
+
* - Before sending an out-of-room text message, you must call {@link login login} to login.
|
|
1174
|
+
* - After the user calls this interface to send a text message, he will receive an {@link onUserMessageSendResultOutsideRoom onUserMessageSendResultOutsideRoom} callback to know whether the message was successfully sent.
|
|
1175
|
+
* - If the text message is sent successfully, the user specified by uid receives the message via the {@link onUserMessageReceivedOutsideRoom onUserMessageReceivedOutsideRoom} callback.
|
|
1176
1176
|
*
|
|
1177
1177
|
*/
|
|
1178
1178
|
sendUserMessageOutsideRoom(uid: string, message: string, config: MessageConfig): number;
|
|
@@ -1185,15 +1185,15 @@ export declare class RTCVideo {
|
|
|
1185
1185
|
* @param buffer <br>
|
|
1186
1186
|
* Binary message content sent <br>
|
|
1187
1187
|
* Message does not exceed 46KB.
|
|
1188
|
-
* @param config Message type, see
|
|
1188
|
+
* @param config Message type, see {@link MessageConfig MessageConfig}.
|
|
1189
1189
|
* @return
|
|
1190
1190
|
* - > 0: Sent successfully, return the number of the sent message this time, increment from 1
|
|
1191
1191
|
* - -1: Sent failed, RTCVideo instance not created
|
|
1192
1192
|
* - -2: Sent failed, uid is empty
|
|
1193
1193
|
* @note
|
|
1194
|
-
* - Before sending out-of-room binary messages, you should call
|
|
1195
|
-
* - After the user calls this interface to send a binary message, he will receive an
|
|
1196
|
-
* - If the binary message is sent successfully, the user specified by uid will receive the message through the
|
|
1194
|
+
* - Before sending out-of-room binary messages, you should call {@link login login} first.
|
|
1195
|
+
* - After the user calls this interface to send a binary message, he will receive an {@link onUserMessageSendResultOutsideRoom onUserMessageSendResultOutsideRoom} callback to notify whether the message was sent successfully;
|
|
1196
|
+
* - If the binary message is sent successfully, the user specified by uid will receive the message through the {@link onUserBinaryMessageReceivedOutsideRoom onUserBinaryMessageReceivedOutsideRoom} callback.
|
|
1197
1197
|
*
|
|
1198
1198
|
*/
|
|
1199
1199
|
sendUserBinaryMessageOutsideRoom(uid: string, buffer: ArrayBuffer, config: MessageConfig): number;
|
|
@@ -1209,9 +1209,9 @@ export declare class RTCVideo {
|
|
|
1209
1209
|
* - > 0: Sent successfully, return the number of the sent message, increment from 1
|
|
1210
1210
|
* - -1: Sent failed, RTCVideo instance not created
|
|
1211
1211
|
* @note
|
|
1212
|
-
* - Before sending a text message to the application server, you must first call
|
|
1213
|
-
* - After calling this interface, you will receive an
|
|
1214
|
-
* - If the text message is sent successfully, the application server that previously called the
|
|
1212
|
+
* - Before sending a text message to the application server, you must first call {@link login login} to complete the login, and then call {@link setServerParams setServerParams} Set up the application server.
|
|
1213
|
+
* - After calling this interface, you will receive an {@link onServerMessageSendResult onServerMessageSendResult} callback to inform the message sender whether the message was sent successfully.
|
|
1214
|
+
* - If the text message is sent successfully, the application server that previously called the {@link setServerParams setServerParams} setting will receive the message.
|
|
1215
1215
|
*
|
|
1216
1216
|
*/
|
|
1217
1217
|
sendServerMessage(message: string): number;
|
|
@@ -1227,9 +1227,9 @@ export declare class RTCVideo {
|
|
|
1227
1227
|
* - > 0: Sent successfully, return the number of the sent message, increment from 1
|
|
1228
1228
|
* - -1: Sent failed, RTCVideo instance not created
|
|
1229
1229
|
* @note
|
|
1230
|
-
* - Before sending a binary message to the application server, you must first call
|
|
1231
|
-
* - After calling this interface, you will receive an
|
|
1232
|
-
* - If the binary message is sent successfully, the application server that previously called the
|
|
1230
|
+
* - Before sending a binary message to the application server, you must first call {@link login login} to complete the login, and then call {@link setServerParams setServerParams} Set up the application server.
|
|
1231
|
+
* - After calling this interface, you will receive an {@link onServerMessageSendResult onServerMessageSendResult} callback to inform the message sender that the sending succeeded or failed;
|
|
1232
|
+
* - If the binary message is sent successfully, the application server that previously called the {@link setServerParams setServerParams} setting will receive the message.
|
|
1233
1233
|
*
|
|
1234
1234
|
*/
|
|
1235
1235
|
sendServerBinaryMessage(buffer: ArrayBuffer): number;
|
|
@@ -1244,10 +1244,10 @@ export declare class RTCVideo {
|
|
|
1244
1244
|
* @param expectedDownlinkBitrate Expected downlink bandwidth in kbps, unit: kbps<br>Range: `{0, [100-10000]}`, `0`: Auto, that RTC will set the highest bite rate.
|
|
1245
1245
|
* @return
|
|
1246
1246
|
* - 0: Success.
|
|
1247
|
-
* - < 0 : Fail. See
|
|
1247
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1248
1248
|
* @note
|
|
1249
|
-
* - After successfully calling this interface, you will receive
|
|
1250
|
-
* - If the probe stops, you will receive
|
|
1249
|
+
* - After successfully calling this interface, you will receive {@link onNetworkDetectionResult onNetworkDetectionResult} within 3s and every 2s thereafter notifying the probe results;
|
|
1250
|
+
* - If the probe stops, you will receive {@link onNetworkDetectionStopped onNetworkDetectionStopped} to notify the probe to stop.
|
|
1251
1251
|
*
|
|
1252
1252
|
*/
|
|
1253
1253
|
startNetworkDetection(isTestUplink: boolean, expectedUplinkBitrate: number, isTestDownlink: boolean, expectedDownlinkBitrate: number): number;
|
|
@@ -1258,9 +1258,9 @@ export declare class RTCVideo {
|
|
|
1258
1258
|
* @brief Stop pre-call network probe
|
|
1259
1259
|
* @return
|
|
1260
1260
|
* - 0: Success.
|
|
1261
|
-
* - < 0 : Fail. See
|
|
1261
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1262
1262
|
* @note
|
|
1263
|
-
* - After calling this interface, you will receive an
|
|
1263
|
+
* - After calling this interface, you will receive an {@link onNetworkDetectionStopped onNetworkDetectionStopped} callback to notify the probe to stop.
|
|
1264
1264
|
*
|
|
1265
1265
|
*/
|
|
1266
1266
|
stopNetworkDetection(): number;
|
|
@@ -1269,14 +1269,14 @@ export declare class RTCVideo {
|
|
|
1269
1269
|
* @region Audio Data Callback
|
|
1270
1270
|
* @author gongzhengduo
|
|
1271
1271
|
* @brief Enable audio frames callback and set the format for the specified type of audio frames.
|
|
1272
|
-
* @param method Audio data callback method. See
|
|
1272
|
+
* @param method Audio data callback method. See {@link AudioFrameCallbackMethod AudioFrameCallbackMethod}. <br>
|
|
1273
1273
|
* If `method` is set as `AUDIO_FRAME_CALLBACK_RECORD(0)`, `AUDIO_FRAME_CALLBACK_PLAYBACK(1)`, or `AUDIO_FRAME_CALLBACK_MIXED(2)`, set `format` to the accurate value listed in the audio parameters format. <br>
|
|
1274
1274
|
* If `method` is set as `AUDIO_FRAME_CALLBACK_REMOTE_USER(3)`, set `format` to `auto`.
|
|
1275
|
-
* @param format Audio parameters format. See
|
|
1275
|
+
* @param format Audio parameters format. See {@link AudioFormat AudioFormat}.
|
|
1276
1276
|
* @return
|
|
1277
1277
|
* - 0: Success.
|
|
1278
|
-
* - < 0 : Fail. See
|
|
1279
|
-
* @note After calling this API and
|
|
1278
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1279
|
+
* @note After calling this API and {@link registerAudioFrameObserver registerAudioFrameObserver}, {@link IAudioFrameObserver IAudioFrameObserver} will receive the corresponding audio data callback. However, these two APIs are independent of each other and the calling order is not restricted.
|
|
1280
1280
|
*
|
|
1281
1281
|
*/
|
|
1282
1282
|
enableAudioFrameCallback(method: AudioFrameCallbackMethod, format: AudioFormat): number;
|
|
@@ -1285,11 +1285,11 @@ export declare class RTCVideo {
|
|
|
1285
1285
|
* @region Audio Data Callback
|
|
1286
1286
|
* @author gongzhengduo
|
|
1287
1287
|
* @brief Disables audio data callback.
|
|
1288
|
-
* @param method Audio data callback method. See
|
|
1288
|
+
* @param method Audio data callback method. See {@link AudioFrameCallbackMethod AudioFrameCallbackMethod}.
|
|
1289
1289
|
* @return
|
|
1290
1290
|
* - 0: Success.
|
|
1291
|
-
* - < 0 : Fail. See
|
|
1292
|
-
* @note Call this API after calling
|
|
1291
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1292
|
+
* @note Call this API after calling {@link enableAudioFrameCallback enableAudioFrameCallback}.
|
|
1293
1293
|
*
|
|
1294
1294
|
*/
|
|
1295
1295
|
disableAudioFrameCallback(method: AudioFrameCallbackMethod): number;
|
|
@@ -1298,11 +1298,11 @@ export declare class RTCVideo {
|
|
|
1298
1298
|
* @region Audio Data Callback
|
|
1299
1299
|
* @author gongzhengduo
|
|
1300
1300
|
* @brief Register an audio frame observer.
|
|
1301
|
-
* @param observer Audio data callback observer. See
|
|
1301
|
+
* @param observer Audio data callback observer. See {@link IAudioFrameObserver IAudioFrameObserver}. Use `null` to cancel the registration.
|
|
1302
1302
|
* @return
|
|
1303
1303
|
* - 0: Success.
|
|
1304
|
-
* - < 0 : Fail. See
|
|
1305
|
-
* @note After calling this API and
|
|
1304
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1305
|
+
* @note After calling this API and {@link enableAudioFrameCallback enableAudioFrameCallback}, {@link IAudioFrameObserver IAudioFrameObserver} receives the corresponding audio data callback. You can retrieve the audio data and perform processing on it without affecting the audio that RTC SDK uses to encode or render.
|
|
1306
1306
|
*
|
|
1307
1307
|
*/
|
|
1308
1308
|
registerAudioFrameObserver(observer: IAudioFrameObserver): number;
|
|
@@ -1310,12 +1310,12 @@ export declare class RTCVideo {
|
|
|
1310
1310
|
* @detail api
|
|
1311
1311
|
* @author gongzhengduo
|
|
1312
1312
|
* @brief Register a custom audio preprocessor. <br>
|
|
1313
|
-
* After that, you can call
|
|
1314
|
-
* @param processor Custom audio processor. See
|
|
1313
|
+
* After that, you can call {@link enableAudioProcessor enableAudioProcessor} to process the audio streams that either captured locally or received from the remote side. RTC SDK then encodes or renders the processed data.
|
|
1314
|
+
* @param processor Custom audio processor. See {@link IAudioFrameProcessor IAudioFrameProcessor}。 <br>
|
|
1315
1315
|
* SDK only holds weak references to the processor, you should guarantee its Life Time. To cancel registration, set the parameter to nullptr.
|
|
1316
1316
|
* @return
|
|
1317
1317
|
* - 0: Success.
|
|
1318
|
-
* - < 0 : Fail. See
|
|
1318
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
1319
1319
|
* @note
|
|
1320
1320
|
* - When this interface is repeatedly called, only the last call takes effect.
|
|
1321
1321
|
* - Refer to [Custom Audio Processing](https://docs.byteplus.com/en/byteplus-rtc/docs/80635) for more information.
|
|
@@ -1327,17 +1327,17 @@ export declare class RTCVideo {
|
|
|
1327
1327
|
* @author likai.666
|
|
1328
1328
|
* @valid since 3.51
|
|
1329
1329
|
* @brief Set the step size for each digital zooming control to the local videos.
|
|
1330
|
-
* @param type Required. Identifying which type the `size` is referring to. Refer to
|
|
1330
|
+
* @param type Required. Identifying which type the `size` is referring to. Refer to {@link ZoomConfigType ZoomConfigType}.
|
|
1331
1331
|
* @param size Required. Reserved to three decimal places. It defaults to `0`. <br>
|
|
1332
1332
|
* The meaning and range vary from different `type`s. If the scale or moving distance exceeds the range, the limit is taken as the result. <br>
|
|
1333
|
-
* - `kZoomFocusOffset`: Increasement or decrease to the scaling factor. Range: [0, 7]. For example, when it is set to 0.5 and
|
|
1334
|
-
* - `kZoomMoveOffset`:Ratio of the distance to the border of video images. It ranges [0, 0.5] and defaults to `0`, which means no offset. When you call
|
|
1333
|
+
* - `kZoomFocusOffset`: Increasement or decrease to the scaling factor. Range: [0, 7]. For example, when it is set to 0.5 and {@link setVideoDigitalZoomControl setVideoDigitalZoomControl} is called to zoom in, the scale will increase `0.5`. The scale ranges [1,8] and defaults to `1`, which means an original size.
|
|
1334
|
+
* - `kZoomMoveOffset`:Ratio of the distance to the border of video images. It ranges [0, 0.5] and defaults to `0`, which means no offset. When you call {@link setVideoDigitalZoomControl setVideoDigitalZoomControl} and choose `CAMERA_MOVE_LEFT`, the moving distance is size x original width. While for the `CAMERA_MOVE_UP`, the moving distance is size x original height. Suppose that a video spans 1080 px and the `size` is set to `0.5` so that the distance would be 0.5 x 1080 px = 540 px.
|
|
1335
1335
|
* @return
|
|
1336
1336
|
* - 0: Success.
|
|
1337
1337
|
* - ! 0: Failure.
|
|
1338
1338
|
* @note
|
|
1339
1339
|
* - Only one size can be set for a single call. You must call this API to pass values respectively if you intend to set multiple `size`s.
|
|
1340
|
-
* - As the default `size` is `0`, you must call this API before performing any digital zoom control by calling
|
|
1340
|
+
* - As the default `size` is `0`, you must call this API before performing any digital zoom control by calling {@link setVideoDigitalZoomControl setVideoDigitalZoomControl} or {@link startVideoDigitalZoomControl startVideoDigitalZoomControl}.
|
|
1341
1341
|
*
|
|
1342
1342
|
*/
|
|
1343
1343
|
setVideoDigitalZoomConfig(type: ZoomConfigType, size: number): number;
|
|
@@ -1346,16 +1346,16 @@ export declare class RTCVideo {
|
|
|
1346
1346
|
* @author likai.666
|
|
1347
1347
|
* @valid since 3.51
|
|
1348
1348
|
* @brief Digital zoom or move the local video image once. This action affects both the video preview locally and the stream published.
|
|
1349
|
-
* @param direction Action of the digital zoom control. Refer to
|
|
1349
|
+
* @param direction Action of the digital zoom control. Refer to {@link ZoomDirectionType ZoomDirectionType}.
|
|
1350
1350
|
* @return
|
|
1351
1351
|
* - 0: Success.
|
|
1352
1352
|
* - ! 0: Failure.
|
|
1353
1353
|
* @note
|
|
1354
|
-
* - As the default offset is `0`, you must call
|
|
1355
|
-
* - You can only move video images after they are magnified via this API or
|
|
1354
|
+
* - As the default offset is `0`, you must call {@link setVideoDigitalZoomConfig setVideoDigitalZoomConfig} before this API.
|
|
1355
|
+
* - You can only move video images after they are magnified via this API or {@link startVideoDigitalZoomControl startVideoDigitalZoomControl}.
|
|
1356
1356
|
* - When you request an out-of-range scale or movement, SDK will execute it with the limits. For example, when the image has been moved to the border, the image cannot be zoomed out, or has been magnified to 8x.
|
|
1357
|
-
* - Call
|
|
1358
|
-
* - Refer to
|
|
1357
|
+
* - Call {@link startVideoDigitalZoomControl startVideoDigitalZoomControl} to have a continuous and repeatedly digital zoom control.
|
|
1358
|
+
* - Refer to {@link setCameraZoomRatio setCameraZoomRatio} if you intend to have an optical zoom control to the camera.
|
|
1359
1359
|
*
|
|
1360
1360
|
*/
|
|
1361
1361
|
setVideoDigitalZoomControl(direction: ZoomDirectionType): number;
|
|
@@ -1364,17 +1364,17 @@ export declare class RTCVideo {
|
|
|
1364
1364
|
* @author likai.666
|
|
1365
1365
|
* @valid since 3.51
|
|
1366
1366
|
* @brief Continuous and repeatedly digital zoom control. This action effect both the video preview locally and the stream published.
|
|
1367
|
-
* @param direction Action of the digital zoom control. Refer to
|
|
1367
|
+
* @param direction Action of the digital zoom control. Refer to {@link ZoomDirectionType ZoomDirectionType}.
|
|
1368
1368
|
* @return
|
|
1369
1369
|
* - 0: Success.
|
|
1370
1370
|
* - ! 0: Failure.
|
|
1371
1371
|
* @note
|
|
1372
|
-
* - As the default offset is `0`, you must call
|
|
1373
|
-
* - You can only move video images after they are magnified via this API or
|
|
1372
|
+
* - As the default offset is `0`, you must call {@link setVideoDigitalZoomConfig setVideoDigitalZoomConfig} before this API.
|
|
1373
|
+
* - You can only move video images after they are magnified via this API or {@link setVideoDigitalZoomControl setVideoDigitalZoomControl}.
|
|
1374
1374
|
* - The control process stops when the scale reaches the limit, or the images have been moved to the border. if the next action exceeds the scale or movement range, SDK will execute it with the limits.
|
|
1375
|
-
* - Call
|
|
1376
|
-
* - Call
|
|
1377
|
-
* - Refer to
|
|
1375
|
+
* - Call {@link stopVideoDigitalZoomControl stopVideoDigitalZoomControl} to stop the ongoing zoom control.
|
|
1376
|
+
* - Call {@link setVideoDigitalZoomControl setVideoDigitalZoomControl} to have a one-time digital zoom control.
|
|
1377
|
+
* - Refer to {@link setCameraZoomRatio setCameraZoomRatio} if you intend to have an optical zoom control to the camera.
|
|
1378
1378
|
*
|
|
1379
1379
|
*/
|
|
1380
1380
|
startVideoDigitalZoomControl(direction: ZoomDirectionType): number;
|
|
@@ -1386,7 +1386,7 @@ export declare class RTCVideo {
|
|
|
1386
1386
|
* @return
|
|
1387
1387
|
* - 0: Success.
|
|
1388
1388
|
* - ! 0: Failure.
|
|
1389
|
-
* @note Refer to
|
|
1389
|
+
* @note Refer to {@link startVideoDigitalZoomControl startVideoDigitalZoomControl} for starting digital zooming.
|
|
1390
1390
|
*
|
|
1391
1391
|
*/
|
|
1392
1392
|
stopVideoDigitalZoomControl(): number;
|
|
@@ -1396,11 +1396,11 @@ export declare class RTCVideo {
|
|
|
1396
1396
|
* @author liuyangyang
|
|
1397
1397
|
* @brief Register a local video frame observer. <br>
|
|
1398
1398
|
* This method applys to both internal capturing and custom capturing. <br>
|
|
1399
|
-
* After calling this API, SDK triggers
|
|
1400
|
-
* @param observer Local video frame observer. See
|
|
1399
|
+
* After calling this API, SDK triggers {@link onLocalEncodedVideoFrame onLocalEncodedVideoFrame} whenever a video frame is captured.
|
|
1400
|
+
* @param observer Local video frame observer. See {@link ILocalEncodedVideoFrameObserver ILocalEncodedVideoFrameObserver}. You can cancel the registration by setting it to `null`.
|
|
1401
1401
|
* @return
|
|
1402
1402
|
* - 0: Success.
|
|
1403
|
-
* - < 0 : Fail. See
|
|
1403
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1404
1404
|
* @note You can call this API before or after entering the RTC room. Calling this API before entering the room ensures that video frames are monitored and callbacks are triggered as early as possible.
|
|
1405
1405
|
*
|
|
1406
1406
|
*/
|
|
@@ -1410,11 +1410,11 @@ export declare class RTCVideo {
|
|
|
1410
1410
|
* @region video management
|
|
1411
1411
|
* @author wangzhanqiang
|
|
1412
1412
|
* @brief Video data callback after registering remote encoding. <br>
|
|
1413
|
-
* After registration, when the SDK detects a remote encoded video frame, it will trigger the
|
|
1414
|
-
* @param observer Remote encoded video data monitor. See
|
|
1413
|
+
* After registration, when the SDK detects a remote encoded video frame, it will trigger the {@link onRemoteEncodedVideoFrame onRemoteEncodedVideoFrame} callback
|
|
1414
|
+
* @param observer Remote encoded video data monitor. See {@link IRemoteEncodedVideoFrameObserver IRemoteEncodedVideoFrameObserver}
|
|
1415
1415
|
* @return
|
|
1416
1416
|
* - 0: Success.
|
|
1417
|
-
* - < 0 : Fail. See
|
|
1417
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1418
1418
|
* @note
|
|
1419
1419
|
* - See [Custom Video Encoding and Decoding](https://docs.byteplus.com/byteplus-rtc/docs/82921#custom-video-decoding) for more details about custom video decoding.
|
|
1420
1420
|
* - This method applys to manual subscription mode and can be called either before or after entering the Room. It is recommended to call it before entering the room.
|
|
@@ -1429,14 +1429,14 @@ export declare class RTCVideo {
|
|
|
1429
1429
|
* @brief Set the video source, including the screen recordings. <br>
|
|
1430
1430
|
* The internal video capture is the default, which refers to capturing video using the built-in module.
|
|
1431
1431
|
* @param index Stream index. Refer to [StreamIndex](70083#streamindex-2) for more details.
|
|
1432
|
-
* @param type Video source type. Refer to
|
|
1432
|
+
* @param type Video source type. Refer to {@link VideoSourceType VideoSourceType} for more details.
|
|
1433
1433
|
* @return
|
|
1434
1434
|
* - 0: Success.
|
|
1435
|
-
* - < 0 : Fail. See
|
|
1435
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1436
1436
|
* @note
|
|
1437
1437
|
* - You can call this API whether the user is in a room or not.
|
|
1438
1438
|
* - Calling this API to switch to the custom video source will stop the enabled internal video capture.
|
|
1439
|
-
* - To switch to internal video capture, call this API to stop custom capture and then call
|
|
1439
|
+
* - To switch to internal video capture, call this API to stop custom capture and then call {@link startVideoCapture startVideoCapture} to enable internal video capture.
|
|
1440
1440
|
* - To push custom encoded video frames to the SDK, call this API to switch `VideoSourceType` to `VIDEO_SOURCE_TYPE_ENCODED_WITH_SIMULCAST(2)` or `VIDEO_SOURCE_TYPE_ENCODED_WITHOUT_SIMULCAST(3)`.
|
|
1441
1441
|
*
|
|
1442
1442
|
*/
|
|
@@ -1450,16 +1450,16 @@ export declare class RTCVideo {
|
|
|
1450
1450
|
* When pushing more than one live streams in the same task, SDK will first mix those streams into one single stream and then push it to CDN.
|
|
1451
1451
|
* @param taskId Task ID. The length should not exceed 126 bytes. <br>
|
|
1452
1452
|
* You may want to push more than one mixed stream to CDN from the same room. When you do that, use different ID for corresponding tasks; if you will start only one task, use an empty string.
|
|
1453
|
-
* @param mixedConfig Configurations to be set when pushing streams to CDN. See
|
|
1453
|
+
* @param mixedConfig Configurations to be set when pushing streams to CDN. See {@link MixedStreamConfig MixedStreamConfig}.
|
|
1454
1454
|
* @param observer Invalid parameter. Please ignore it.
|
|
1455
1455
|
* @return API call result: <br>
|
|
1456
1456
|
* - 0: Success
|
|
1457
1457
|
* - !0: Failure
|
|
1458
1458
|
* @note
|
|
1459
1459
|
* - Before calling this API,you need to enable Push to CDN on the [console](https://console.byteplus.com/rtc/workplaceRTC).
|
|
1460
|
-
* - After calling this API, you will be informed of the result and errors during the pushing process via the
|
|
1460
|
+
* - After calling this API, you will be informed of the result and errors during the pushing process via the {@link onMixingEvent onMixingEvent} callback.
|
|
1461
1461
|
* - If you have subscribed to the push-to-CDN server callback in the [console](https://console.byteplus.com/rtc/cloudRTC?tab=callback), calling this API will receive a [TranscodeStarted](https://docs.byteplus.com/en/byteplus-rtc/docs/75125#transcodestarted) server callback notification. When calling this API repeatedly, subsequent calls to this API will trigger both [TranscodeStarted](https://docs.byteplus.com/en/byteplus-rtc/docs/75125#transcodestarted) and [TranscodeUpdated](https://docs.byteplus.com/en/byteplus-rtc/docs/75125#transcodeupdated) callbacks.
|
|
1462
|
-
* - Call
|
|
1462
|
+
* - Call {@link stopPushStreamToCDN stopPushStreamToCDN} to stop pushing streams to CDN.
|
|
1463
1463
|
*
|
|
1464
1464
|
*/
|
|
1465
1465
|
startPushMixedStreamToCDN(taskId: string, mixedConfig: MixedStreamConfig, observer: IMixedStreamObserver): number;
|
|
@@ -1468,10 +1468,10 @@ export declare class RTCVideo {
|
|
|
1468
1468
|
* @detail api
|
|
1469
1469
|
* @region Push to CDN
|
|
1470
1470
|
* @author liyunlong.zx
|
|
1471
|
-
* @brief Update parameters needed when pushing mixed media streams to CDN. You will be informed of the change via the
|
|
1472
|
-
* After calling
|
|
1471
|
+
* @brief Update parameters needed when pushing mixed media streams to CDN. You will be informed of the change via the {@link onMixingEvent onMixingEvent} callback. <br>
|
|
1472
|
+
* After calling {@link startPushMixedStreamToCDN startPushMixedStreamToCDN} to enable the function of pushing streams to CDN, you can call this API to update the relevant configurations.
|
|
1473
1473
|
* @param taskId Task ID. Specifys of which pushing task you want to update the parameters.
|
|
1474
|
-
* @param mixedConfig Configurations that you want to update. See
|
|
1474
|
+
* @param mixedConfig Configurations that you want to update. See {@link MixedStreamConfig MixedStreamConfig} for specific indications. You can update any property for the task unless it is specified as unavailable for updates. <br>
|
|
1475
1475
|
* If you left some properties blank, you can expect these properties to be set to their default values.
|
|
1476
1476
|
* @return API call result: <br>
|
|
1477
1477
|
* - 0: Success
|
|
@@ -1486,15 +1486,15 @@ export declare class RTCVideo {
|
|
|
1486
1486
|
* @brief Create a new task of pushing a single media stream to CDN.
|
|
1487
1487
|
* @param taskId Task ID. <br>
|
|
1488
1488
|
* You may want to start more than one task to push streams to CDN. When you do that, use different IDs for corresponding tasks; if you will start only one task, use an empty string.
|
|
1489
|
-
* @param param Configurations for pushing a single stream to CDN. See
|
|
1490
|
-
* @param observer Register this observer to receive callbacks from the SDK. See
|
|
1489
|
+
* @param param Configurations for pushing a single stream to CDN. See {@link PushSingleStreamParam PushSingleStreamParam}.
|
|
1490
|
+
* @param observer Register this observer to receive callbacks from the SDK. See {@link IPushSingleStreamToCDNObserver IPushSingleStreamToCDNObserver}.
|
|
1491
1491
|
* @return
|
|
1492
1492
|
* - 0: Success.
|
|
1493
|
-
* - < 0 : Fail. See
|
|
1493
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1494
1494
|
* @note
|
|
1495
1495
|
* - Before calling this API,you need to enable Push to CDN on the [console](https://console.byteplus.com/rtc/workplaceRTC).
|
|
1496
|
-
* - After calling this API, you will be informed of the result and errors during the pushing process with
|
|
1497
|
-
* - Call
|
|
1496
|
+
* - After calling this API, you will be informed of the result and errors during the pushing process with {@link onStreamPushEvent onStreamPushEvent}.
|
|
1497
|
+
* - Call {@link stopPushStreamToCDN stopPushStreamToCDN} to stop the task.
|
|
1498
1498
|
* - Since this API does not perform encoding and decoding, the video stream pushed to RTMP will change according to the resolution, encoding method, and turning off the camera of the end of pushing streams.
|
|
1499
1499
|
*
|
|
1500
1500
|
*/
|
|
@@ -1508,10 +1508,10 @@ export declare class RTCVideo {
|
|
|
1508
1508
|
* @param taskId Task ID. Specifys the task you want to stop.
|
|
1509
1509
|
* @return
|
|
1510
1510
|
* - 0: Success.
|
|
1511
|
-
* - < 0 : Fail. See
|
|
1511
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1512
1512
|
* @note
|
|
1513
|
-
* - To start pushing single stream to CDN, see
|
|
1514
|
-
* - To start pushing mixed stream to CDN, see
|
|
1513
|
+
* - To start pushing single stream to CDN, see {@link startPushSingleStreamToCDN startPushSingleStreamToCDN}.
|
|
1514
|
+
* - To start pushing mixed stream to CDN, see {@link startPushMixedStreamToCDN startPushMixedStreamToCDN}.
|
|
1515
1515
|
*
|
|
1516
1516
|
*/
|
|
1517
1517
|
stopPushStreamToCDN(taskId: string): number;
|
|
@@ -1521,12 +1521,12 @@ export declare class RTCVideo {
|
|
|
1521
1521
|
* @author liuyangyang
|
|
1522
1522
|
* @brief Set the video capture parameters for internal capture of the RTC SDK. <br>
|
|
1523
1523
|
* If your project uses the SDK internal capture module, you can specify the video capture parameters including preference, resolution and frame rate through this interface.
|
|
1524
|
-
* @param videoCaptureConfig Video capture parameters. See:
|
|
1524
|
+
* @param videoCaptureConfig Video capture parameters. See: {@link VideoCaptureConfig VideoCaptureConfig}.
|
|
1525
1525
|
* @return
|
|
1526
1526
|
* - 0: Success;
|
|
1527
1527
|
* - < 0: Failure;
|
|
1528
1528
|
* @note
|
|
1529
|
-
* - This interface can be called after the engine is created. It is recommended to call this interface before calling
|
|
1529
|
+
* - This interface can be called after the engine is created. It is recommended to call this interface before calling {@link startVideoCapture startVideoCapture}.
|
|
1530
1530
|
* - It is recommended that different Engines on the same device use the same video capture parameters.
|
|
1531
1531
|
* - If you used the internal module to start video capture before calling this interface, the capture parameters default to Auto.
|
|
1532
1532
|
*
|
|
@@ -1542,7 +1542,7 @@ export declare class RTCVideo {
|
|
|
1542
1542
|
* - false: No(Default setting)
|
|
1543
1543
|
* @return
|
|
1544
1544
|
* - 0: Success.
|
|
1545
|
-
* - < 0 : Fail. See
|
|
1545
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1546
1546
|
* @note
|
|
1547
1547
|
* - You should call this API
|
|
1548
1548
|
* - before entering the room, or
|
|
@@ -1559,15 +1559,15 @@ export declare class RTCVideo {
|
|
|
1559
1559
|
* @author zhaomingliang
|
|
1560
1560
|
* @brief \<span id="RTCVideo-setvideoencoderconfig-1">\</span>Video publisher call this API to set the parameters of the maximum resolution video stream that is expected to be published, including resolution, frame rate, bitrate, and fallback strategy in poor network conditions. <br>
|
|
1561
1561
|
* You can only set configuration for one stream with this API. If you want to set configuration for multiple streams, Call [setVideoEncoderConfig](#RTCVideo-setvideoencoderconfig-2).
|
|
1562
|
-
* @param maxSolution The maximum video encoding parameter. See
|
|
1562
|
+
* @param maxSolution The maximum video encoding parameter. See {@link VideoEncoderConfig VideoEncoderConfig}.
|
|
1563
1563
|
* @return API call result: <br>
|
|
1564
1564
|
* - 0: Success
|
|
1565
1565
|
* - ! 0: Failure
|
|
1566
1566
|
* @note
|
|
1567
|
-
* - You can use
|
|
1567
|
+
* - You can use {@link enableSimulcastMode enableSimulcastMode} simultaneously to publish streams with different resolutions. Specifically, if you want to publish multiple streams with different resolutions, you need to call this method and enable the simulcast mode with {@link enableSimulcastMode enableSimulcastMode} before publishing your streams. The SDK will intelligently adjust the number of streams to be published (up to 4) and their parameters based on the settings of the subscribing end. The resolution set by calling this method will be the maximum resolution among the streams. For specific rules, please refer to [Simulcasting](https://docs.byteplus.com/en/byteplus-rtc/docs/70139).
|
|
1568
1568
|
* - Without calling this API, SDK will only publish one stream for you with a resolution of 640px × 360px and a frame rate of 15fps.
|
|
1569
1569
|
* - In custom capturing scenario, you must call this API to set encoding configurations to ensure the integrity of the picture received by the remote users.
|
|
1570
|
-
* - This API is applicable to the video stream captured by the camera, see
|
|
1570
|
+
* - This API is applicable to the video stream captured by the camera, see {@link setScreenVideoEncoderConfig setScreenVideoEncoderConfig} for setting parameters for screen sharing video stream.
|
|
1571
1571
|
*
|
|
1572
1572
|
*/
|
|
1573
1573
|
setVideoEncoderConfig(channelSolutions: Array<VideoEncoderConfig>): number;
|
|
@@ -1576,7 +1576,7 @@ export declare class RTCVideo {
|
|
|
1576
1576
|
* @region Screen Sharing
|
|
1577
1577
|
* @author zhoubohui
|
|
1578
1578
|
* @brief Set the encoding configuration for shared-screen streams, including the resolution, frame rate, bitrate, and fallback strategies under challenging network conditions.
|
|
1579
|
-
* @param screenSolution The encoding configuration for shared-screen streams. See
|
|
1579
|
+
* @param screenSolution The encoding configuration for shared-screen streams. See {@link ScreenVideoEncoderConfig ScreenVideoEncoderConfig}.
|
|
1580
1580
|
* @return
|
|
1581
1581
|
* - 0: Success.
|
|
1582
1582
|
* - ! 0: Failure.
|
|
@@ -1598,7 +1598,7 @@ export declare class RTCVideo {
|
|
|
1598
1598
|
* @note
|
|
1599
1599
|
* - This API only applies to custom captured video frames that use the RGBA color model, including VideoPixelFormat.TEXTURE_2D, VideoPixelFormat.TEXTURE_OES, VideoPixelFormat.RGBA.
|
|
1600
1600
|
* - This API must be called before publishing the video stream.
|
|
1601
|
-
* - After calling this API to enable Alpha channel encoding, you must call
|
|
1601
|
+
* - After calling this API to enable Alpha channel encoding, you must call {@link pushExternalVideoFrame pushExternalVideoFrame} to push the custom captured video frames to the RTC SDK. If a video frame format that is not supported is pushed, calling {@link pushExternalVideoFrame pushExternalVideoFrame} will return the error code ReturnStatus.RETURN_STATUS_PARAMETER_ERR.
|
|
1602
1602
|
*
|
|
1603
1603
|
*/
|
|
1604
1604
|
enableAlphaChannelVideoEncode(streamIndex: StreamIndex, alphaLayout: AlphaLayout): number;
|
|
@@ -1620,15 +1620,15 @@ export declare class RTCVideo {
|
|
|
1620
1620
|
* @region Custom Audio Capture and Rendering
|
|
1621
1621
|
* @author gongzhengduo
|
|
1622
1622
|
* @brief Switch the audio capture type.
|
|
1623
|
-
* @param type Audio input source type. See
|
|
1623
|
+
* @param type Audio input source type. See {@link AudioSourceType AudioSourceType} <br>
|
|
1624
1624
|
* Use internal audio capture by default. The audio capture type and the audio render type may be different from each other.
|
|
1625
1625
|
* @return Method call result: <br>
|
|
1626
1626
|
* - >0: Success.
|
|
1627
1627
|
* - -1: Failure.
|
|
1628
1628
|
* @note
|
|
1629
1629
|
* - You can call this API before or after joining the room.
|
|
1630
|
-
* - If you call this API to switch from internal audio capture to custom capture, the internal audio capture is automatically disabled. You must call
|
|
1631
|
-
* - If you call this API to switch from custom capture to internal capture, you must then call
|
|
1630
|
+
* - If you call this API to switch from internal audio capture to custom capture, the internal audio capture is automatically disabled. You must call {@link pushExternalAudioFrame pushExternalAudioFrame} to push custom captured audio data to RTC SDK for transmission.
|
|
1631
|
+
* - If you call this API to switch from custom capture to internal capture, you must then call {@link startAudioCapture startAudioCapture} to enable internal capture.
|
|
1632
1632
|
*
|
|
1633
1633
|
*/
|
|
1634
1634
|
setAudioSourceType(type: AudioSourceType): number;
|
|
@@ -1637,14 +1637,14 @@ export declare class RTCVideo {
|
|
|
1637
1637
|
* @region Custom Audio Capture and Rendering
|
|
1638
1638
|
* @author gongzhengduo
|
|
1639
1639
|
* @brief Switch the audio render type.
|
|
1640
|
-
* @param type Audio output source type. See
|
|
1640
|
+
* @param type Audio output source type. See {@link AudioRenderType AudioRenderType}. <br>
|
|
1641
1641
|
* Use internal audio render by default. The audio capture type and the audio render type may be different from each other.
|
|
1642
1642
|
* @return Method call result: <br>
|
|
1643
1643
|
* - >0: Success.
|
|
1644
1644
|
* - -1: Failure.
|
|
1645
1645
|
* @note
|
|
1646
1646
|
* - You can call this API before or after joining the room.
|
|
1647
|
-
* - After calling this API to enable custom audio rendering, call
|
|
1647
|
+
* - After calling this API to enable custom audio rendering, call {@link pullExternalAudioFrame pullExternalAudioFrame} for audio data.
|
|
1648
1648
|
*
|
|
1649
1649
|
*/
|
|
1650
1650
|
setAudioRenderType(type: AudioRenderType): number;
|
|
@@ -1654,12 +1654,12 @@ export declare class RTCVideo {
|
|
|
1654
1654
|
* @author gongzhengduo
|
|
1655
1655
|
* @brief Pulls audio data for external playback. <br>
|
|
1656
1656
|
* After calling this method, the SDK will actively fetch the audio data to play, including the decoded and mixed audio data from the remote source, for external playback.
|
|
1657
|
-
* @param audioFrame Audio data frame. See
|
|
1657
|
+
* @param audioFrame Audio data frame. See {@link AudioFrame AudioFrame}
|
|
1658
1658
|
* @return Method call result <br>
|
|
1659
1659
|
* - 0: Setup succeeded
|
|
1660
1660
|
* - < 0: Setup failed
|
|
1661
1661
|
* @note
|
|
1662
|
-
* - Before pulling external audio data,
|
|
1662
|
+
* - Before pulling external audio data, {@link setAudioRenderType setAudioRenderType} must be called Enable custom audio rendering.
|
|
1663
1663
|
* - You should pull audio data every 10 milliseconds since the duration of a RTC SDK audio frame is 10 milliseconds. Samples x call frequency = audioFrame's sample rate. Assume that the sampling rate is set to 48000, call this API every 10 ms, so that 480 sampling points should be pulled each time.
|
|
1664
1664
|
* - The audio sampling format is S16. The data format in the audio buffer is PCM data, and its capacity size is audioFrame.samples × audioFrame.channel × 2.
|
|
1665
1665
|
*
|
|
@@ -1670,15 +1670,15 @@ export declare class RTCVideo {
|
|
|
1670
1670
|
* @region Room Management
|
|
1671
1671
|
* @author shenpengliang
|
|
1672
1672
|
* @brief Create a room instance. <br>
|
|
1673
|
-
* This API only returns a room instance. You still need to call
|
|
1674
|
-
* Each call of this API creates one
|
|
1673
|
+
* This API only returns a room instance. You still need to call {@link joinRoom joinRoom} to actually create/join the room. <br>
|
|
1674
|
+
* Each call of this API creates one {@link RTCRoom RTCRoom} instance. Call this API as many times as the number of rooms you need, and then call {@link joinRoom joinRoom} of each RTCRoom instance to join multiple rooms at the same time. <br>
|
|
1675
1675
|
* In multi-room mode, a user can subscribe to media streams in the joined rooms at the same time.
|
|
1676
1676
|
* @param roomId The string matches the regular expression: `[a-zA-Z0-9_\@\\-\\.]{1,128}`.
|
|
1677
|
-
* @return
|
|
1677
|
+
* @return {@link RTCRoom RTCRoom} instance.
|
|
1678
1678
|
* @note
|
|
1679
|
-
* - If the room that you wish to join already exists, you still need to call this API first to create the RTCRoom instance, and then call
|
|
1679
|
+
* - If the room that you wish to join already exists, you still need to call this API first to create the RTCRoom instance, and then call {@link joinRoom joinRoom}.
|
|
1680
1680
|
* - Do not create multiple rooms with the same roomId, otherwise the newly created room instance will replace the old one.
|
|
1681
|
-
* - To forward streams to the other rooms, call
|
|
1681
|
+
* - To forward streams to the other rooms, call {@link startForwardStreamToRooms startForwardStreamToRooms} instead of enabling Multi-room mode.
|
|
1682
1682
|
*
|
|
1683
1683
|
*/
|
|
1684
1684
|
createRTCRoom(roomId: string): RTCRoom;
|
|
@@ -1688,15 +1688,15 @@ export declare class RTCVideo {
|
|
|
1688
1688
|
* @author panjian.fishing
|
|
1689
1689
|
* @brief Sets the fallback option for published audio & video streams. <br>
|
|
1690
1690
|
* You can call this API to set whether to automatically lower the resolution you set of the published streams under limited network conditions.
|
|
1691
|
-
* @param option Fallback option, see
|
|
1691
|
+
* @param option Fallback option, see {@link PublishFallbackOption PublishFallbackOption}.
|
|
1692
1692
|
* @return
|
|
1693
1693
|
* - 0: Success.
|
|
1694
|
-
* - < 0 : Fail. See
|
|
1694
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1695
1695
|
* @note
|
|
1696
|
-
* - This API only works after you call
|
|
1696
|
+
* - This API only works after you call {@link enableSimulcastMode enableSimulcastMode} to enable the mode of publishing multiple streams.
|
|
1697
1697
|
* - You must call this API before entering the room.
|
|
1698
|
-
* - After calling this method, if there is a performance degradation or recovery due to poor performance or network conditions, the local end will receive early warnings through the
|
|
1699
|
-
* - After you allow video stream to fallback, your stream subscribers will receive
|
|
1698
|
+
* - After calling this method, if there is a performance degradation or recovery due to poor performance or network conditions, the local end will receive early warnings through the {@link onPerformanceAlarms onPerformanceAlarms} callback to adjust the capture device.
|
|
1699
|
+
* - After you allow video stream to fallback, your stream subscribers will receive {@link onSimulcastSubscribeFallback onSimulcastSubscribeFallback} when the resolution of your published stream are lowered or restored.
|
|
1700
1700
|
* - You can alternatively set fallback options with distrubutions from server side, which is of higher priority.
|
|
1701
1701
|
*
|
|
1702
1702
|
*/
|
|
@@ -1710,12 +1710,12 @@ export declare class RTCVideo {
|
|
|
1710
1710
|
* @param uid <br>
|
|
1711
1711
|
* The ID of the remote user.
|
|
1712
1712
|
* @param priority <br>
|
|
1713
|
-
* Priority for remote users. See enumeration type
|
|
1713
|
+
* Priority for remote users. See enumeration type {@link RemoteUserPriority RemoteUserPriority}.
|
|
1714
1714
|
* @return
|
|
1715
1715
|
* - 0: Success.
|
|
1716
1716
|
* - < 0: Failed.
|
|
1717
1717
|
* @note
|
|
1718
|
-
* - This method is used with
|
|
1718
|
+
* - This method is used with {@link setSubscribeFallbackOption setSubscribeFallbackOption}.
|
|
1719
1719
|
* - If the subscription flow fallback option is turned on, weak connections or insufficient performance will give priority to ensuring the quality of the flow received by high-priority users.
|
|
1720
1720
|
* - This method can be used before and after entering the room, and the priority of the remote user can be modified.
|
|
1721
1721
|
*
|
|
@@ -1732,7 +1732,7 @@ export declare class RTCVideo {
|
|
|
1732
1732
|
* @param message SEI data. No more than 4 KB SEI data per frame is recommended.
|
|
1733
1733
|
* @param repeatCount Number of times a message is sent repeatedly. The value range is [0, max{29, \%{video frame rate}-1}]. Recommended range: [2,4]. <br>
|
|
1734
1734
|
* After calling this API, the SEI data will be added to a consecutive `\%{repeatCount}+1` number of video frames starting from the current frame.
|
|
1735
|
-
* @param mode SEI sending mode. See
|
|
1735
|
+
* @param mode SEI sending mode. See {@link SEICountPerFrame SEICountPerFrame}.
|
|
1736
1736
|
* @return
|
|
1737
1737
|
* - >= 0: The number of SEIs to be added to the video frame
|
|
1738
1738
|
* - < 0: Failure
|
|
@@ -1741,7 +1741,7 @@ export declare class RTCVideo {
|
|
|
1741
1741
|
* - In a voice call, this API can be called to send SEI data only in internal capture mode.
|
|
1742
1742
|
* - In a video call, the custom captured video frame can also be used for sending SEI data if the original video frame contains no SEI data, otherwise calling this method will not take effect.
|
|
1743
1743
|
* - Each video frame carrys only the SEI data received within 2s before and after. In a voice call scenario, if no SEI data is sent within 1min after calling this API, SDK will automatically cancel publishing black frames.
|
|
1744
|
-
* - After the message is sent successfully, the remote user who subscribed your video stream will receive
|
|
1744
|
+
* - After the message is sent successfully, the remote user who subscribed your video stream will receive {@link onSEIMessageReceived onSEIMessageReceived}.
|
|
1745
1745
|
* - When you switch from a voice call to a video call, SEI data will automatically start to be sent with normally captured video frames instead of black frames.
|
|
1746
1746
|
*
|
|
1747
1747
|
*/
|
|
@@ -1771,7 +1771,7 @@ export declare class RTCVideo {
|
|
|
1771
1771
|
* @region Audio & Video Processing
|
|
1772
1772
|
* @author zhushufan.ref
|
|
1773
1773
|
* @brief Gets video effect interfaces.
|
|
1774
|
-
* @return Video effect interfaces. See
|
|
1774
|
+
* @return Video effect interfaces. See {@link IVideoEffect IVideoEffect}.
|
|
1775
1775
|
*
|
|
1776
1776
|
*/
|
|
1777
1777
|
getVideoEffectInterface(): IVideoEffect;
|
|
@@ -1794,7 +1794,7 @@ export declare class RTCVideo {
|
|
|
1794
1794
|
* @note
|
|
1795
1795
|
* - You cannot use the basic beauty effects and the advanced effect features at the same time. See [how to use advanced effect features](https://docs.byteplus.com/byteplus-rtc/docs/114717) for more information.
|
|
1796
1796
|
* - You need to integrate Effect SDK before calling this API. Effect SDK v4.4.2+ is recommended.
|
|
1797
|
-
* - Call
|
|
1797
|
+
* - Call {@link setBeautyIntensity setBeautyIntensity} to set the beauty effect intensity. If you do not set the intensity before calling this API, the default intensity will be enabled. The default values for the intensity of each beauty mode are as follows: 0.7 for brightning, 0.8 for smoothing, 0.5 for sharpening, and 0.7 for clarity.
|
|
1798
1798
|
* - This API is not applicable to screen capturing.
|
|
1799
1799
|
*
|
|
1800
1800
|
*/
|
|
@@ -1804,7 +1804,7 @@ export declare class RTCVideo {
|
|
|
1804
1804
|
* @region Audio & Video Processing
|
|
1805
1805
|
* @author wangjunlin.3182
|
|
1806
1806
|
* @brief Sets the beauty effect intensity.
|
|
1807
|
-
* @param beautyMode Basic beauty effect. See
|
|
1807
|
+
* @param beautyMode Basic beauty effect. See {@link EffectBeautyMode EffectBeautyMode}.
|
|
1808
1808
|
* @param intensity Beauty effect intensity in range of [0,1]. When you set it to 0, the beauty effect will be turned off. <br>
|
|
1809
1809
|
* The default values for the intensity of each beauty mode are as follows: 0.7 for brightning, 0.8 for smoothing, 0.5 for sharpening, and 0.7 for clarity.
|
|
1810
1810
|
* @return
|
|
@@ -1813,7 +1813,7 @@ export declare class RTCVideo {
|
|
|
1813
1813
|
* - –1001: This API is not available for your current RTC SDK.
|
|
1814
1814
|
* - <0: Failure. Effect SDK internal error. For specific error code, see [error codes](https://docs.byteplus.com/effects/docs/error-code-table).
|
|
1815
1815
|
* @note
|
|
1816
|
-
* - If you call this API before calling
|
|
1816
|
+
* - If you call this API before calling {@link enableEffectBeauty enableEffectBeauty}, the default settings of beauty effect intensity will adjust accordingly.
|
|
1817
1817
|
* - If you destroy the engine, the beauty effect settings will be invalid.
|
|
1818
1818
|
*
|
|
1819
1819
|
*/
|
|
@@ -1825,10 +1825,10 @@ export declare class RTCVideo {
|
|
|
1825
1825
|
* @brief Sets the orientation of the video frame before custom video processing and encoding. The default value is `Adaptive`. <br>
|
|
1826
1826
|
* You should set the orientation to `Portrait` when using video effects or custom processing. <br>
|
|
1827
1827
|
* You should set the orientation to `Portrait` or `Landscape` when pushing a single stream to the CDN.
|
|
1828
|
-
* @param orientation Orientation of the video frame. See
|
|
1828
|
+
* @param orientation Orientation of the video frame. See {@link VideoOrientation VideoOrientation}.
|
|
1829
1829
|
* @return
|
|
1830
1830
|
* - 0: Success.
|
|
1831
|
-
* - < 0 : Fail. See
|
|
1831
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1832
1832
|
* @note
|
|
1833
1833
|
* - The orientation setting is only applicable to internal captured video sources. For custom captured video sources, setting the video frame orientation may result in errors, such as swapping width and height. Screen sources do not support video frame orientation setting.
|
|
1834
1834
|
* - We recommend setting the orientation before joining room. The updates of encoding configurations and the orientation are asynchronous, therefore can cause a brief malfunction in preview if you change the orientation after joining room.
|
|
@@ -1853,7 +1853,7 @@ export declare class RTCVideo {
|
|
|
1853
1853
|
* @brief Turn off speech recognition service
|
|
1854
1854
|
* @return
|
|
1855
1855
|
* - 0: Success.
|
|
1856
|
-
* - < 0 : Fail. See
|
|
1856
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1857
1857
|
*
|
|
1858
1858
|
*/
|
|
1859
1859
|
stopASR(): number;
|
|
@@ -1863,14 +1863,14 @@ export declare class RTCVideo {
|
|
|
1863
1863
|
* @author wangzhanqiang
|
|
1864
1864
|
* @brief This method records the audio & video data during the call to a local file.
|
|
1865
1865
|
* @param type Stream property, specifying whether to record mainstream or screen streams. See [StreamIndex](70083#streamindex-2)
|
|
1866
|
-
* @param config Local recording parameter configuration. See
|
|
1867
|
-
* @param recordingType Locally recorded media type, see
|
|
1866
|
+
* @param config Local recording parameter configuration. See {@link RecordingConfig RecordingConfig}
|
|
1867
|
+
* @param recordingType Locally recorded media type, see {@link RecordingType RecordingType}
|
|
1868
1868
|
* @return 0: Normal <br>
|
|
1869
1869
|
* -1: Parameter setting exception <br>
|
|
1870
1870
|
* -2: The current version of the SDK does not support this feature, please contact technical support staff
|
|
1871
1871
|
* @note
|
|
1872
|
-
* - Tune When you use this method, you get an
|
|
1873
|
-
* - If the recording is normal, the system will notify the recording progress through the
|
|
1872
|
+
* - Tune When you use this method, you get an {@link onRecordingStateUpdate onRecordingStateUpdate} callback.
|
|
1873
|
+
* - If the recording is normal, the system will notify the recording progress through the {@link onRecordingProgressUpdate onRecordingProgressUpdate} callback every second.
|
|
1874
1874
|
*
|
|
1875
1875
|
*/
|
|
1876
1876
|
startFileRecording(type: StreamIndex, config: RecordingConfig, recordingType: RecordingType): number;
|
|
@@ -1882,10 +1882,10 @@ export declare class RTCVideo {
|
|
|
1882
1882
|
* @param type Stream property, specify to stop mainstream or screen stream recording. See [StreamIndex](70083#streamindex-2)
|
|
1883
1883
|
* @return
|
|
1884
1884
|
* - 0: Success.
|
|
1885
|
-
* - < 0 : Fail. See
|
|
1885
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1886
1886
|
* @note
|
|
1887
|
-
* - Call
|
|
1888
|
-
* - After calling this method, you will receive an
|
|
1887
|
+
* - Call {@link startFileRecording startFileRecording} After starting local recording, you must call this method to stop recording.
|
|
1888
|
+
* - After calling this method, you will receive an {@link onRecordingStateUpdate onRecordingStateUpdate} callback prompting you to record the result.
|
|
1889
1889
|
*
|
|
1890
1890
|
*/
|
|
1891
1891
|
stopFileRecording(type: StreamIndex): number;
|
|
@@ -1893,17 +1893,17 @@ export declare class RTCVideo {
|
|
|
1893
1893
|
* @detail api
|
|
1894
1894
|
* @author huangshouqin
|
|
1895
1895
|
* @brief Starts recording audio communication, and generate the local file. <br>
|
|
1896
|
-
* If you call this API before or after joining the room without internal audio capture, then the recording task can still begin but the data will not be recorded in the local files. Only when you call
|
|
1897
|
-
* @param config See
|
|
1896
|
+
* If you call this API before or after joining the room without internal audio capture, then the recording task can still begin but the data will not be recorded in the local files. Only when you call {@link startAudioCapture startAudioCapture} to enable internal audio capture, the data will be recorded in the local files.
|
|
1897
|
+
* @param config See {@link AudioRecordingConfig AudioRecordingConfig}.
|
|
1898
1898
|
* @return
|
|
1899
1899
|
* - 0: Success
|
|
1900
1900
|
* - -2: Invalid parameters
|
|
1901
1901
|
* - -3: Not valid in this SDK. Please contact the technical support.
|
|
1902
1902
|
* @note
|
|
1903
1903
|
* - All audio effects are valid in the file. Mixed audio file is not included in the file.
|
|
1904
|
-
* - Call
|
|
1905
|
-
* - You can call this API before and after joining the room. If this API is called before you join the room, you need to call
|
|
1906
|
-
* - After calling the API, you'll receive
|
|
1904
|
+
* - Call {@link stopAudioRecording stopAudioRecording} to stop recording.
|
|
1905
|
+
* - You can call this API before and after joining the room. If this API is called before you join the room, you need to call {@link stopAudioRecording stopAudioRecording} to stop recording. If this API is called after you join the room, the recording task ends automatically. If you join multiple rooms, audio from all rooms are recorded in one file.
|
|
1906
|
+
* - After calling the API, you'll receive {@link onAudioRecordingStateUpdate onAudioRecordingStateUpdate}.
|
|
1907
1907
|
*
|
|
1908
1908
|
*/
|
|
1909
1909
|
startAudioRecording(config: AudioRecordingConfig): number;
|
|
@@ -1914,7 +1914,7 @@ export declare class RTCVideo {
|
|
|
1914
1914
|
* @return
|
|
1915
1915
|
* - 0: Success
|
|
1916
1916
|
* - <0: Failure
|
|
1917
|
-
* @note Call
|
|
1917
|
+
* @note Call {@link startAudioRecording startAudioRecording} to start the recording task.
|
|
1918
1918
|
*
|
|
1919
1919
|
*/
|
|
1920
1920
|
stopAudioRecording(): number;
|
|
@@ -1922,7 +1922,7 @@ export declare class RTCVideo {
|
|
|
1922
1922
|
* @valid since 3.53
|
|
1923
1923
|
* @detail api
|
|
1924
1924
|
* @brief Create an instance for audio effect player.
|
|
1925
|
-
* @return See
|
|
1925
|
+
* @return See {@link IAudioEffectPlayer IAudioEffectPlayer}.
|
|
1926
1926
|
*
|
|
1927
1927
|
*/
|
|
1928
1928
|
getAudioEffectPlayer(): IAudioEffectPlayer;
|
|
@@ -1931,7 +1931,7 @@ export declare class RTCVideo {
|
|
|
1931
1931
|
* @valid since 3.53
|
|
1932
1932
|
* @brief Create a media player instance.
|
|
1933
1933
|
* @param playerId Media player id. The range is `[0, 3]`. You can create up to 4 instances at the same time. If it exceeds the range, nullptr will be returned.
|
|
1934
|
-
* @return Media player instance. See
|
|
1934
|
+
* @return Media player instance. See {@link IMediaPlayer IMediaPlayer}.
|
|
1935
1935
|
*
|
|
1936
1936
|
*/
|
|
1937
1937
|
getMediaPlayer(playerId: number): IMediaPlayer;
|
|
@@ -1940,16 +1940,16 @@ export declare class RTCVideo {
|
|
|
1940
1940
|
* @region Screen Sharing
|
|
1941
1941
|
* @author liyi.000
|
|
1942
1942
|
* @brief Sets the screen audio source type. (internal capture/custom capture)
|
|
1943
|
-
* @param sourceType Screen audio source type. See
|
|
1943
|
+
* @param sourceType Screen audio source type. See {@link AudioSourceType AudioSourceType}.
|
|
1944
1944
|
* @return
|
|
1945
1945
|
* - 0: Success.
|
|
1946
|
-
* - < 0 : Fail. See
|
|
1946
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1947
1947
|
* @note
|
|
1948
1948
|
* - The default screen audio source type is RTC SDK internal capture.
|
|
1949
|
-
* - You should call this API before calling
|
|
1950
|
-
* - When using internal capture, you need to call
|
|
1951
|
-
* - When using custom capture, you need to call
|
|
1952
|
-
* - Whether you use internal capture or custom capture, you must call
|
|
1949
|
+
* - You should call this API before calling {@link publishScreen publishScreen}. Otherwise, you will receive {@link onWarning onWarning} with 'WARNING_CODE_SET_SCREEN_AUDIO_SOURCE_TYPE_FAILED'.
|
|
1950
|
+
* - When using internal capture, you need to call {@link startScreenCapture startScreenCapture} to start capturing. After that, as you switch to an external source by calling this API, the internal capture will stop.
|
|
1951
|
+
* - When using custom capture, you need to call {@link pushScreenAudioFrame pushScreenAudioFrame} to push the audio stream to the RTC SDK.
|
|
1952
|
+
* - Whether you use internal capture or custom capture, you must call {@link publishScreen publishScreen} to publish the captured screen audio stream.
|
|
1953
1953
|
*
|
|
1954
1954
|
*/
|
|
1955
1955
|
setScreenAudioSourceType(sourceType: AudioSourceType): number;
|
|
@@ -1963,8 +1963,8 @@ export declare class RTCVideo {
|
|
|
1963
1963
|
* - 'STREAM_INDEX_SCREEN': By default, it divides the screen audio stream and the audio stream collected by the microphone into two audio streams
|
|
1964
1964
|
* @return
|
|
1965
1965
|
* - 0: Success.
|
|
1966
|
-
* - < 0 : Fail. See
|
|
1967
|
-
* @note You should call this method before
|
|
1966
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1967
|
+
* @note You should call this method before {@link publishScreen publishScreen}. Otherwise, you will receive an error from {@link onWarning onWarning}: 'WARNING_CODE_SET_SCREEN_STREAM_INDEX_FAILED
|
|
1968
1968
|
*
|
|
1969
1969
|
*/
|
|
1970
1970
|
setScreenAudioStreamIndex(index: StreamIndex): number;
|
|
@@ -1973,16 +1973,16 @@ export declare class RTCVideo {
|
|
|
1973
1973
|
* @region Screen Sharing
|
|
1974
1974
|
* @author wangqianqian.1104
|
|
1975
1975
|
* @brief The RTC SDK start capturing the screen audio and/or video stream internally.
|
|
1976
|
-
* @param type Media type. See
|
|
1976
|
+
* @param type Media type. See {@link ScreenMediaType ScreenMediaType}
|
|
1977
1977
|
* @param mediaProjectionResultData The Intent obtained after applying for screen sharing permission from the Android device. See [getMediaProjection](https://developer.android.com/reference/android/media/projection/MediaProjectionManager#getMediaProjection (int,\% 20android.content. Intent)).
|
|
1978
1978
|
* @return
|
|
1979
1979
|
* - 0: Success.
|
|
1980
|
-
* - < 0 : Fail. See
|
|
1980
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1981
1981
|
* @note
|
|
1982
|
-
* - The call of this API takes effects only when you are using RTC SDK to record screen. You will get a warning by
|
|
1983
|
-
* - After capturing, you need to call
|
|
1984
|
-
* - You will receive
|
|
1985
|
-
* - To stop capturing, call
|
|
1982
|
+
* - The call of this API takes effects only when you are using RTC SDK to record screen. You will get a warning by {@link onVideoDeviceWarning onVideoDeviceWarning} or {@link onAudioDeviceWarning onAudioDeviceWarning} after calling this API when the source is set to an external recorder.
|
|
1983
|
+
* - After capturing, you need to call {@link publishScreen publishScreen} to push to the remote end.
|
|
1984
|
+
* - You will receive {@link onVideoDeviceStateChanged onVideoDeviceStateChanged} and {@link onAudioDeviceStateChanged onAudioDeviceStateChanged} when the capturing is started.
|
|
1985
|
+
* - To stop capturing, call {@link stopScreenCapture stopScreenCapture}.
|
|
1986
1986
|
*
|
|
1987
1987
|
*/
|
|
1988
1988
|
startScreenCapture(type: ScreenMediaType, mediaProjectionResultData: Intent): number;
|
|
@@ -1991,11 +1991,11 @@ export declare class RTCVideo {
|
|
|
1991
1991
|
* @region Screen Sharing
|
|
1992
1992
|
* @author wangqianqian.1104
|
|
1993
1993
|
* @brief Updates the media type of the internal screen capture.
|
|
1994
|
-
* @param type Media type. See
|
|
1994
|
+
* @param type Media type. See {@link ScreenMediaType ScreenMediaType}.
|
|
1995
1995
|
* @return
|
|
1996
1996
|
* - 0: Success.
|
|
1997
|
-
* - < 0 : Fail. See
|
|
1998
|
-
* @note Call this API after calling
|
|
1997
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
1998
|
+
* @note Call this API after calling {@link startScreenCapture startScreenCapture}.
|
|
1999
1999
|
*
|
|
2000
2000
|
*/
|
|
2001
2001
|
updateScreenCapture(type: ScreenMediaType): number;
|
|
@@ -2005,10 +2005,10 @@ export declare class RTCVideo {
|
|
|
2005
2005
|
* @region Video management
|
|
2006
2006
|
* @author wangzhanqiang
|
|
2007
2007
|
* @brief Register custom coded frame push event callback
|
|
2008
|
-
* @param handler Custom coded frame callback class. See
|
|
2008
|
+
* @param handler Custom coded frame callback class. See {@link IExternalVideoEncoderEventHandler IExternalVideoEncoderEventHandler}
|
|
2009
2009
|
* @return
|
|
2010
2010
|
* - 0: Success.
|
|
2011
|
-
* - < 0 : Fail. See
|
|
2011
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2012
2012
|
* @note
|
|
2013
2013
|
* - This method needs to be called before entering the room.
|
|
2014
2014
|
* - The engine needs to be unregistered before it is destroyed. Call this method to set the parameter to "null".
|
|
@@ -2020,13 +2020,13 @@ export declare class RTCVideo {
|
|
|
2020
2020
|
* @region Video Management
|
|
2021
2021
|
* @author wangzhanqiang
|
|
2022
2022
|
* @brief Before subscribing to the remote video stream, set the remote video data decoding method
|
|
2023
|
-
* @param key The remote stream information specifies which video stream to decode. See
|
|
2024
|
-
* @param config Video decoding method. See
|
|
2023
|
+
* @param key The remote stream information specifies which video stream to decode. See {@link RemoteStreamKey RemoteStreamKey}.
|
|
2024
|
+
* @param config Video decoding method. See {@link VideoDecoderConfig VideoDecoderConfig}.
|
|
2025
2025
|
* @return
|
|
2026
2026
|
* - 0: Success.
|
|
2027
|
-
* - < 0 : Fail. See
|
|
2027
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2028
2028
|
* @note
|
|
2029
|
-
* - When you want to custom decode a remote stream, you need to call
|
|
2029
|
+
* - When you want to custom decode a remote stream, you need to call {@link registerRemoteEncodedVideoFrameObserver registerRemoteEncodedVideoFrameObserver} to register the remote video stream monitor, and then call the interface to set the decoding method to custom decoding. The monitored video data will be called back through {@link onRemoteEncodedVideoFrame onRemoteEncodedVideoFrame}.
|
|
2030
2030
|
* - Since version 3.56, for automatic subscription, you can set the `RoomId` and `UserId` of `key` as `nullptr`. In this case, the decoding settings set by calling the API applies to all remote main streams or screen sharing streams based on the `StreamIndex` value of `key`.
|
|
2031
2031
|
*
|
|
2032
2032
|
*/
|
|
@@ -2036,13 +2036,13 @@ export declare class RTCVideo {
|
|
|
2036
2036
|
* @region Video Management
|
|
2037
2037
|
* @author liuyangyang
|
|
2038
2038
|
* @brief After subscribing to the remote video stream, request the keyframe
|
|
2039
|
-
* @param streamKey Remote stream information to the remote. See
|
|
2039
|
+
* @param streamKey Remote stream information to the remote. See {@link RemoteStreamKey RemoteStreamKey}.
|
|
2040
2040
|
* @return
|
|
2041
2041
|
* - 0: Success.
|
|
2042
|
-
* - < 0 : Fail. See
|
|
2042
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2043
2043
|
* @note
|
|
2044
2044
|
* - This method is only suitable for manual subscription mode and is used after successful subscription to the remote flow.
|
|
2045
|
-
* - This method is suitable for calling
|
|
2045
|
+
* - This method is suitable for calling {@link setVideoDecoderConfig setVideoDecoderConfig} to turn on the custom decoding function, and the custom decoding fails
|
|
2046
2046
|
*
|
|
2047
2047
|
*/
|
|
2048
2048
|
requestRemoteVideoKeyFrame(streamKey: RemoteStreamKey): number;
|
|
@@ -2051,10 +2051,10 @@ export declare class RTCVideo {
|
|
|
2051
2051
|
* @region Audio management
|
|
2052
2052
|
* @author majun.lvhiei
|
|
2053
2053
|
* @brief Enable/Disable in-ear monitoring.
|
|
2054
|
-
* @param mode Whether to enable in-ear monitoring. See
|
|
2054
|
+
* @param mode Whether to enable in-ear monitoring. See {@link EarMonitorMode EarMonitorMode}.
|
|
2055
2055
|
* @return
|
|
2056
2056
|
* - 0: Success.
|
|
2057
|
-
* - < 0 : Fail. See
|
|
2057
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2058
2058
|
* @note
|
|
2059
2059
|
* - In-ear monitoring is effective for audios captured by the RTC SDK.
|
|
2060
2060
|
* - We recommend that you use wired earbuds/headphones for a low-latency experience.
|
|
@@ -2070,9 +2070,9 @@ export declare class RTCVideo {
|
|
|
2070
2070
|
* @param volume The monitoring volume with the adjustment range between 0\% and 100\%.
|
|
2071
2071
|
* @return
|
|
2072
2072
|
* - 0: Success.
|
|
2073
|
-
* - < 0 : Fail. See
|
|
2073
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2074
2074
|
* @note
|
|
2075
|
-
* - Call
|
|
2075
|
+
* - Call {@link setEarMonitorMode setEarMonitorMode} before setting the volume.
|
|
2076
2076
|
*
|
|
2077
2077
|
*/
|
|
2078
2078
|
setEarMonitorVolume(volume: number): number;
|
|
@@ -2080,11 +2080,11 @@ export declare class RTCVideo {
|
|
|
2080
2080
|
* @detail api
|
|
2081
2081
|
* @region Audio Management
|
|
2082
2082
|
* @author wangjunzheng
|
|
2083
|
-
* @brief Enable audio information prompts. After that, you will receive
|
|
2084
|
-
* @param config See
|
|
2083
|
+
* @brief Enable audio information prompts. After that, you will receive {@link onLocalAudioPropertiesReport onLocalAudioPropertiesReport}, {@link onRemoteAudioPropertiesReport onRemoteAudioPropertiesReport}, and {@link onActiveSpeaker onActiveSpeaker}.
|
|
2084
|
+
* @param config See {@link AudioPropertiesConfig AudioPropertiesConfig}
|
|
2085
2085
|
* @return
|
|
2086
2086
|
* - 0: Success.
|
|
2087
|
-
* - < 0 : Fail. See
|
|
2087
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2088
2088
|
*
|
|
2089
2089
|
*/
|
|
2090
2090
|
enableAudioPropertiesReport(config: AudioPropertiesConfig): number;
|
|
@@ -2092,15 +2092,15 @@ export declare class RTCVideo {
|
|
|
2092
2092
|
* @detail api
|
|
2093
2093
|
* @region Audio management
|
|
2094
2094
|
* @author wangjunzheng
|
|
2095
|
-
* @brief Send audio stream synchronization information. The message is sent to the remote end through the audio stream and synchronized with the audio stream. After the interface is successfully called, the remote user will receive a
|
|
2095
|
+
* @brief Send audio stream synchronization information. The message is sent to the remote end through the audio stream and synchronized with the audio stream. After the interface is successfully called, the remote user will receive a {@link onStreamSyncInfoReceived onStreamSyncInfoReceived} callback.
|
|
2096
2096
|
* @param data Message content.
|
|
2097
|
-
* @param config Configuration related to audio stream synchronization information. See
|
|
2097
|
+
* @param config Configuration related to audio stream synchronization information. See {@link StreamSycnInfoConfig StreamSycnInfoConfig}.
|
|
2098
2098
|
* @return
|
|
2099
2099
|
* - > = 0: Message sent successfully. Returns the number of successful sends.
|
|
2100
2100
|
* - -1: Message sending failed. Message length greater than 16 bytes.
|
|
2101
2101
|
* - -2: Message sending failed. The content of the incoming message is empty.
|
|
2102
2102
|
* - -3: Message sending failed. This screen stream was not published when the message was synchronized through the screen stream.
|
|
2103
|
-
* - -4: Message sending failed. This audio stream is not yet published when you synchronize messages with an audio stream captured by a microphone or custom device, as described in
|
|
2103
|
+
* - -4: Message sending failed. This audio stream is not yet published when you synchronize messages with an audio stream captured by a microphone or custom device, as described in {@link ErrorCode ErrorCode}.
|
|
2104
2104
|
* @note
|
|
2105
2105
|
* - Regarding the frequency, we recommend no more than 50 calls per second.
|
|
2106
2106
|
* - When using `CHANNEL_PROFILE_INTERACTIVE_PODCAST` as room profile, the data will be delivered. For other coom profiles, the data may be lost when the local user is muted.
|
|
@@ -2115,7 +2115,7 @@ export declare class RTCVideo {
|
|
|
2115
2115
|
* @return
|
|
2116
2116
|
* - true: Support
|
|
2117
2117
|
* - false: Not supported
|
|
2118
|
-
* @note You must have called
|
|
2118
|
+
* @note You must have called {@link startVideoCapture startVideoCapture} for video capture using the SDK internal capture module to detect flash capability.
|
|
2119
2119
|
*
|
|
2120
2120
|
*/
|
|
2121
2121
|
isCameraTorchSupported(): boolean;
|
|
@@ -2127,7 +2127,7 @@ export declare class RTCVideo {
|
|
|
2127
2127
|
* @return
|
|
2128
2128
|
* - true: Support
|
|
2129
2129
|
* - false: Not supported
|
|
2130
|
-
* @note Camera zoom capability can only be detected if
|
|
2130
|
+
* @note Camera zoom capability can only be detected if {@link startVideoCapture startVideoCapture} is used for video capture using the SDK internal capture module.
|
|
2131
2131
|
*
|
|
2132
2132
|
*/
|
|
2133
2133
|
isCameraZoomSupported(): boolean;
|
|
@@ -2137,14 +2137,14 @@ export declare class RTCVideo {
|
|
|
2137
2137
|
* @author zhangzhenyu.samuel
|
|
2138
2138
|
* @brief Change the optical zoom magnification.
|
|
2139
2139
|
* @param zoom Zoom magnification of the currently used camera (front/postcondition). The value range is [1, < Maximum Zoom Multiplier >]. <br>
|
|
2140
|
-
* The maximum zoom factor can be obtained by calling
|
|
2140
|
+
* The maximum zoom factor can be obtained by calling {@link getCameraZoomMaxRatio getCameraZoomMaxRatio}.
|
|
2141
2141
|
* @return
|
|
2142
2142
|
* - 0: Success.
|
|
2143
2143
|
* - < 0: Failed.
|
|
2144
2144
|
* @note
|
|
2145
|
-
* - The camera zoom factor can only be set when
|
|
2146
|
-
* - The setting result fails after calling
|
|
2147
|
-
* - Call
|
|
2145
|
+
* - The camera zoom factor can only be set when {@link startVideoCapture startVideoCapture} is called for video capture using the SDK internal capture module.
|
|
2146
|
+
* - The setting result fails after calling {@link stopVideoCapture stopVideoCapture} to turn off internal collection.
|
|
2147
|
+
* - Call {@link setVideoDigitalZoomConfig setVideoDigitalZoomConfig} to set digital zoom. Call {@link setVideoDigitalZoomControl setVideoDigitalZoomControl} to perform digital zoom.
|
|
2148
2148
|
*
|
|
2149
2149
|
*/
|
|
2150
2150
|
setCameraZoomRatio(zoom: number): number;
|
|
@@ -2154,7 +2154,7 @@ export declare class RTCVideo {
|
|
|
2154
2154
|
* @author zhangzhenyu.samuel
|
|
2155
2155
|
* @brief Get the maximum zoom factor of the currently used camera (front/postcondition)
|
|
2156
2156
|
* @return Maximum zoom factor
|
|
2157
|
-
* @note You must have called
|
|
2157
|
+
* @note You must have called {@link startVideoCapture startVideoCapture} using the SDK internal capture module for video capture, the maximum zoom factor of the camera can be detected.
|
|
2158
2158
|
*
|
|
2159
2159
|
*/
|
|
2160
2160
|
getCameraZoomMaxRatio(): number;
|
|
@@ -2163,13 +2163,13 @@ export declare class RTCVideo {
|
|
|
2163
2163
|
* @region video management
|
|
2164
2164
|
* @author zhangzhenyu.samuel
|
|
2165
2165
|
* @brief Turn on/off the flash state of the currently used camera (front/postcondition)
|
|
2166
|
-
* @param torchState Flash state. Refer to
|
|
2166
|
+
* @param torchState Flash state. Refer to {@link TorchState TorchState}
|
|
2167
2167
|
* @return
|
|
2168
2168
|
* - 0: Success.
|
|
2169
2169
|
* - < 0: Failed.
|
|
2170
2170
|
* @note
|
|
2171
|
-
* - The flash can only be set if you have called
|
|
2172
|
-
* - The setting result fails after calling
|
|
2171
|
+
* - The flash can only be set if you have called {@link startVideoCapture startVideoCapture} for video capture using the SDK internal capture module.
|
|
2172
|
+
* - The setting result fails after calling {@link stopVideoCapture stopVideoCapture} to turn off internal collection.
|
|
2173
2173
|
*
|
|
2174
2174
|
*/
|
|
2175
2175
|
setCameraTorch(torchState: TorchState): number;
|
|
@@ -2181,7 +2181,7 @@ export declare class RTCVideo {
|
|
|
2181
2181
|
* @return
|
|
2182
2182
|
* - true: Available.
|
|
2183
2183
|
* - false: Unavailable.
|
|
2184
|
-
* @note You must call
|
|
2184
|
+
* @note You must call {@link startVideoCapture startVideoCapture} to start SDK internal video capturing before calling this API.
|
|
2185
2185
|
*
|
|
2186
2186
|
*/
|
|
2187
2187
|
isCameraFocusPositionSupported(): boolean;
|
|
@@ -2196,9 +2196,9 @@ export declare class RTCVideo {
|
|
|
2196
2196
|
* - 0: Success.
|
|
2197
2197
|
* - < 0: Failure.
|
|
2198
2198
|
* @note
|
|
2199
|
-
* - You must call
|
|
2199
|
+
* - You must call {@link startVideoCapture startVideoCapture} to start SDK internal video capturing, and use SDK internal rendering before calling this API.
|
|
2200
2200
|
* - The focus point setting will be canceled when you move the device.
|
|
2201
|
-
* - The camera focus point setting will be invalid after calling
|
|
2201
|
+
* - The camera focus point setting will be invalid after calling {@link stopVideoCapture stopVideoCapture} to stop internal capturing.
|
|
2202
2202
|
*
|
|
2203
2203
|
*/
|
|
2204
2204
|
setCameraFocusPosition(x: number, y: number): number;
|
|
@@ -2210,7 +2210,7 @@ export declare class RTCVideo {
|
|
|
2210
2210
|
* @return
|
|
2211
2211
|
* - true: Available.
|
|
2212
2212
|
* - false: Unavailable.
|
|
2213
|
-
* @note You must call
|
|
2213
|
+
* @note You must call {@link startVideoCapture startVideoCapture} to start SDK internal video capturing before calling this API.
|
|
2214
2214
|
*
|
|
2215
2215
|
*/
|
|
2216
2216
|
isCameraExposurePositionSupported(): boolean;
|
|
@@ -2225,9 +2225,9 @@ export declare class RTCVideo {
|
|
|
2225
2225
|
* - 0: Success.
|
|
2226
2226
|
* - < 0: Failure.
|
|
2227
2227
|
* @note
|
|
2228
|
-
* - You must call
|
|
2228
|
+
* - You must call {@link startVideoCapture startVideoCapture} to start SDK internal video capturing, and use SDK internal rendering before calling this API.
|
|
2229
2229
|
* - The exposure point setting will be canceled when you move the device.
|
|
2230
|
-
* - The camera exposure point setting will be invalid after calling
|
|
2230
|
+
* - The camera exposure point setting will be invalid after calling {@link stopVideoCapture stopVideoCapture} to stop internal capturing.
|
|
2231
2231
|
*
|
|
2232
2232
|
*/
|
|
2233
2233
|
setCameraExposurePosition(x: number, y: number): number;
|
|
@@ -2241,8 +2241,8 @@ export declare class RTCVideo {
|
|
|
2241
2241
|
* - 0: Success.
|
|
2242
2242
|
* - < 0: Failure.
|
|
2243
2243
|
* @note
|
|
2244
|
-
* - You must call
|
|
2245
|
-
* - The camera exposure compensation setting will be invalid after calling
|
|
2244
|
+
* - You must call {@link startVideoCapture startVideoCapture} to start SDK internal video capturing, and use SDK internal rendering before calling this API.
|
|
2245
|
+
* - The camera exposure compensation setting will be invalid after calling {@link stopVideoCapture stopVideoCapture} to stop internal capturing.
|
|
2246
2246
|
*
|
|
2247
2247
|
*/
|
|
2248
2248
|
setCameraExposureCompensation(val: number): number;
|
|
@@ -2255,7 +2255,7 @@ export declare class RTCVideo {
|
|
|
2255
2255
|
* @return
|
|
2256
2256
|
* - 0: Success.
|
|
2257
2257
|
* - < 0: Failure.
|
|
2258
|
-
* @note You must call this API before calling
|
|
2258
|
+
* @note You must call this API before calling {@link startVideoCapture startVideoCapture} to enable internal capture to make the setting valid.
|
|
2259
2259
|
*
|
|
2260
2260
|
*/
|
|
2261
2261
|
enableCameraAutoExposureFaceMode(enable: boolean): number;
|
|
@@ -2265,12 +2265,12 @@ export declare class RTCVideo {
|
|
|
2265
2265
|
* @valid since 353
|
|
2266
2266
|
* @brief Set the minimum frame rate of of the dynamic framerate mode during internal video capture.
|
|
2267
2267
|
* @param framerate The minimum value in fps. The default value is 7. <br>
|
|
2268
|
-
* The maximum value of the dynamic framerate mode is set by calling
|
|
2268
|
+
* The maximum value of the dynamic framerate mode is set by calling {@link setVideoCaptureConfig setVideoCaptureConfig}. When minimum value exceeds the maximum value, the frame rate is set to a fixed value as the maximum value; otherwise, dynamic framerate mode is enabled.
|
|
2269
2269
|
* @return
|
|
2270
2270
|
* - 0: Success.
|
|
2271
2271
|
* - !0: Failure.
|
|
2272
2272
|
* @note
|
|
2273
|
-
* - You must call this API before calling
|
|
2273
|
+
* - You must call this API before calling {@link startVideoCapture startVideoCapture} to enable internal capture to make the setting valid.
|
|
2274
2274
|
* - If the maximum frame rate changes due to performance degradation, static adaptation, etc., the set minimum frame rate value will be re-compared with the new maximum value. Changes in comparison results may cause switch between fixed and dynamic frame rate modes.
|
|
2275
2275
|
*
|
|
2276
2276
|
*/
|
|
@@ -2280,18 +2280,18 @@ export declare class RTCVideo {
|
|
|
2280
2280
|
* @hidden currently not available
|
|
2281
2281
|
* @detail api
|
|
2282
2282
|
* @brief Start publishing a public media stream. <br>
|
|
2283
|
-
* Users within the same `appID` can call
|
|
2283
|
+
* Users within the same `appID` can call {@link startPlayPublicStream startPlayPublicStream} to subscribe to the public stream regardless the user has joined which room or has not joined any room.
|
|
2284
2284
|
* @param publicStreamId ID of the public stream
|
|
2285
|
-
* @param publicStream Properties of the public stream. Refer to
|
|
2285
|
+
* @param publicStream Properties of the public stream. Refer to {@link PublicStreaming PublicStreaming} for more details. <br>
|
|
2286
2286
|
* A public stream can include a bundle of media streams and appears as the designated layout.
|
|
2287
2287
|
* @return
|
|
2288
|
-
* - 0: Success. And you will be informed by
|
|
2288
|
+
* - 0: Success. And you will be informed by {@link onPushPublicStreamResult onPushPublicStreamResult}.
|
|
2289
2289
|
* - !0: Failure because of invalid parameter or empty parameters.
|
|
2290
2290
|
* @note
|
|
2291
|
-
* - Call
|
|
2291
|
+
* - Call {@link updatePublicStreamParam updatePublicStreamParam} to update the properties of the public stream which is published by the same user. Calling this API with the same stream ID repeatedly by the same user can not update the existing public stream.
|
|
2292
2292
|
* - If Users with different userID call this API with the same stream ID, the public stream will be updated with the parameters passed in the latest call.
|
|
2293
2293
|
* - To publish multiple public streams, call this API with different stream ID respectively.
|
|
2294
|
-
* - To stop publishing the public stream, call
|
|
2294
|
+
* - To stop publishing the public stream, call {@link stopPushPublicStream stopPushPublicStream}.
|
|
2295
2295
|
* - Please contact ts to enable this function before using it.
|
|
2296
2296
|
*
|
|
2297
2297
|
*/
|
|
@@ -2300,7 +2300,7 @@ export declare class RTCVideo {
|
|
|
2300
2300
|
* @hidden currently not available.
|
|
2301
2301
|
* @detail api
|
|
2302
2302
|
* @brief Stop the public stream published by the current user. <br>
|
|
2303
|
-
* Refer to
|
|
2303
|
+
* Refer to {@link startPushPublicStream startPushPublicStream} for details about starting publishing a public stream.
|
|
2304
2304
|
* @param publicStreamId ID of the public stream <br>
|
|
2305
2305
|
* The public stream must be published by the current user.
|
|
2306
2306
|
* @return
|
|
@@ -2313,14 +2313,14 @@ export declare class RTCVideo {
|
|
|
2313
2313
|
* @hidden currently not available.
|
|
2314
2314
|
* @detail api
|
|
2315
2315
|
* @brief Update the properties of the public stream published by the current user. <br>
|
|
2316
|
-
* Refer to
|
|
2316
|
+
* Refer to {@link startPushPublicStream startPushPublicStream} for details about starting publishing a public stream.
|
|
2317
2317
|
* @param publicStreamId ID of the public stream <br>
|
|
2318
2318
|
* The stream to be updated must be published by the current user.
|
|
2319
|
-
* @param transcoding Properties of the public stream. Refer to
|
|
2319
|
+
* @param transcoding Properties of the public stream. Refer to {@link PublicStreaming PublicStreaming} for more details.current user.
|
|
2320
2320
|
* @return
|
|
2321
2321
|
* - 0: Success
|
|
2322
2322
|
* - !0: Failure
|
|
2323
|
-
* @note Make sure the public stream has started successfully via
|
|
2323
|
+
* @note Make sure the public stream has started successfully via {@link onPushPublicStreamResult onPushPublicStreamResult} before calling this API.
|
|
2324
2324
|
*
|
|
2325
2325
|
*/
|
|
2326
2326
|
updatePublicStreamParam(publicStreamId: string, transcoding: PublicStreaming): number;
|
|
@@ -2329,7 +2329,7 @@ export declare class RTCVideo {
|
|
|
2329
2329
|
* @hidden currently not available.
|
|
2330
2330
|
* @detail api
|
|
2331
2331
|
* @brief Cancel subscribing the public stream. <br>
|
|
2332
|
-
* Call this method to cancel subscribing to the public stream by calling
|
|
2332
|
+
* Call this method to cancel subscribing to the public stream by calling {@link startPlayPublicStream sstartPlayPublicStream}.
|
|
2333
2333
|
* @param publicStreamId ID of the public stream
|
|
2334
2334
|
* @return
|
|
2335
2335
|
* - 0: Success
|
|
@@ -2342,7 +2342,7 @@ export declare class RTCVideo {
|
|
|
2342
2342
|
* @detail api
|
|
2343
2343
|
* @brief Assign a internal render view to the public stream
|
|
2344
2344
|
* @param publicStreamId ID of the public stream
|
|
2345
|
-
* @param canvas Internal render view. Set to be a blank view if you want to unbind. Refer to
|
|
2345
|
+
* @param canvas Internal render view. Set to be a blank view if you want to unbind. Refer to {@link VideoCanvas VideoCanvas} for more details.
|
|
2346
2346
|
* @return
|
|
2347
2347
|
* - 0: Success
|
|
2348
2348
|
* - !0: Failure
|
|
@@ -2370,7 +2370,7 @@ export declare class RTCVideo {
|
|
|
2370
2370
|
* @brief Starts a call test. <br>
|
|
2371
2371
|
* Before entering the room, you can call this API to test whether your local audio/video equipment as well as the upstream and downstream networks are working correctly. <br>
|
|
2372
2372
|
* Once the test starts, SDK will record your sound or video. If you receive the playback within the delay range you set, the test is considered normal.
|
|
2373
|
-
* @param config Test configurations, see
|
|
2373
|
+
* @param config Test configurations, see {@link EchoTestConfig EchoTestConfig}.
|
|
2374
2374
|
* @param delayTime Delayed audio/video playback time specifying how long you expect to receive the playback after starting the. The range of the value is [2,10] in seconds and the default value is 2.
|
|
2375
2375
|
* @return API call result: <br>
|
|
2376
2376
|
* - 0: Success
|
|
@@ -2380,10 +2380,10 @@ export declare class RTCVideo {
|
|
|
2380
2380
|
* - -4: Failure, parameter exception
|
|
2381
2381
|
* - -5: Failure, the roomID is already used
|
|
2382
2382
|
* @note
|
|
2383
|
-
* - Once you start the test, you can either call
|
|
2383
|
+
* - Once you start the test, you can either call {@link stopEchoTest stopEchoTest} or wait until the test stops automatically after 60s, to start the next test or enter the room.
|
|
2384
2384
|
* - All APIs related to device control and stream control called before this API are invalidated during the test and are restored after the test.
|
|
2385
|
-
* - All APIs related to device control, stream control, and room entry called during the test do not take effect, and you will receive
|
|
2386
|
-
* - You will receive the test result from
|
|
2385
|
+
* - All APIs related to device control, stream control, and room entry called during the test do not take effect, and you will receive {@link onWarning onWarning} with the warning code `WARNING_CODE_IN_ECHO_TEST_MODE`.
|
|
2386
|
+
* - You will receive the test result from {@link onEchoTestResult onEchoTestResult}.
|
|
2387
2387
|
*
|
|
2388
2388
|
*/
|
|
2389
2389
|
startEchoTest(config: EchoTestConfig, delayTime: number): number;
|
|
@@ -2392,7 +2392,7 @@ export declare class RTCVideo {
|
|
|
2392
2392
|
* @region Network Management
|
|
2393
2393
|
* @author qipengxiang
|
|
2394
2394
|
* @brief Stop the current call test. <br>
|
|
2395
|
-
* After calling
|
|
2395
|
+
* After calling {@link startEchoTest startEchoTest}, you must call this API to stop the test.
|
|
2396
2396
|
* @return API call result: <br>
|
|
2397
2397
|
* - 0: Success
|
|
2398
2398
|
* - -1: Failure, no test is in progress
|
|
@@ -2408,7 +2408,7 @@ export declare class RTCVideo {
|
|
|
2408
2408
|
* @param streamIndex Targeting stream index of the watermark. See [StreamIndex](70083#streamindex-2).
|
|
2409
2409
|
* @return
|
|
2410
2410
|
* - 0: Success.
|
|
2411
|
-
* - < 0 : Fail. See
|
|
2411
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2412
2412
|
*
|
|
2413
2413
|
*/
|
|
2414
2414
|
clearVideoWatermark(streamIndex: StreamIndex): number;
|
|
@@ -2441,15 +2441,15 @@ export declare class RTCVideo {
|
|
|
2441
2441
|
* @region cloud proxy
|
|
2442
2442
|
* @author daining.nemo
|
|
2443
2443
|
* @brief Start cloud proxy
|
|
2444
|
-
* @param cloudProxiesInfo cloud proxy informarion list. See
|
|
2444
|
+
* @param cloudProxiesInfo cloud proxy informarion list. See {@link CloudProxyInfo CloudProxyInfo}.
|
|
2445
2445
|
* @return
|
|
2446
2446
|
* - 0: Success.
|
|
2447
|
-
* - < 0 : Fail. See
|
|
2447
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2448
2448
|
* @note
|
|
2449
2449
|
* - Call this API before joining the room.
|
|
2450
2450
|
* - Start pre-call network detection after starting cloud proxy.
|
|
2451
|
-
* - After starting cloud proxy and connects the cloud proxy server successfully, receives
|
|
2452
|
-
* - To stop cloud proxy, call
|
|
2451
|
+
* - After starting cloud proxy and connects the cloud proxy server successfully, receives {@link onCloudProxyConnected onCloudProxyConnected}.
|
|
2452
|
+
* - To stop cloud proxy, call {@link stopCloudProxy stopCloudProxy}.
|
|
2453
2453
|
*
|
|
2454
2454
|
*/
|
|
2455
2455
|
startCloudProxy(cloudProxiesInfo: Array<CloudProxyInfo>): number;
|
|
@@ -2460,8 +2460,8 @@ export declare class RTCVideo {
|
|
|
2460
2460
|
* @brief Stop cloud proxy
|
|
2461
2461
|
* @return
|
|
2462
2462
|
* - 0: Success.
|
|
2463
|
-
* - < 0 : Fail. See
|
|
2464
|
-
* @note To start cloud proxy, call
|
|
2463
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2464
|
+
* @note To start cloud proxy, call {@link startCloudProxy startCloudProxy}.
|
|
2465
2465
|
*
|
|
2466
2466
|
*/
|
|
2467
2467
|
stopCloudProxy(): number;
|
|
@@ -2469,7 +2469,7 @@ export declare class RTCVideo {
|
|
|
2469
2469
|
* @detail api
|
|
2470
2470
|
* @author wangjunzheng
|
|
2471
2471
|
* @brief Create a karaoke scoring management interface.
|
|
2472
|
-
* @return Karaoke scoring management interface. See
|
|
2472
|
+
* @return Karaoke scoring management interface. See {@link ISingScoringManager ISingScoringManager}.
|
|
2473
2473
|
*
|
|
2474
2474
|
*/
|
|
2475
2475
|
getSingScoringManager(): ISingScoringManager;
|
|
@@ -2477,9 +2477,9 @@ export declare class RTCVideo {
|
|
|
2477
2477
|
* @detail api
|
|
2478
2478
|
* @author songxiaomeng.19
|
|
2479
2479
|
* @brief Obtain the synchronization network time information.
|
|
2480
|
-
* @return See
|
|
2480
|
+
* @return See {@link NetworkTimeInfo NetworkTimeInfo}.
|
|
2481
2481
|
* @note
|
|
2482
|
-
* - When you call this API for the first time, you starts synchornizing the network time information and receive the return value `0`. After the synchonization finishes, you will receive
|
|
2482
|
+
* - When you call this API for the first time, you starts synchornizing the network time information and receive the return value `0`. After the synchonization finishes, you will receive {@link onNetworkTimeSynchronized onNetworkTimeSynchronized}. After that, calling this API will get you the correct network time.
|
|
2483
2483
|
* - Under chorus scenario, participants shall start audio mixing at the same network time.
|
|
2484
2484
|
*
|
|
2485
2485
|
*/
|
|
@@ -2489,7 +2489,7 @@ export declare class RTCVideo {
|
|
|
2489
2489
|
* @detail api
|
|
2490
2490
|
* @author lihuan.wuti2ha
|
|
2491
2491
|
* @brief Creates the KTV manager interfaces.
|
|
2492
|
-
* @return KTV manager interfaces. See
|
|
2492
|
+
* @return KTV manager interfaces. See {@link IKTVManager IKTVManager}.
|
|
2493
2493
|
*
|
|
2494
2494
|
*/
|
|
2495
2495
|
getKTVManager(): IKTVManager;
|
|
@@ -2503,15 +2503,15 @@ export declare class RTCVideo {
|
|
|
2503
2503
|
* Do not pass a Silent file.
|
|
2504
2504
|
* @return Method call result: <br>
|
|
2505
2505
|
* - 0: Success.
|
|
2506
|
-
* - -1: Failure due to the onging process of the previous detection. Call
|
|
2506
|
+
* - -1: Failure due to the onging process of the previous detection. Call {@link stopHardwareEchoDetection stopHardwareEchoDetection} to stop it before calling this API again.
|
|
2507
2507
|
* - -2: Failure due to an invalid file path or file format.
|
|
2508
2508
|
* @note
|
|
2509
|
-
* - You can use this feature only when
|
|
2509
|
+
* - You can use this feature only when {@link ChannelProfile ChannelProfile} is set to `CHANNEL_PROFIEL_MEETING` or `CHANNEL_PROFILE_MEETING_ROOM`.
|
|
2510
2510
|
* - Before calling this API, ask the user for the permissions to access the local audio devices.
|
|
2511
2511
|
* - Before calling this api, make sure the audio devices are activate and keep the capture volume and the playback volume within a reasonable range.
|
|
2512
2512
|
* - The detection result is passed as the argument of onHardwareEchoDetectionResult.
|
|
2513
|
-
* - During the detection, the SDK is not able to response to the other testing APIs, such as
|
|
2514
|
-
* - Call
|
|
2513
|
+
* - During the detection, the SDK is not able to response to the other testing APIs, such as {@link startEchoTest startEchoTest}, {@link startAudioDeviceRecordTest startAudioDeviceRecordTest} or {@link startAudioPlaybackDeviceTest startAudioPlaybackDeviceTest}.
|
|
2514
|
+
* - Call {@link stopHardwareEchoDetection stopHardwareEchoDetection} to stop the detection and release the audio devices.
|
|
2515
2515
|
*
|
|
2516
2516
|
*/
|
|
2517
2517
|
startHardwareEchoDetection(testAudioFilePath: string): number;
|
|
@@ -2524,8 +2524,8 @@ export declare class RTCVideo {
|
|
|
2524
2524
|
* - 0: Success.
|
|
2525
2525
|
* - -1: Failure.
|
|
2526
2526
|
* @note
|
|
2527
|
-
* - Refer to
|
|
2528
|
-
* - We recommend calling this API to stop the detection once getting the detection result from
|
|
2527
|
+
* - Refer to {@link startHardwareEchoDetection startHardwareEchoDetection} for information on how to start a echo detection.
|
|
2528
|
+
* - We recommend calling this API to stop the detection once getting the detection result from {@link onHardwareEchoDetectionResult onHardwareEchoDetectionResult}.
|
|
2529
2529
|
* - You must stop the echo detection to release the audio devices before the user joins a room. Otherwise, the detection may interfere with the call.
|
|
2530
2530
|
*
|
|
2531
2531
|
*/
|
|
@@ -2533,7 +2533,7 @@ export declare class RTCVideo {
|
|
|
2533
2533
|
/** {en}
|
|
2534
2534
|
* @detail api
|
|
2535
2535
|
* @brief Enable cellular network assisted communication to improve call quality.
|
|
2536
|
-
* @param config See
|
|
2536
|
+
* @param config See {@link MediaTypeEnhancementConfig MediaTypeEnhancementConfig}.
|
|
2537
2537
|
* @return Method call result: <br>
|
|
2538
2538
|
* - 0: Success.
|
|
2539
2539
|
* - -1: Failure, internal error.
|
|
@@ -2549,23 +2549,23 @@ export declare class RTCVideo {
|
|
|
2549
2549
|
* @region Video Facility Management
|
|
2550
2550
|
* @author likai.666
|
|
2551
2551
|
* @brief Create a video Facility Management instance
|
|
2552
|
-
* @return Video Facility Management instance. See
|
|
2552
|
+
* @return Video Facility Management instance. See {@link IVideoDeviceManager IVideoDeviceManager}
|
|
2553
2553
|
*
|
|
2554
2554
|
*/
|
|
2555
2555
|
android_getVideoDeviceManager(): $p_a.IVideoDeviceManager;
|
|
2556
2556
|
/** {en}
|
|
2557
2557
|
* @detail api
|
|
2558
2558
|
* @brief Set the rotation of the video images captured from the local device. <br>
|
|
2559
|
-
* Call this API to rotate the videos when the camera is fixed upside down or tilted. For rotating videos on a phone, we recommend to use
|
|
2560
|
-
* @param rotation It defaults to `VIDEO_ROTATION_0(0)`, which means not to rotate. Refer to
|
|
2559
|
+
* Call this API to rotate the videos when the camera is fixed upside down or tilted. For rotating videos on a phone, we recommend to use {@link setVideoRotationMode setVideoRotationMode}.
|
|
2560
|
+
* @param rotation It defaults to `VIDEO_ROTATION_0(0)`, which means not to rotate. Refer to {@link VideoRotation VideoRotation}.
|
|
2561
2561
|
* @return
|
|
2562
2562
|
* - 0: Success.
|
|
2563
|
-
* - < 0 : Fail. See
|
|
2563
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2564
2564
|
* @note
|
|
2565
|
-
* - For the videos captured by the internal module, the rotation will be combined with that set by calling
|
|
2565
|
+
* - For the videos captured by the internal module, the rotation will be combined with that set by calling {@link setVideoRotationMode setVideoRotationMode}.
|
|
2566
2566
|
* - This API affects the external-sourced videos. The final rotation would be the original rotation angles adding up with the rotation set by calling this API.
|
|
2567
|
-
* - The elements added during the video pre-processing stage, such as video sticker and background applied using
|
|
2568
|
-
* - The rotation would be applied to both locally rendered video s and those sent out. However, if you need to rotate a video which is intended for pushing to CDN individually, use
|
|
2567
|
+
* - The elements added during the video pre-processing stage, such as video sticker and background applied using {@link enableVirtualBackground:withSource: enableVirtualBackground} will also be rotated by this API.
|
|
2568
|
+
* - The rotation would be applied to both locally rendered video s and those sent out. However, if you need to rotate a video which is intended for pushing to CDN individually, use {@link setVideoOrientation setVideoOrientation}.
|
|
2569
2569
|
*
|
|
2570
2570
|
*/
|
|
2571
2571
|
setVideoCaptureRotation(rotation: VideoRotation): number;
|
|
@@ -2576,11 +2576,11 @@ export declare class RTCVideo {
|
|
|
2576
2576
|
* @region Audio Management
|
|
2577
2577
|
* @author dixing
|
|
2578
2578
|
* @brief On iOS, you can change the Bluetooth profile when the media volume is set in all scenarios.
|
|
2579
|
-
* @param mode The Bluetooth profiles. See
|
|
2579
|
+
* @param mode The Bluetooth profiles. See {@link ByteRTCBluetoothMode ByteRTCBluetoothMode}.
|
|
2580
2580
|
* @return
|
|
2581
2581
|
* - 0: Success.
|
|
2582
|
-
* - < 0 : Fail. See
|
|
2583
|
-
* @note You will receive rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning
|
|
2582
|
+
* - < 0 : Fail. See {@link ByteRTCReturnStatus ByteRTCReturnStatus} for more details
|
|
2583
|
+
* @note You will receive {@link rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning rtcEngine:onAudioDeviceWarning:deviceType:deviceWarning:} in the following scenarios: 1) You cannot change the Bluetooth profile to HFP.;2) The media volume is not set in all scenarios. We suggest that you call {@link ByteRTCVideosetaudioscenario setAudioScenario:} to set the media volume scenario before calling this API.
|
|
2584
2584
|
*/
|
|
2585
2585
|
ios_setBluetoothMode(mode: $p_i.ByteRTCBluetoothMode): number;
|
|
2586
2586
|
/** {en}
|
|
@@ -2589,16 +2589,16 @@ export declare class RTCVideo {
|
|
|
2589
2589
|
* @region Video Management
|
|
2590
2590
|
* @author zhaomingliang
|
|
2591
2591
|
* @brief Video publisher call this API to set the parameters of the maximum resolution video stream that is expected to be published, including resolution, frame rate, bitrate, and fallback strategy in poor network conditions. <br>
|
|
2592
|
-
* You can only set configuration for one stream with this API. If you want to set configuration for multiple streams, Call
|
|
2593
|
-
* @param encoderConfig The maximum video encoding parameter. See
|
|
2592
|
+
* You can only set configuration for one stream with this API. If you want to set configuration for multiple streams, Call {@link setVideoEncoderConfig setVideoEncoderConfig:}.
|
|
2593
|
+
* @param encoderConfig The maximum video encoding parameter. See {@link ByteRTCVideoEncoderConfig ByteRTCVideoEncoderConfig}.
|
|
2594
2594
|
* @return API call result: <br>
|
|
2595
2595
|
* - 0: Success
|
|
2596
2596
|
* - ! 0: Failure
|
|
2597
2597
|
* @note
|
|
2598
|
-
* - You can use
|
|
2598
|
+
* - You can use {@link enableSimulcastMode enableSimulcastMode:} simultaneously to publish streams with different resolutions. Specifically, if you want to publish multiple streams with different resolutions, you need to call this method and enable the simulcast mode with {@link enableSimulcastMode enableSimulcastMode:} before publishing your streams. The SDK will intelligently adjust the number of streams to be published (up to 4) and their parameters based on the settings of the subscribing end. The resolution set by calling this method will be the maximum resolution among the streams. For specific rules, please refer to [Simulcasting](https://docs.byteplus.com/en/byteplus-rtc/docs/70139).
|
|
2599
2599
|
* - Without calling this API, SDK will only publish one stream for you with a resolution of 640px × 360px and a frame rate of 15fps.
|
|
2600
2600
|
* - In custom capturing, you must call this API to set the encoding parameters to ensure the integrity of the picture received by remote users.
|
|
2601
|
-
* - This API is applicable to the video stream captured by the camera, see
|
|
2601
|
+
* - This API is applicable to the video stream captured by the camera, see {@link setScreenVideoEncoderConfig setScreenVideoEncoderConfig:} for setting parameters for screen sharing video stream.
|
|
2602
2602
|
*/
|
|
2603
2603
|
ios_setMaxVideoEncoderConfig(encoderConfig: $p_i.ByteRTCVideoEncoderConfig): number;
|
|
2604
2604
|
/** {en}
|
|
@@ -2607,13 +2607,13 @@ export declare class RTCVideo {
|
|
|
2607
2607
|
* @region encryption
|
|
2608
2608
|
* @author wangjunlin.3182
|
|
2609
2609
|
* @brief Sets custom encryption and decryption methods.
|
|
2610
|
-
* @param handler Custom encryption handler, which needs to implement the encryption and decryption method. See
|
|
2610
|
+
* @param handler Custom encryption handler, which needs to implement the encryption and decryption method. See {@link ByteRTCEncryptHandler ByteRTCEncryptHandler}.
|
|
2611
2611
|
* @return
|
|
2612
2612
|
* - 0: Success.
|
|
2613
|
-
* - < 0 : Fail. See
|
|
2613
|
+
* - < 0 : Fail. See {@link ByteRTCReturnStatus ByteRTCReturnStatus} for more details
|
|
2614
2614
|
* @note
|
|
2615
|
-
* - The method and
|
|
2616
|
-
* - This method must be called before calling joinRoom:userInfo:roomConfig
|
|
2615
|
+
* - The method and {@link setEncryptInfo:key setEncryptInfo:key:} are mutually exclusive relationships, that is, according to the call order, the last call method takes effect version.
|
|
2616
|
+
* - This method must be called before calling {@link joinRoom:userInfo:roomConfig joinRoom:userInfo:roomConfig:}, which can be called repeatedly, taking the last called parameter as the effective parameter.
|
|
2617
2617
|
* - Whether encrypted or decrypted, the length of the modified data needs to be controlled under 180\%. That is, if the input data is 100 bytes, the processed data must be less than 180 bytes. If the encryption or decryption result exceeds the limit, the audio & video frame may be discarded.
|
|
2618
2618
|
* - Data encryption/decryption is performed serially, so depending on the implementation The method may affect the final rendering efficiency. Whether to use this method needs to be carefully evaluated by the user.
|
|
2619
2619
|
*/
|
|
@@ -2628,8 +2628,8 @@ export declare class RTCVideo {
|
|
|
2628
2628
|
* @param groupId Your app and Extension should belong to the same App Group. You need to put in their Group ID here.
|
|
2629
2629
|
* @return
|
|
2630
2630
|
* - 0: Success.
|
|
2631
|
-
* - < 0 : Fail. See
|
|
2632
|
-
* @note You must call this API immediately after calling createRTCVideo:delegate:parameters
|
|
2631
|
+
* - < 0 : Fail. See {@link ByteRTCReturnStatus ByteRTCReturnStatus} for more details
|
|
2632
|
+
* @note You must call this API immediately after calling {@link createRTCVideo:delegate:parameters createRTCVideo:delegate:parameters:}. You only need to call this API once in the life cycle of the engine instance.
|
|
2633
2633
|
*/
|
|
2634
2634
|
ios_setExtensionConfig(groupId: string): number;
|
|
2635
2635
|
/** {en}
|
|
@@ -2642,10 +2642,10 @@ export declare class RTCVideo {
|
|
|
2642
2642
|
* @param messsage Message sent to the Extension
|
|
2643
2643
|
* @return
|
|
2644
2644
|
* - 0: Success.
|
|
2645
|
-
* - < 0 : Fail. See
|
|
2645
|
+
* - < 0 : Fail. See {@link ByteRTCReturnStatus ByteRTCReturnStatus} for more details
|
|
2646
2646
|
* @note
|
|
2647
|
-
* - Call this API after calling
|
|
2648
|
-
* - The extension will receive
|
|
2647
|
+
* - Call this API after calling {@link startScreenCapture:bundleId startScreenCapture:bundleId:}.
|
|
2648
|
+
* - The extension will receive {@link onReceiveMessageFromApp onReceiveMessageFromApp:} when the message is sent.
|
|
2649
2649
|
*/
|
|
2650
2650
|
ios_sendScreenCaptureExtensionMessage(messsage: $p_i.NSData): number;
|
|
2651
2651
|
}
|
|
@@ -2663,11 +2663,11 @@ export declare class RTCRoom {
|
|
|
2663
2663
|
* @detail api
|
|
2664
2664
|
* @region multi-room
|
|
2665
2665
|
* @author shenpengliang
|
|
2666
|
-
* @brief Listens for event callbacks related to the
|
|
2667
|
-
* @param rtcRoomEventHandler Refer to
|
|
2666
|
+
* @brief Listens for event callbacks related to the {@link RTCRoom RTCRoom} instance by setting the event handler of this instance.
|
|
2667
|
+
* @param rtcRoomEventHandler Refer to {@link IRTCRoomEventHandler IRTCRoomEventHandler}.
|
|
2668
2668
|
* @return
|
|
2669
2669
|
* - 0: Success.
|
|
2670
|
-
* - < 0 : Fail. See
|
|
2670
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2671
2671
|
*
|
|
2672
2672
|
*/
|
|
2673
2673
|
setRTCRoomEventHandler(rtcRoomEventHandler: RTCRoomEventHandler): number;
|
|
@@ -2676,16 +2676,16 @@ export declare class RTCRoom {
|
|
|
2676
2676
|
* @region Room Management
|
|
2677
2677
|
* @author yejing.luna
|
|
2678
2678
|
* @brief Subscribes to all remote media streams captured by camera/microphone. Or update the subscribe options of all subscribed user.
|
|
2679
|
-
* @param type Media stream type, used for specifying whether to subscribe to the audio stream or the video stream. See
|
|
2679
|
+
* @param type Media stream type, used for specifying whether to subscribe to the audio stream or the video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2680
2680
|
* @return API call result: <br>
|
|
2681
2681
|
* - 0: Success
|
|
2682
2682
|
* - !0: Failure
|
|
2683
2683
|
* @note
|
|
2684
2684
|
* - If the subscription options conflict with the previous ones, they are subject to the configurations in the last call.
|
|
2685
|
-
* - With the Audio selection enabled, if the number of media streams exceeds the limit, we recommend you call
|
|
2686
|
-
* - After calling this API, you will be informed of the calling result with
|
|
2687
|
-
* - Once the local user subscribes to the stream of a remote user, the subscription to the remote user will sustain until the local user leaves the room or unsubscribe from it by calling
|
|
2688
|
-
* - Any other exceptions will be included in
|
|
2685
|
+
* - With the Audio selection enabled, if the number of media streams exceeds the limit, we recommend you call {@link subscribeStream subscribeStream} to subscribe each target media stream other than calling this API.
|
|
2686
|
+
* - After calling this API, you will be informed of the calling result with {@link onStreamSubscribed onStreamSubscribed}.
|
|
2687
|
+
* - Once the local user subscribes to the stream of a remote user, the subscription to the remote user will sustain until the local user leaves the room or unsubscribe from it by calling {@link unsubscribeStream unsubscribeStream}.
|
|
2688
|
+
* - Any other exceptions will be included in {@link onStreamStateChanged onStreamStateChanged}, see {@link ErrorCode ErrorCode} for the reasons.
|
|
2689
2689
|
*
|
|
2690
2690
|
*/
|
|
2691
2691
|
subscribeAllStreams(type: MediaStreamType): number;
|
|
@@ -2695,13 +2695,13 @@ export declare class RTCRoom {
|
|
|
2695
2695
|
* @author yejing.luna
|
|
2696
2696
|
* @brief Unsubscribes from all remote media streams captured by camera/microphone. <br>
|
|
2697
2697
|
* You can call this API to unsubscribe from streams that are subscribed to either automatically or manually.
|
|
2698
|
-
* @param type Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream. See
|
|
2698
|
+
* @param type Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2699
2699
|
* @return API call result: <br>
|
|
2700
2700
|
* - 0: Success
|
|
2701
2701
|
* - !0: Failure
|
|
2702
2702
|
* @note
|
|
2703
|
-
* - After calling this API, you will be informed of the calling result with
|
|
2704
|
-
* - Any other exceptions will be included in
|
|
2703
|
+
* - After calling this API, you will be informed of the calling result with {@link onStreamSubscribed onStreamSubscribed}.
|
|
2704
|
+
* - Any other exceptions will be included in {@link onStreamStateChanged onStreamStateChanged}, see {@link ErrorCode ErrorCode} for the reasons.
|
|
2705
2705
|
*
|
|
2706
2706
|
*/
|
|
2707
2707
|
unsubscribeAllStreams(type: MediaStreamType): number;
|
|
@@ -2709,7 +2709,7 @@ export declare class RTCRoom {
|
|
|
2709
2709
|
* @detail api
|
|
2710
2710
|
* @region multiple rooms
|
|
2711
2711
|
* @author shenpengliang
|
|
2712
|
-
* @brief Leave and destroy the room instance created by calling
|
|
2712
|
+
* @brief Leave and destroy the room instance created by calling {@link createRTCRoom createRTCRoom}.
|
|
2713
2713
|
*
|
|
2714
2714
|
*/
|
|
2715
2715
|
destroy(): void;
|
|
@@ -2718,23 +2718,23 @@ export declare class RTCRoom {
|
|
|
2718
2718
|
* @region Multiple rooms
|
|
2719
2719
|
* @author shenpengliang
|
|
2720
2720
|
* @brief Join the room. <br>
|
|
2721
|
-
* After creating a room by calling
|
|
2721
|
+
* After creating a room by calling {@link createRTCRoom createRTCRoom}, call this API to join the room and make audio & video calls with other users in the room.
|
|
2722
2722
|
* @param token Dynamic key. It is used for authentication and verification of users entering the room. <br>
|
|
2723
2723
|
* You need to bring Token to enter the room. When testing, you can use the console to generate temporary tokens. The official launch requires the use of the key SDK to generate and issue tokens at your server level. See [Use Token to complete authentication](#70121) for token validity and generation method. <br>
|
|
2724
2724
|
* Apps with different AppIDs are not interoperable. <br>
|
|
2725
2725
|
* Make sure that the AppID used to generate the Token is the same as the AppID used to create the engine, otherwise it will cause the join room to fail.
|
|
2726
|
-
* @param userInfo User information. See
|
|
2727
|
-
* @param roomConfig Room parameter configuration, set the room mode and whether to automatically publish or subscribe to the flow. See
|
|
2726
|
+
* @param userInfo User information. See {@link UserInfo UserInfo}.
|
|
2727
|
+
* @param roomConfig Room parameter configuration, set the room mode and whether to automatically publish or subscribe to the flow. See {@link RTCRoomConfig RTCRoomConfig} for the specific configuration mode.
|
|
2728
2728
|
* @return
|
|
2729
2729
|
* - 0: Success.
|
|
2730
2730
|
* - -1: RoomID/userI nfo.uid contains invalid parameters.
|
|
2731
|
-
* - -2: Already in the room. After the interface call is successful, as long as the return value of 0 is received and
|
|
2732
|
-
* The reason for the failure will be communicated via the
|
|
2731
|
+
* - -2: Already in the room. After the interface call is successful, as long as the return value of 0 is received and {@link leaveRoom leaveRoom} is not called successfully, this return value is triggered when the room entry interface is called again, regardless of whether the filled room ID and user ID are duplicated.
|
|
2732
|
+
* The reason for the failure will be communicated via the {@link onRoomStateChanged onRoomStateChanged} callback.
|
|
2733
2733
|
* @note
|
|
2734
|
-
* - In the same room with the same App ID, the user ID of each user must be unique. If two users have the same user ID, the user who entered the room later will kick the user who entered the room out of the room, and the user who entered the room will receive the
|
|
2735
|
-
* - Local users will receive
|
|
2736
|
-
* - By default, the user is visible in an RTC room. Joining fails when the number of users in an RTC room reaches the upper limit. To avoid this, call
|
|
2737
|
-
* - After the user successfully joins the room, the SDK may lose connection to the server in case of poor local network conditions. At this point,
|
|
2734
|
+
* - In the same room with the same App ID, the user ID of each user must be unique. If two users have the same user ID, the user who entered the room later will kick the user who entered the room out of the room, and the user who entered the room will receive the {@link onRoomStateChanged onRoomStateChanged} callback notification. For the error type. See kErrorCodeDuplicateLogin in {@link ERROR_CODE_DUPLICATE_LOGIN ERROR_CODE_DUPLICATE_LOGIN}.
|
|
2735
|
+
* - Local users will receive {@link onRoomStateChanged onRoomStateChanged} callback notification after calling this method to join the room successfully. If the local user is also a visible user, the remote user will receive an {@link onUserJoined onUserJoined} callback notification when joining the room.
|
|
2736
|
+
* - By default, the user is visible in an RTC room. Joining fails when the number of users in an RTC room reaches the upper limit. To avoid this, call {@link setUserVisibility setUserVisibility} to change the visibility of the audience users to `false` by considering the capacity for the invisible users is much larger than that for visible users. An RTC room can accommodate a maximum of 50 visible users, and 30 media streams can be published simultaneously. For more information, see [Capability of Users and Streams](https://docs.byteplus.com/en/byteplus-rtc/docs/257549).
|
|
2737
|
+
* - After the user successfully joins the room, the SDK may lose connection to the server in case of poor local network conditions. At this point, {@link onConnectionStateChanged onConnectionStateChanged} callback will be triggered and the SDK will automatically retry until it successfully reconnects to the server. After successful reconnection, {@link onRoomStateChanged onRoomStateChanged} callback notification will be received locally.
|
|
2738
2738
|
*
|
|
2739
2739
|
*/
|
|
2740
2740
|
joinRoom(token: string, userInfo: UserInfo, roomConfig: RTCRoomConfig): number;
|
|
@@ -2744,13 +2744,13 @@ export declare class RTCRoom {
|
|
|
2744
2744
|
* @author shenpengliang
|
|
2745
2745
|
* @brief Leave the room. <br>
|
|
2746
2746
|
* The user calls this method to leave the room, end the call process, and release all call-related resources. <br>
|
|
2747
|
-
* This method is an asynchronous operation, and the call returns without actually exiting the room. After you actually exit the room, you will receive a callback notification from
|
|
2747
|
+
* This method is an asynchronous operation, and the call returns without actually exiting the room. After you actually exit the room, you will receive a callback notification from {@link onLeaveRoom onLeaveRoom} locally.
|
|
2748
2748
|
* @return
|
|
2749
2749
|
* - 0: Success.
|
|
2750
|
-
* - < 0 : Fail. See
|
|
2750
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2751
2751
|
* @note
|
|
2752
|
-
* - After a user who calls
|
|
2753
|
-
* - If the engine is destroyed immediately after this method is called, the SDK will not be able to trigger the
|
|
2752
|
+
* - After a user who calls {@link setUserVisibility setUserVisibility} to make himself visible leaves the room, other users in the room will receive a callback notification from {@link onUserLeave onUserLeave}.
|
|
2753
|
+
* - If the engine is destroyed immediately after this method is called, the SDK will not be able to trigger the {@link onLeaveRoom onLeaveRoom} callback.
|
|
2754
2754
|
*
|
|
2755
2755
|
*/
|
|
2756
2756
|
leaveRoom(): number;
|
|
@@ -2765,16 +2765,16 @@ export declare class RTCRoom {
|
|
|
2765
2765
|
* - false: The user cannot publish media streams. The other users in the room do not get informed of the behaviors of the user, such as joining room, starting video capture, or leaving room.
|
|
2766
2766
|
* @return
|
|
2767
2767
|
* - 0: Success.
|
|
2768
|
-
* - < 0 : Failure. See
|
|
2768
|
+
* - < 0 : Failure. See {@link ReturnStatus ReturnStatus}.
|
|
2769
2769
|
* @note
|
|
2770
2770
|
* - You can call this API whether the user is in a room or not.
|
|
2771
|
-
* - You will receive
|
|
2771
|
+
* - You will receive {@link onUserVisibilityChanged onUserVisibilityChanged} after calling this API. (Available since v3.54)
|
|
2772
2772
|
*   • If you call this API before joining room, and the set value is different from the default value, you will receive the callback when you join the room. <br>
|
|
2773
2773
|
*   • If you call this API after joining room, and the current visibility is different from the previous value, you will receive the callback. <br>
|
|
2774
2774
|
*   • When reconnecting after losing internet connection, if the visibility changes, you will receive the callback. <br>
|
|
2775
2775
|
* - When you call this API while you are in the room, the other users in the room will be informed via the following callback.
|
|
2776
|
-
*   • When you switch from `false` to `true`, they will receive
|
|
2777
|
-
*   • When you switch from `true` to `false`, they will receive
|
|
2776
|
+
*   • When you switch from `false` to `true`, they will receive {@link onUserJoined onUserJoined}. <br>
|
|
2777
|
+
*   • When you switch from `true` to `false`, they will receive {@link onUserLeave onUserLeave}. <br>
|
|
2778
2778
|
*   • The invisible user will receive the warning code, `WARNING_CODE_PUBLISH_STREAM_FORBIDEN`, when trying to publish media streams.
|
|
2779
2779
|
*
|
|
2780
2780
|
*/
|
|
@@ -2783,15 +2783,15 @@ export declare class RTCRoom {
|
|
|
2783
2783
|
* @detail api
|
|
2784
2784
|
* @author shenpengliang
|
|
2785
2785
|
* @brief Update Token. <br>
|
|
2786
|
-
* You must call this API to update token to ensure the RTC call to continue when you receive
|
|
2786
|
+
* You must call this API to update token to ensure the RTC call to continue when you receive {@link onTokenWillExpire onTokenWillExpire}, {@link onPublishPrivilegeTokenWillExpire onPublishPrivilegeTokenWillExpire}, or {@link onSubscribePrivilegeTokenWillExpire onSubscribePrivilegeTokenWillExpire}.
|
|
2787
2787
|
* @param token Valid token. <br>
|
|
2788
|
-
* If the Token is invalid, you will receive
|
|
2788
|
+
* If the Token is invalid, you will receive {@link onRoomStateChanged onRoomStateChanged} with the error code of `-1010`.
|
|
2789
2789
|
* @return API call result: <br>
|
|
2790
2790
|
* - 0: Success.
|
|
2791
|
-
* - <0: Failure. See
|
|
2791
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
2792
2792
|
* @note
|
|
2793
2793
|
* - In versions before 3.50, the publish and subscribe privileges contained in the Token are reserved parameters with no actual control permissions. In version 3.50 and later, the publish/subscribe privileges will be effective for whitelisted users. Please contact the technical support team to include you in the whitelist if you need this function.
|
|
2794
|
-
* - Do not call both
|
|
2794
|
+
* - Do not call both {@link updateToken updateToken} and {@link joinRoom joinRoom} to update the Token. If you fail to join the room or have been removed from the room due to an expired or invalid Token, call {@link joinRoom joinRoom} with a valid token to rejoin the room.
|
|
2795
2795
|
*
|
|
2796
2796
|
*/
|
|
2797
2797
|
updateToken(token: string): number;
|
|
@@ -2802,15 +2802,15 @@ export declare class RTCRoom {
|
|
|
2802
2802
|
* @brief Send a point-to-point text message to the specified user in the room
|
|
2803
2803
|
* @param userId User ID of the message receiver
|
|
2804
2804
|
* @param messageStr Text message content sent. Message does not exceed 64 KB.
|
|
2805
|
-
* @param config See
|
|
2805
|
+
* @param config See {@link MessageConfig MessageConfig}.
|
|
2806
2806
|
* @return
|
|
2807
2807
|
* - > 0: Sent successfully, return the number of the sent message, increment from 1
|
|
2808
2808
|
* - -1: Sent failed, RTCRoom instance not created
|
|
2809
2809
|
* - -2: Sent failed, uid is empty
|
|
2810
2810
|
* @note
|
|
2811
|
-
* - Before sending an in-room text message, you must call
|
|
2812
|
-
* - After the call, you will receive an
|
|
2813
|
-
* - If the message was sent successfully, the user specified by the userId will receive an
|
|
2811
|
+
* - Before sending an in-room text message, you must call {@link joinRoom joinRoom} to join the room.
|
|
2812
|
+
* - After the call, you will receive an {@link onUserMessageSendResult onUserMessageSendResult} callback to notify that the message was sent successfully or failed;
|
|
2813
|
+
* - If the message was sent successfully, the user specified by the userId will receive an {@link onUserMessageReceived onUserMessageReceived} callback.
|
|
2814
2814
|
*
|
|
2815
2815
|
*/
|
|
2816
2816
|
sendUserMessage(userId: string, messageStr: string, config: MessageConfig): number;
|
|
@@ -2821,11 +2821,11 @@ export declare class RTCRoom {
|
|
|
2821
2821
|
* @brief Sends a point-to-point binary message to the specified user in the room.
|
|
2822
2822
|
* @param userId Message Receives user ID
|
|
2823
2823
|
* @param buffer Binary message content sent. Message does not exceed 46KB.
|
|
2824
|
-
* @param config See
|
|
2824
|
+
* @param config See {@link MessageConfig MessageConfig}
|
|
2825
2825
|
* @note
|
|
2826
|
-
* - Before sending in-room binary messages, you must call
|
|
2827
|
-
* - After the call, you will receive an
|
|
2828
|
-
* - If the message was sent successfully, the user specified by the userId will receive an
|
|
2826
|
+
* - Before sending in-room binary messages, you must call {@link joinRoom joinRoom} to join the room.
|
|
2827
|
+
* - After the call, you will receive an {@link onUserMessageSendResult onUserMessageSendResult} callback to notify that the message was sent successfully or failed;
|
|
2828
|
+
* - If the message was sent successfully, the user specified by the userId will receive an {@link onUserBinaryMessageReceived onUserBinaryMessageReceived} callback.
|
|
2829
2829
|
*
|
|
2830
2830
|
*/
|
|
2831
2831
|
sendUserBinaryMessage(userId: string, buffer: ArrayBuffer, config: MessageConfig): number;
|
|
@@ -2836,9 +2836,9 @@ export declare class RTCRoom {
|
|
|
2836
2836
|
* @brief Mass text messages to all other users in the room.
|
|
2837
2837
|
* @param messageStr The content of the text message sent. The message does not exceed 64 KB.
|
|
2838
2838
|
* @note
|
|
2839
|
-
* - Before broadcasting a text message in the room, you must call
|
|
2840
|
-
* - After the call, you will receive the
|
|
2841
|
-
* - Other users in the same room will receive the
|
|
2839
|
+
* - Before broadcasting a text message in the room, you must call {@link joinRoom joinRoom} to join the room.
|
|
2840
|
+
* - After the call, you will receive the {@link onRoomMessageSendResult onRoomMessageSendResult} callback;
|
|
2841
|
+
* - Other users in the same room will receive the {@link onRoomMessageReceived onRoomMessageReceived} callback.
|
|
2842
2842
|
*
|
|
2843
2843
|
*/
|
|
2844
2844
|
sendRoomMessage(messageStr: string): number;
|
|
@@ -2849,9 +2849,9 @@ export declare class RTCRoom {
|
|
|
2849
2849
|
* @brief Group binary messages to all other users in the room.
|
|
2850
2850
|
* @param buffer The content of the binary message sent. The message does not exceed 46KB.
|
|
2851
2851
|
* @note
|
|
2852
|
-
* - Before broadcasting binary messages in the room, you must call
|
|
2853
|
-
* - After the call, you will receive the
|
|
2854
|
-
* - Other users in the same room will receive the
|
|
2852
|
+
* - Before broadcasting binary messages in the room, you must call {@link joinRoom joinRoom} to join the room.
|
|
2853
|
+
* - After the call, you will receive the {@link onRoomMessageSendResult onRoomMessageSendResult} callback;
|
|
2854
|
+
* - Other users in the same room will receive the {@link onRoomBinaryMessageReceived onRoomBinaryMessageReceived} callback.
|
|
2855
2855
|
*
|
|
2856
2856
|
*/
|
|
2857
2857
|
sendRoomBinaryMessage(buffer: ArrayBuffer): number;
|
|
@@ -2864,11 +2864,11 @@ export declare class RTCRoom {
|
|
|
2864
2864
|
* @param audioUserId The ID of audio publisher. You can stop the current A/V synchronization by setting this parameter to null.
|
|
2865
2865
|
* @return
|
|
2866
2866
|
* - 0: Success.
|
|
2867
|
-
* - < 0 : Fail. See
|
|
2867
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2868
2868
|
* @note
|
|
2869
2869
|
* - You can call this API anytime before or after entering the room.
|
|
2870
2870
|
* - The source user IDs of the audio and video stream to be synchronized must be in the same RTC room.
|
|
2871
|
-
* - When the A/V synchronization state changes, you will receive
|
|
2871
|
+
* - When the A/V synchronization state changes, you will receive {@link onAVSyncStateChange onAVSyncStateChange}.
|
|
2872
2872
|
* - More than one pair of audio and video can be synchronized simultaneously in the same RTC room, but you should note that one single audio source cannot be synchronized with multiple video sources at the same time.
|
|
2873
2873
|
* - If you want to change the audio source, call this API again with a new `audioUserId`. If you want to change the video source, you need to stop the current synchronization first, then call this API on the new video publisher side.
|
|
2874
2874
|
*
|
|
@@ -2880,14 +2880,14 @@ export declare class RTCRoom {
|
|
|
2880
2880
|
* @author zhaomingliang
|
|
2881
2881
|
* @brief Sets your expected configuration of the remote video stream that you want to subscribe to or have subscribed to.
|
|
2882
2882
|
* @param userId ID of the remote video stream publisher you expect to configure subscription parameters for.
|
|
2883
|
-
* @param remoteVideoConfig The parameters you expect to configure for the remote video stream, see
|
|
2883
|
+
* @param remoteVideoConfig The parameters you expect to configure for the remote video stream, see {@link RemoteVideoConfig RemoteVideoConfig}.
|
|
2884
2884
|
* @return API call result: <br>
|
|
2885
2885
|
* - 0: Success.
|
|
2886
|
-
* - <0: Failure. See
|
|
2886
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
2887
2887
|
* @note
|
|
2888
|
-
* - This API only works after the publisher calls
|
|
2888
|
+
* - This API only works after the publisher calls {@link enableSimulcastMode enableSimulcastMode} to enable publishing multiple video streams, in which case the subscriber will receive the stream from the publisher that is closest to the set configuration; otherwise the subscriber will only receive one video stream with a resolution of 640px × 360px and a frame rate of 15fps.
|
|
2889
2889
|
* - If you don't call this API after the publisher enables the function of publishing multiple streams, you will receive by default the video stream with the largest resolution set by the publisher.
|
|
2890
|
-
* - You should call this API in the room. If you want to call it before entering the room, you should set the `remoteVideoConfig` in the roomConfig` when calling
|
|
2890
|
+
* - You should call this API in the room. If you want to call it before entering the room, you should set the `remoteVideoConfig` in the roomConfig` when calling {@link joinRoom joinRoom}.
|
|
2891
2891
|
* - SDK will automatically select the stream to be published or subcribed based on the settings of both sides see for details.
|
|
2892
2892
|
*
|
|
2893
2893
|
*/
|
|
@@ -2897,17 +2897,17 @@ export declare class RTCRoom {
|
|
|
2897
2897
|
* @region Room Management
|
|
2898
2898
|
* @author shenpengliang
|
|
2899
2899
|
* @brief Publishes media streams captured by camera/microphone in the current room.
|
|
2900
|
-
* @param type Media stream type, used for specifying whether to publish audio stream or video stream. See
|
|
2900
|
+
* @param type Media stream type, used for specifying whether to publish audio stream or video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2901
2901
|
* @return
|
|
2902
2902
|
* - 0: Success.
|
|
2903
|
-
* - < 0 : Fail. See
|
|
2903
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2904
2904
|
* @note
|
|
2905
|
-
* - You don't need to call this API if you set it to Auto-publish when calling
|
|
2906
|
-
* - An invisible user cannot publish media streams. Call
|
|
2907
|
-
* - Call
|
|
2908
|
-
* - Call
|
|
2909
|
-
* - After you call this API, the other users in the room will receive
|
|
2910
|
-
* - Call
|
|
2905
|
+
* - You don't need to call this API if you set it to Auto-publish when calling {@link joinRoom joinRoom}.
|
|
2906
|
+
* - An invisible user cannot publish media streams. Call {@link setUserVisibility setUserVisibility} to change your visibility in the room.
|
|
2907
|
+
* - Call {@link publishScreen publishScreen} to start screen sharing.
|
|
2908
|
+
* - Call {@link startForwardStreamToRooms startForwardStreamToRooms} to forward the published streams to the other rooms.
|
|
2909
|
+
* - After you call this API, the other users in the room will receive {@link onUserPublishStream onUserPublishStream}. Those who successfully received your streams will receive {@link onFirstRemoteAudioFrame onFirstRemoteAudioFrame}{@link onFirstRemoteVideoFrameDecoded /onFirstRemoteVideoFrameDecoded} at the same time.
|
|
2910
|
+
* - Call {@link unpublishStream unpublishStream} to stop publishing streams.
|
|
2911
2911
|
*
|
|
2912
2912
|
*/
|
|
2913
2913
|
publishStream(type: MediaStreamType): number;
|
|
@@ -2916,13 +2916,13 @@ export declare class RTCRoom {
|
|
|
2916
2916
|
* @region Room Management
|
|
2917
2917
|
* @author shenpengliang
|
|
2918
2918
|
* @brief Stops publishing media streams captured by camera/microphone in the current room.
|
|
2919
|
-
* @param type Media stream type, used for specifying whether to stop publishing audio stream or video stream. See
|
|
2919
|
+
* @param type Media stream type, used for specifying whether to stop publishing audio stream or video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2920
2920
|
* @return
|
|
2921
2921
|
* - 0: Success.
|
|
2922
|
-
* - < 0 : Fail. See
|
|
2922
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2923
2923
|
* @note
|
|
2924
|
-
* - After calling
|
|
2925
|
-
* - After calling this API, the other users in the room will receive
|
|
2924
|
+
* - After calling {@link publishStream publishStream}, call this API to stop publishing streams.
|
|
2925
|
+
* - After calling this API, the other users in the room will receive {@link onUserUnpublishStream onUserUnpublishStream}
|
|
2926
2926
|
*
|
|
2927
2927
|
*/
|
|
2928
2928
|
unpublishStream(type: MediaStreamType): number;
|
|
@@ -2931,17 +2931,17 @@ export declare class RTCRoom {
|
|
|
2931
2931
|
* @region Screen Sharing
|
|
2932
2932
|
* @author liyi.000
|
|
2933
2933
|
* @brief Publishes local screen sharing streams in the current room.
|
|
2934
|
-
* @param type Media stream type, used for specifying whether to publish audio stream or video stream. See
|
|
2934
|
+
* @param type Media stream type, used for specifying whether to publish audio stream or video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2935
2935
|
* @return
|
|
2936
2936
|
* - 0: Success.
|
|
2937
|
-
* - < 0 : Fail. See
|
|
2937
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2938
2938
|
* @note
|
|
2939
|
-
* - You need to call this API to publish screen even if you set it to Auto-publish when calling
|
|
2940
|
-
* - An invisible user cannot publish media streams. Call
|
|
2941
|
-
* - After you called this API, the other users in the room will receive
|
|
2942
|
-
* - After calling this API, you'll receive
|
|
2943
|
-
* - Call
|
|
2944
|
-
* - Call
|
|
2939
|
+
* - You need to call this API to publish screen even if you set it to Auto-publish when calling {@link joinRoom joinRoom}.
|
|
2940
|
+
* - An invisible user cannot publish media streams. Call {@link setUserVisibility setUserVisibility} to change your visibility in the room.
|
|
2941
|
+
* - After you called this API, the other users in the room will receive {@link onUserPublishScreen onUserPublishScreen}. Those who successfully received your streams will receive {@link onFirstRemoteAudioFrame onFirstRemoteAudioFrame}{@link onFirstRemoteVideoFrameDecoded /onFirstRemoteVideoFrameDecoded} at the same time.
|
|
2942
|
+
* - After calling this API, you'll receive {@link onScreenVideoFrameSendStateChanged onScreenVideoFrameSendStateChanged}.
|
|
2943
|
+
* - Call {@link startForwardStreamToRooms startForwardStreamToRooms} to forward the published streams to the other rooms.
|
|
2944
|
+
* - Call {@link unpublishScreen unpublishScreen} to stop publishing screen-sharing streams.
|
|
2945
2945
|
* - Refer to [Sharing Screen in Android](https://docs.byteplus.com/byteplus-rtc/docs/124176) for more information.
|
|
2946
2946
|
*
|
|
2947
2947
|
*/
|
|
@@ -2951,13 +2951,13 @@ export declare class RTCRoom {
|
|
|
2951
2951
|
* @region Screen Sharing
|
|
2952
2952
|
* @author liyi.000
|
|
2953
2953
|
* @brief Stops publishing local screen sharing streams in the current room.
|
|
2954
|
-
* @param type Media stream type, used for specifying whether to stop publishing audio stream or video stream. See
|
|
2954
|
+
* @param type Media stream type, used for specifying whether to stop publishing audio stream or video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2955
2955
|
* @return
|
|
2956
2956
|
* - 0: Success.
|
|
2957
|
-
* - < 0 : Fail. See
|
|
2957
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
2958
2958
|
* @note
|
|
2959
|
-
* - After calling
|
|
2960
|
-
* - After calling this API, the other users in the room will receive
|
|
2959
|
+
* - After calling {@link publishScreen publishScreen}, call this API to stop publishing streams.
|
|
2960
|
+
* - After calling this API, the other users in the room will receive {@link onUserUnpublishScreen onUserUnpublishScreen}.
|
|
2961
2961
|
*
|
|
2962
2962
|
*/
|
|
2963
2963
|
unpublishScreen(type: MediaStreamType): number;
|
|
@@ -2967,16 +2967,16 @@ export declare class RTCRoom {
|
|
|
2967
2967
|
* @author shenpengliang
|
|
2968
2968
|
* @brief Subscribes to specific remote media streams captured by camera/microphone. Or update the options of the subscribed user.
|
|
2969
2969
|
* @param uid ID of the remote user who published the target audio/video stream.
|
|
2970
|
-
* @param type Media stream type, used for specifying whether to subscribe to the audio stream or the video stream. See
|
|
2970
|
+
* @param type Media stream type, used for specifying whether to subscribe to the audio stream or the video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2971
2971
|
* @return API call result: <br>
|
|
2972
2972
|
* - 0: Success.
|
|
2973
|
-
* - <0: Failure. See
|
|
2973
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
2974
2974
|
* @note
|
|
2975
2975
|
* - Calling this API to update the subscribe configuration when the user has subscribed the remote user either by calling this API or by auto-subscribe.
|
|
2976
|
-
* - You must first get the remote stream information through
|
|
2977
|
-
* - After calling this API, you will be informed of the calling result with
|
|
2978
|
-
* - Once the local user subscribes to the stream of a remote user, the subscription to the remote user will sustain until the local user leaves the room or unsubscribe from it by calling
|
|
2979
|
-
* - Any other exceptions will be included in
|
|
2976
|
+
* - You must first get the remote stream information through {@link onUserPublishStream onUserPublishStream} before calling this API to subscribe to streams accordingly.
|
|
2977
|
+
* - After calling this API, you will be informed of the calling result with {@link onStreamSubscribed onStreamSubscribed}.
|
|
2978
|
+
* - Once the local user subscribes to the stream of a remote user, the subscription to the remote user will sustain until the local user leaves the room or unsubscribe from it by calling {@link unsubscribeStream unsubscribeStream}.
|
|
2979
|
+
* - Any other exceptions will be included in {@link onStreamStateChanged onStreamStateChanged}, see {@link ErrorCode ErrorCode} for the reasons.
|
|
2980
2980
|
*
|
|
2981
2981
|
*/
|
|
2982
2982
|
subscribeStream(uid: string, type: MediaStreamType): number;
|
|
@@ -2987,13 +2987,13 @@ export declare class RTCRoom {
|
|
|
2987
2987
|
* @brief Unsubscribes from specific remote media streams captured by camera/microphone. <br>
|
|
2988
2988
|
* You can call this API in both automatic subscription mode and manual subscription mode.
|
|
2989
2989
|
* @param uid The ID of the remote user who published the target audio/video stream.
|
|
2990
|
-
* @param type Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream. See
|
|
2990
|
+
* @param type Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream. See {@link MediaStreamType MediaStreamType}.
|
|
2991
2991
|
* @return API call result: <br>
|
|
2992
2992
|
* - 0: Success.
|
|
2993
|
-
* - <0: Failure. See
|
|
2993
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
2994
2994
|
* @note
|
|
2995
|
-
* - After calling this API, you will be informed of the calling result with
|
|
2996
|
-
* - Any other exceptions will be included in
|
|
2995
|
+
* - After calling this API, you will be informed of the calling result with {@link onStreamSubscribed onStreamSubscribed}.
|
|
2996
|
+
* - Any other exceptions will be included in {@link onStreamStateChanged onStreamStateChanged}, see {@link ErrorCode ErrorCode} for the reasons.
|
|
2997
2997
|
*
|
|
2998
2998
|
*/
|
|
2999
2999
|
unsubscribeStream(uid: string, type: MediaStreamType): number;
|
|
@@ -3003,16 +3003,16 @@ export declare class RTCRoom {
|
|
|
3003
3003
|
* @author shenpengliang
|
|
3004
3004
|
* @brief Subscribes to specific screen sharing media stream. Or update the subscribe options of the subscribed user.
|
|
3005
3005
|
* @param uid The ID of the remote user who published the target screen audio/video stream.
|
|
3006
|
-
* @param type Media stream type, used for specifying whether to subscribe to the audio stream or the video stream. See
|
|
3006
|
+
* @param type Media stream type, used for specifying whether to subscribe to the audio stream or the video stream. See {@link MediaStreamType MediaStreamType}.
|
|
3007
3007
|
* @return API call result: <br>
|
|
3008
3008
|
* - 0: Success.
|
|
3009
|
-
* - <0: Failure. See
|
|
3009
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
3010
3010
|
* @note
|
|
3011
3011
|
* - Calling this API to update the subscribe configuration when the user has subscribed the remote user either by calling this API or by auto-subscribe.
|
|
3012
|
-
* - You must first get the remote stream information through
|
|
3013
|
-
* - After calling this API, you will be informed of the calling result with
|
|
3014
|
-
* - Once the local user subscribes to the stream of a remote user, the subscription to the remote user will sustain until the local user leaves the room or unsubscribe from it by calling
|
|
3015
|
-
* - Any other exceptions will be included in
|
|
3012
|
+
* - You must first get the remote stream information through {@link onUserPublishScreen onUserPublishScreen} before calling this API to subscribe to streams accordingly.
|
|
3013
|
+
* - After calling this API, you will be informed of the calling result with {@link onStreamSubscribed onStreamSubscribed}.
|
|
3014
|
+
* - Once the local user subscribes to the stream of a remote user, the subscription to the remote user will sustain until the local user leaves the room or unsubscribe from it by calling {@link unsubscribeScreen unsubscribeScreen}.
|
|
3015
|
+
* - Any other exceptions will be included in {@link onStreamStateChanged onStreamStateChanged}, see {@link ErrorCode ErrorCode} for the reasons.
|
|
3016
3016
|
*
|
|
3017
3017
|
*/
|
|
3018
3018
|
subscribeScreen(uid: string, type: MediaStreamType): number;
|
|
@@ -3023,13 +3023,13 @@ export declare class RTCRoom {
|
|
|
3023
3023
|
* @brief Unsubscribes from specific screen sharing media stream. <br>
|
|
3024
3024
|
* You can call this API in both automatic subscription mode and manual subscription mode.
|
|
3025
3025
|
* @param uid The ID of the remote user who published the target screen audio/video stream.
|
|
3026
|
-
* @param type Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream. See
|
|
3026
|
+
* @param type Media stream type, used for specifying whether to unsubscribe from the audio stream or the video stream. See {@link MediaStreamType MediaStreamType}.
|
|
3027
3027
|
* @return API call result: <br>
|
|
3028
3028
|
* - 0: Success.
|
|
3029
|
-
* - <0: Failure. See
|
|
3029
|
+
* - <0: Failure. See {@link ReturnStatus ReturnStatus} for specific reasons.
|
|
3030
3030
|
* @note
|
|
3031
|
-
* - After calling this API, you will be informed of the calling result with
|
|
3032
|
-
* - Any other exceptions will be included in
|
|
3031
|
+
* - After calling this API, you will be informed of the calling result with {@link onStreamSubscribed onStreamSubscribed}.
|
|
3032
|
+
* - Any other exceptions will be included in {@link onStreamStateChanged onStreamStateChanged}, see {@link ErrorCode ErrorCode} for the reasons.
|
|
3033
3033
|
*
|
|
3034
3034
|
*/
|
|
3035
3035
|
unsubscribeScreen(uid: string, type: MediaStreamType): number;
|
|
@@ -3038,14 +3038,14 @@ export declare class RTCRoom {
|
|
|
3038
3038
|
* @region Multi-room
|
|
3039
3039
|
* @author shenpengliang
|
|
3040
3040
|
* @brief Pause receiving remote media streams.
|
|
3041
|
-
* @param mediaType Media stream type subscribed to. Refer to
|
|
3041
|
+
* @param mediaType Media stream type subscribed to. Refer to {@link PauseResumeControlMediaType PauseResumeControlMediaType} for more details.
|
|
3042
3042
|
* @return
|
|
3043
3043
|
* - 0: Success.
|
|
3044
|
-
* - < 0 : Fail. See
|
|
3044
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
3045
3045
|
* @note
|
|
3046
3046
|
* - Calling this API does not change the capture state and the transmission state of the remote clients.
|
|
3047
3047
|
* - Calling this API does not cancel the subscription or change any subscription configuration.
|
|
3048
|
-
* - To resume, call
|
|
3048
|
+
* - To resume, call {@link resumeAllSubscribedStream resumeAllSubscribedStream}.
|
|
3049
3049
|
* - In a multi-room scenario, this API only pauses the reception of streams published in the current room.
|
|
3050
3050
|
*
|
|
3051
3051
|
*/
|
|
@@ -3055,10 +3055,10 @@ export declare class RTCRoom {
|
|
|
3055
3055
|
* @region Multi-room
|
|
3056
3056
|
* @author shenpengliang
|
|
3057
3057
|
* @brief Resume receiving remote media streams
|
|
3058
|
-
* @param mediaType Media stream type subscribed to. Refer to
|
|
3058
|
+
* @param mediaType Media stream type subscribed to. Refer to {@link PauseResumeControlMediaType PauseResumeControlMediaType} for more details.
|
|
3059
3059
|
* @return
|
|
3060
3060
|
* - 0: Success.
|
|
3061
|
-
* - < 0 : Fail. See
|
|
3061
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
3062
3062
|
* @note
|
|
3063
3063
|
* - Calling this API does not change the capture state and the transmission state of the remote clients.
|
|
3064
3064
|
* - Calling this API does not change any subscription configuration.
|
|
@@ -3069,15 +3069,15 @@ export declare class RTCRoom {
|
|
|
3069
3069
|
* @detail api
|
|
3070
3070
|
* @region Multi-room
|
|
3071
3071
|
* @author shenpengliang
|
|
3072
|
-
* @brief Call to this method to stop relaying media stream to all rooms after calling
|
|
3072
|
+
* @brief Call to this method to stop relaying media stream to all rooms after calling {@link startForwardStreamToRooms startForwardStreamToRooms}.
|
|
3073
3073
|
* @return
|
|
3074
3074
|
* - 0: Success.
|
|
3075
|
-
* - < 0 : Fail. See
|
|
3075
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
3076
3076
|
* @note
|
|
3077
|
-
* - Call this method will trigger
|
|
3078
|
-
* - The other users in the room will receive callback of
|
|
3079
|
-
* - To stop relaying media stream to specific rooms, call
|
|
3080
|
-
* - To resume the relaying in a short time, call
|
|
3077
|
+
* - Call this method will trigger {@link onForwardStreamStateChanged onForwardStreamStateChanged}.
|
|
3078
|
+
* - The other users in the room will receive callback of {@link onUserJoined onUserJoined} and {@link onUserPublishStream onUserPublishStream}{@link onUserPublishScreen /onUserPublishScreen} when you stop relaying.
|
|
3079
|
+
* - To stop relaying media stream to specific rooms, call {@link updateForwardStreamToRooms updateForwardStreamToRooms} instead.
|
|
3080
|
+
* - To resume the relaying in a short time, call {@link pauseForwardStreamToAllRooms pauseForwardStreamToAllRooms} instead and then call {@link resumeForwardStreamToAllRooms resumeForwardStreamToAllRooms} to recsume after that.
|
|
3081
3081
|
*
|
|
3082
3082
|
*/
|
|
3083
3083
|
stopForwardStreamToRooms(): number;
|
|
@@ -3085,12 +3085,12 @@ export declare class RTCRoom {
|
|
|
3085
3085
|
* @detail api
|
|
3086
3086
|
* @region Multi-room
|
|
3087
3087
|
* @author shenpengliang
|
|
3088
|
-
* @brief Call this method to pause relaying media stream to all rooms after calling
|
|
3089
|
-
* After that, call
|
|
3088
|
+
* @brief Call this method to pause relaying media stream to all rooms after calling {@link startForwardStreamToRooms startForwardStreamToRooms}. <br>
|
|
3089
|
+
* After that, call {@link resumeForwardStreamToAllRooms resumeForwardStreamToAllRooms} to resume.
|
|
3090
3090
|
* @return
|
|
3091
3091
|
* - 0: Success.
|
|
3092
|
-
* - < 0 : Fail. See
|
|
3093
|
-
* @note The other users in the room will receive callback of
|
|
3092
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
3093
|
+
* @note The other users in the room will receive callback of {@link onUserUnpublishStream onUserUnpublishStream}{@link onUserUnpublishScreen /onUserUnpublishScreen} and {@link onUserLeave onUserLeave} when you pause relaying.
|
|
3094
3094
|
*
|
|
3095
3095
|
*/
|
|
3096
3096
|
pauseForwardStreamToAllRooms(): number;
|
|
@@ -3098,11 +3098,11 @@ export declare class RTCRoom {
|
|
|
3098
3098
|
* @detail api
|
|
3099
3099
|
* @region Multi-room
|
|
3100
3100
|
* @author shenpengliang
|
|
3101
|
-
* @brief Call this method to resume relaying to all rooms from the pause by calling
|
|
3101
|
+
* @brief Call this method to resume relaying to all rooms from the pause by calling {@link pauseForwardStreamToAllRooms pauseForwardStreamToAllRooms}.
|
|
3102
3102
|
* @return
|
|
3103
3103
|
* - 0: Success.
|
|
3104
|
-
* - < 0 : Fail. See
|
|
3105
|
-
* @note The other users in the room will receive callback of
|
|
3104
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
3105
|
+
* @note The other users in the room will receive callback of {@link onUserJoined onUserJoined} and {@link onUserPublishStream onUserPublishStream}{@link onUserPublishScreen /onUserPublishScreen} when you resume relaying.
|
|
3106
3106
|
*
|
|
3107
3107
|
*/
|
|
3108
3108
|
resumeForwardStreamToAllRooms(): number;
|
|
@@ -3112,7 +3112,7 @@ export declare class RTCRoom {
|
|
|
3112
3112
|
* @author luomingkang
|
|
3113
3113
|
* @brief Gets range audio instance.
|
|
3114
3114
|
* @return API call result: <br>
|
|
3115
|
-
* - IRangeAudio: Success. You will get an
|
|
3115
|
+
* - IRangeAudio: Success. You will get an {@link IRangeAudio IRangeAudio} returned from the SDK.
|
|
3116
3116
|
* - null: Failure. The current SDK does not offer range audio function.
|
|
3117
3117
|
* @note The first time this API is called must be between you create a room and you actually enter the room. Refer to [Range Voice](https://docs.byteplus.com/byteplus-rtc/docs/114727) for more information.
|
|
3118
3118
|
*
|
|
@@ -3123,7 +3123,7 @@ export declare class RTCRoom {
|
|
|
3123
3123
|
* @region Spatial voice
|
|
3124
3124
|
* @author wangjunzheng
|
|
3125
3125
|
* @brief Get location audio interface instances.
|
|
3126
|
-
* @return Spatial audio management interface instance. If NULL is returned, spatial audio is not supported. See
|
|
3126
|
+
* @return Spatial audio management interface instance. If NULL is returned, spatial audio is not supported. See {@link ISpatialAudio ISpatialAudio}.
|
|
3127
3127
|
* @note
|
|
3128
3128
|
* - The first time this API is called must be between you create a room and you actually enter the room. Refer to [Spatial Audio](https://docs.byteplus.com/byteplus-rtc/docs/93903) for more information.
|
|
3129
3129
|
* - The spatial audio effect can only be turned on when using a device that supports true two-channel playback;
|
|
@@ -3145,10 +3145,10 @@ export declare class RTCRoom {
|
|
|
3145
3145
|
* - 400: Up to 4 times the original volume (with overflow protection)
|
|
3146
3146
|
* @return
|
|
3147
3147
|
* - 0: Success.
|
|
3148
|
-
* - < 0 : Fail. See
|
|
3148
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details
|
|
3149
3149
|
* @note Suppose a remote user A is always within the range of the target user whose playback volume will be adjusted, <br>
|
|
3150
|
-
* - If you use both this method and
|
|
3151
|
-
* - If you use both this method and
|
|
3150
|
+
* - If you use both this method and {@link setRemoteAudioPlaybackVolume setRemoteAudioPlaybackVolume}, the volume that the local user hears from user A is the volume set by the method called later.
|
|
3151
|
+
* - If you use both this method and {@link setPlaybackVolume setPlaybackVolume}, the volume that the local user hears from user A is the overlay of both settings.
|
|
3152
3152
|
*
|
|
3153
3153
|
*/
|
|
3154
3154
|
setRemoteRoomAudioPlaybackVolume(volume: number): number;
|
|
@@ -3158,9 +3158,8 @@ export declare class RTCRoom {
|
|
|
3158
3158
|
* @region Room Management
|
|
3159
3159
|
* @author yejing.luna
|
|
3160
3160
|
* @brief Set the priority of the local audio stream to be published.
|
|
3161
|
-
* @param audioSelectionPriority The priority of the local audio stream which defaults to be subscribable only up to the result of the Audio Selection. Refer to
|
|
3162
|
-
* @note
|
|
3163
|
-
* You must enable Audio Selection in the RTC console before using this API. You can call this API whether the user has joined a room. Refer to [Audio Selection](https://docs.byteplus.com/byteplus-rtc/docs/113547). <br>
|
|
3161
|
+
* @param audioSelectionPriority The priority of the local audio stream which defaults to be subscribable only up to the result of the Audio Selection. Refer to {@link AudioSelectionPriority AudioSelectionPriority}.
|
|
3162
|
+
* @note You must enable Audio Selection in the RTC console before using this API. You can call this API whether the user has joined a room. Refer to [Audio Selection](https://docs.byteplus.com/byteplus-rtc/docs/113547). <br>
|
|
3164
3163
|
* The setting is independent in each room that the user joins.
|
|
3165
3164
|
*
|
|
3166
3165
|
*/
|
|
@@ -3176,11 +3175,11 @@ export declare class RTCRoom {
|
|
|
3176
3175
|
* @param value Content of the extra information, less than 128 bytes in length.
|
|
3177
3176
|
* @return API call result: <br>
|
|
3178
3177
|
* - 0: Success with a taskId returned.
|
|
3179
|
-
* - <0: Failure. See
|
|
3178
|
+
* - <0: Failure. See {@link SetRoomExtraInfoResult SetRoomExtraInfoResult} for the reasons.
|
|
3180
3179
|
* @note
|
|
3181
|
-
* - Call
|
|
3182
|
-
* - After calling this API, you will receive
|
|
3183
|
-
* - After the extra information is successfully set, other users in the same room will receive the information through
|
|
3180
|
+
* - Call {@link joinRoom joinRoom} first before you call this API to set extra information.
|
|
3181
|
+
* - After calling this API, you will receive {@link onSetRoomExtraInfoResult onSetRoomExtraInfoResult} callback informing you the result of the setting.
|
|
3182
|
+
* - After the extra information is successfully set, other users in the same room will receive the information through {@link onRoomExtraInfoUpdate onRoomExtraInfoUpdate} callback.
|
|
3184
3183
|
* - Users who join the room later will be notified of all extra information in the room set prior to entering.
|
|
3185
3184
|
*
|
|
3186
3185
|
*/
|
|
@@ -3191,10 +3190,10 @@ export declare class RTCRoom {
|
|
|
3191
3190
|
* @region Subtitle translation service
|
|
3192
3191
|
* @author qiaoxingwang
|
|
3193
3192
|
* @brief Recognizes or translates the speech of all speakers in the room and converts the results into captions. <br>
|
|
3194
|
-
* When calling this method, you can choose the subtitle mode in
|
|
3195
|
-
* If you choose the translation mode, you will receive two
|
|
3196
|
-
* After calling this method, you will receive the
|
|
3197
|
-
* @param subtitleConfig Subtitle configurations. Refer to
|
|
3193
|
+
* When calling this method, you can choose the subtitle mode in {@link SubtitleMode SubtitleMode}. If you choose the recognition mode, you will receive the {@link onSubtitleMessageReceived onSubtitleMessageReceived} callback which contains the transcribed text. <br>
|
|
3194
|
+
* If you choose the translation mode, you will receive two {@link onSubtitleMessageReceived onSubtitleMessageReceived} callbacks simultaneously, one contains the transcribed text and the other contains the translated text. <br>
|
|
3195
|
+
* After calling this method, you will receive the {@link onSubtitleStateChanged onSubtitleStateChanged} to inform you of whether subtitles are on.
|
|
3196
|
+
* @param subtitleConfig Subtitle configurations. Refer to {@link SubtitleConfig SubtitleConfig} for details.
|
|
3198
3197
|
* @return
|
|
3199
3198
|
* - 0: Success.
|
|
3200
3199
|
* - !0: Failure.
|
|
@@ -3210,7 +3209,7 @@ export declare class RTCRoom {
|
|
|
3210
3209
|
* @region Subtitle translation service
|
|
3211
3210
|
* @author qiaoxingwang
|
|
3212
3211
|
* @brief Turns off subtitles. <br>
|
|
3213
|
-
* After calling this method, you will receive the
|
|
3212
|
+
* After calling this method, you will receive the {@link onSubtitleStateChanged onSubtitleStateChanged} to inform you of whether subtitles are off.
|
|
3214
3213
|
* @return
|
|
3215
3214
|
* - 0: Success.
|
|
3216
3215
|
* - !0: Failure.
|
|
@@ -3235,7 +3234,7 @@ export declare class ISingScoringManager {
|
|
|
3235
3234
|
* @detail api
|
|
3236
3235
|
* @author wangjunzheng
|
|
3237
3236
|
* @brief Set the configuration of karaoke scoring.
|
|
3238
|
-
* @param config The parameters of karaoke scoring. See
|
|
3237
|
+
* @param config The parameters of karaoke scoring. See {@link SingScoringConfig SingScoringConfig}.
|
|
3239
3238
|
* @return
|
|
3240
3239
|
* - 0:Success.
|
|
3241
3240
|
* - -1:Interface call failed.
|
|
@@ -3256,9 +3255,9 @@ export declare class ISingScoringManager {
|
|
|
3256
3255
|
* - -2: Karaoke scoring module not integrated.
|
|
3257
3256
|
* - >0: Other error. For details, see[Error code].
|
|
3258
3257
|
* @note
|
|
3259
|
-
* - You can call this API after calling
|
|
3260
|
-
* - After this interface is called, you will receive the scoring result
|
|
3261
|
-
* - If you call the
|
|
3258
|
+
* - You can call this API after calling {@link initSingScoring initSingScoring} to initialize karaoke scoring.
|
|
3259
|
+
* - After this interface is called, you will receive the scoring result {@link onCurrentScoringInfo onCurrentScoringInfo} at set interval.
|
|
3260
|
+
* - If you call the {@link startAudioMixing startAudioMixing} to play an audio file, call this interface after you receive {@link onAudioMixingStateChanged onAudioMixingStateChanged}(AUDIO_MIXING_STATE_PLAYING(1)).
|
|
3262
3261
|
*
|
|
3263
3262
|
*/
|
|
3264
3263
|
startSingScoring(position: number, scoringInfoInterval: number): number;
|
|
@@ -3275,7 +3274,7 @@ export declare class ISingScoringManager {
|
|
|
3275
3274
|
/** {en}
|
|
3276
3275
|
* @detail api
|
|
3277
3276
|
* @author wangjunzheng
|
|
3278
|
-
* @brief Get the score for the previous lyric. You can call this API after
|
|
3277
|
+
* @brief Get the score for the previous lyric. You can call this API after {@link startSingScoring startSingScoring} is called.
|
|
3279
3278
|
* @return
|
|
3280
3279
|
* - <0:Failed to get the score for the previous lyric.
|
|
3281
3280
|
* - >=0:The score for the previous lyric.
|
|
@@ -3285,7 +3284,7 @@ export declare class ISingScoringManager {
|
|
|
3285
3284
|
/** {en}
|
|
3286
3285
|
* @detail api
|
|
3287
3286
|
* @author wangjunzheng
|
|
3288
|
-
* @brief Get the total score for the user's current performance.You can call this API after
|
|
3287
|
+
* @brief Get the total score for the user's current performance.You can call this API after {@link startSingScoring startSingScoring} is called.
|
|
3289
3288
|
* @return
|
|
3290
3289
|
* - <0:Failed to get the total score.
|
|
3291
3290
|
* - >=0:The current total score.
|
|
@@ -3320,7 +3319,7 @@ export declare class IKTVManager {
|
|
|
3320
3319
|
* @detail api
|
|
3321
3320
|
* @author lihuan.wuti2ha
|
|
3322
3321
|
* @brief Sets the KTV event handler.
|
|
3323
|
-
* @param ktvManagerEventHandler KTV event handler. See
|
|
3322
|
+
* @param ktvManagerEventHandler KTV event handler. See {@link IKTVManagerEventHandler IKTVManagerEventHandler}.
|
|
3324
3323
|
*
|
|
3325
3324
|
*/
|
|
3326
3325
|
android_setKTVManagerEventHandler(ktvManagerEventHandler: $p_a.IKTVManagerEventHandler): void;
|
|
@@ -3338,7 +3337,7 @@ export declare class IKTVManager {
|
|
|
3338
3337
|
* @author lihuan.wuti2ha
|
|
3339
3338
|
* @brief Gets music detail.
|
|
3340
3339
|
* @param musicId Music ID.
|
|
3341
|
-
* @note After calling this API, you will receive the music detail through
|
|
3340
|
+
* @note After calling this API, you will receive the music detail through {@link onMusicDetailResult onMusicDetailResult} callback.
|
|
3342
3341
|
*
|
|
3343
3342
|
*/
|
|
3344
3343
|
getMusicDetail(musicId: string): void;
|
|
@@ -3349,9 +3348,9 @@ export declare class IKTVManager {
|
|
|
3349
3348
|
* @param musicId Music ID.
|
|
3350
3349
|
* @return Download task ID.
|
|
3351
3350
|
* @note
|
|
3352
|
-
* - If the music is successfully downloaded, you will receive
|
|
3353
|
-
* - If the music fails to download, you will receive
|
|
3354
|
-
* - When the music download progress is updated, you will receive
|
|
3351
|
+
* - If the music is successfully downloaded, you will receive {@link onDownloadSuccess onDownloadSuccess}.
|
|
3352
|
+
* - If the music fails to download, you will receive {@link onDownloadFailed onDownloadFailed}.
|
|
3353
|
+
* - When the music download progress is updated, you will receive {@link onDownloadMusicProgress onDownloadMusicProgress}.
|
|
3355
3354
|
*
|
|
3356
3355
|
*/
|
|
3357
3356
|
downloadMusic(musicId: string): number;
|
|
@@ -3360,11 +3359,11 @@ export declare class IKTVManager {
|
|
|
3360
3359
|
* @author lihuan.wuti2ha
|
|
3361
3360
|
* @brief Download lyrics.
|
|
3362
3361
|
* @param musicId Music ID.
|
|
3363
|
-
* @param lyricType The lyrics file's format. See
|
|
3362
|
+
* @param lyricType The lyrics file's format. See {@link DownloadLyricType DownloadLyricType}.
|
|
3364
3363
|
* @return Download task ID.
|
|
3365
3364
|
* @note
|
|
3366
|
-
* - If the lyrics are successfully downloaded, you will receive
|
|
3367
|
-
* - If the lyrics fail to download, you will receive
|
|
3365
|
+
* - If the lyrics are successfully downloaded, you will receive {@link onDownloadSuccess onDownloadSuccess}.
|
|
3366
|
+
* - If the lyrics fail to download, you will receive {@link onDownloadFailed onDownloadFailed}.
|
|
3368
3367
|
*
|
|
3369
3368
|
*/
|
|
3370
3369
|
downloadLyric(musicId: string, lyricType: DownloadLyricType): number;
|
|
@@ -3375,8 +3374,8 @@ export declare class IKTVManager {
|
|
|
3375
3374
|
* @param musicId Music ID.
|
|
3376
3375
|
* @return Download task ID.
|
|
3377
3376
|
* @note
|
|
3378
|
-
* - If the file is successfully downloaded, you will receive
|
|
3379
|
-
* - If the file fails to download, you will receive
|
|
3377
|
+
* - If the file is successfully downloaded, you will receive {@link onDownloadSuccess onDownloadSuccess}.
|
|
3378
|
+
* - If the file fails to download, you will receive {@link onDownloadFailed onDownloadFailed}.
|
|
3380
3379
|
*
|
|
3381
3380
|
*/
|
|
3382
3381
|
downloadMidi(musicId: string): number;
|
|
@@ -3399,7 +3398,7 @@ export declare class IKTVManager {
|
|
|
3399
3398
|
* @detail api
|
|
3400
3399
|
* @author lihuan.wuti2ha
|
|
3401
3400
|
* @brief Gets the KTV player.
|
|
3402
|
-
* @return KTV player interfaces. See
|
|
3401
|
+
* @return KTV player interfaces. See {@link IKTVPlayer IKTVPlayer}.
|
|
3403
3402
|
*
|
|
3404
3403
|
*/
|
|
3405
3404
|
getKTVPlayer(): IKTVPlayer;
|
|
@@ -3413,11 +3412,11 @@ export declare class IRangeAudio {
|
|
|
3413
3412
|
* @region Range Audio
|
|
3414
3413
|
* @author chuzhongtao
|
|
3415
3414
|
* @brief Enable/disable the range audio function. <br>
|
|
3416
|
-
* Range audio means that within a certain range in a same RTC room, the audio volume of the remote user received by the local user will be amplified/attenuated as the remote user moves closer/away. The audio coming from out of the range cannot be heard. See
|
|
3415
|
+
* Range audio means that within a certain range in a same RTC room, the audio volume of the remote user received by the local user will be amplified/attenuated as the remote user moves closer/away. The audio coming from out of the range cannot be heard. See {@link updateReceiveRange updateReceiveRange} to set audio receiving range.
|
|
3417
3416
|
* @param enable Whether to enable audio range function: <br>
|
|
3418
3417
|
* - true: Enable
|
|
3419
3418
|
* - false: Disable(Defaulting setting)
|
|
3420
|
-
* @note You can call this API anytime before or after entering a room. To ensure a smooth switch to the range audio mode after entering the room, you need to call
|
|
3419
|
+
* @note You can call this API anytime before or after entering a room. To ensure a smooth switch to the range audio mode after entering the room, you need to call {@link updatePosition updatePosition} before this API to set your own position coordinates, and then enable the range audio function.
|
|
3421
3420
|
*
|
|
3422
3421
|
*/
|
|
3423
3422
|
enableRangeAudio(enable: boolean): void;
|
|
@@ -3431,7 +3430,7 @@ export declare class IRangeAudio {
|
|
|
3431
3430
|
* - 0: Success
|
|
3432
3431
|
* - !0: Failure
|
|
3433
3432
|
* @note
|
|
3434
|
-
* - After calling this API, you should call
|
|
3433
|
+
* - After calling this API, you should call {@link enableRangeAudio enableRangeAudio} to enable range audio function to actually enjoy the range audio effect.
|
|
3435
3434
|
*
|
|
3436
3435
|
*/
|
|
3437
3436
|
updatePosition(pos: Position): number;
|
|
@@ -3440,7 +3439,7 @@ export declare class IRangeAudio {
|
|
|
3440
3439
|
* @region Range Audio
|
|
3441
3440
|
* @author chuzhongtao
|
|
3442
3441
|
* @brief Updates the audio receiving range for the local user.
|
|
3443
|
-
* @param range Audio receiving range, see
|
|
3442
|
+
* @param range Audio receiving range, see {@link ReceiveRange ReceiveRange}.
|
|
3444
3443
|
* @return API call result: <br>
|
|
3445
3444
|
* - 0: Success
|
|
3446
3445
|
* - !0: Failure
|
|
@@ -3452,12 +3451,12 @@ export declare class IRangeAudio {
|
|
|
3452
3451
|
* @region Range Audio
|
|
3453
3452
|
* @author huangshouqin
|
|
3454
3453
|
* @brief Set the volume roll-off mode that a 3D sound has in an audio source when using the Range Audio feature.
|
|
3455
|
-
* @param type Volume roll-off mode. It is linear roll-off mode by default. Refer to
|
|
3454
|
+
* @param type Volume roll-off mode. It is linear roll-off mode by default. Refer to {@link AttenuationType AttenuationType} for more details.
|
|
3456
3455
|
* @param coefficient Coefficient for the exponential roll-off mode. The default value is 1. It ranges [0.1,100]. We recommended to set it to `50`. The volume roll-off speed gets faster as this value increases.
|
|
3457
3456
|
* @return Result of the call <br>
|
|
3458
3457
|
* - `0`: Success
|
|
3459
|
-
* - `-1`: Failure because of calling this API before the user has joined a room or before enabling the Range Audio feature by calling
|
|
3460
|
-
* @note Call
|
|
3458
|
+
* - `-1`: Failure because of calling this API before the user has joined a room or before enabling the Range Audio feature by calling {@link enableRangeAudio enableRangeAudio}.
|
|
3459
|
+
* @note Call {@link updateReceiveRange updateReceiveRange} to set the range outside which the volume of the sound does not attenuate.
|
|
3461
3460
|
*
|
|
3462
3461
|
*/
|
|
3463
3462
|
setAttenuationModel(type: AttenuationType, coefficient: number): number;
|
|
@@ -3486,7 +3485,7 @@ export declare class IMediaPlayer {
|
|
|
3486
3485
|
* @detail api
|
|
3487
3486
|
* @brief Open the audio file. <br>
|
|
3488
3487
|
* You can only open one audio file with one player instance at the same time. For multiple audio files at the same time, create multiple player instances. <br>
|
|
3489
|
-
* For audio file in PCM format, see
|
|
3488
|
+
* For audio file in PCM format, see {@link openWithCustomSource openWithCustomSource}. `openWithCustomSource` and this API are mutually exclusive.
|
|
3490
3489
|
* @param filePath Audio file paths. <br>
|
|
3491
3490
|
* URL of online file, URI of local file, full path to local file, or path to local file starting with `/assets/` are supported. For URL of online file, only the https protocol is supported. <br>
|
|
3492
3491
|
* Recommended sample rate for audio effect files: 8KHz、16KHz、22.05KHz、44.1KHz、48KHz. <br>
|
|
@@ -3504,69 +3503,68 @@ export declare class IMediaPlayer {
|
|
|
3504
3503
|
* <tr><td>iOS/macOS</td><td>Y</td><td></td><td>Y</td><td>Y</td><td></td><td>Y</td><td></td><td></td><td></td></tr>
|
|
3505
3504
|
* <tr><td>Windows</td><td>Y</td><td></td><td>Y</td><td>Y</td><td>Y</td><td>Y</td><td></td><td>Y</td><td>Y</td></tr>
|
|
3506
3505
|
* </table>
|
|
3507
|
-
* @param config See
|
|
3506
|
+
* @param config See {@link MediaPlayerConfig MediaPlayerConfig}.
|
|
3508
3507
|
* @return
|
|
3509
3508
|
* - 0: Success.
|
|
3510
|
-
* - < 0 : Fail. See
|
|
3509
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3511
3510
|
*
|
|
3512
3511
|
*/
|
|
3513
3512
|
open(filePath: string, config: MediaPlayerConfig): number;
|
|
3514
3513
|
/** {en}
|
|
3515
3514
|
* @detail api
|
|
3516
|
-
* @brief Start playing the audio. Call this API when you call
|
|
3515
|
+
* @brief Start playing the audio. Call this API when you call {@link open open} and set `AutoPlay=False`.
|
|
3517
3516
|
* @return
|
|
3518
3517
|
* - 0: Success.
|
|
3519
|
-
* - < 0 : Fail. See
|
|
3518
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3520
3519
|
* @note
|
|
3521
|
-
* - For audio file in PCM format, see
|
|
3522
|
-
* - After calling this API, call
|
|
3520
|
+
* - For audio file in PCM format, see {@link openWithCustomSource openWithCustomSource}. `openWithCustomSource` and this API are mutually exclusive.
|
|
3521
|
+
* - After calling this API, call {@link stop stop} to stop playing the audio file.
|
|
3523
3522
|
*
|
|
3524
3523
|
*/
|
|
3525
3524
|
start(): number;
|
|
3526
3525
|
/** {en}
|
|
3527
3526
|
* @detail api
|
|
3528
3527
|
* @brief Enable audio mixing with audio raw data. <br>
|
|
3529
|
-
* To open the audio file, see
|
|
3530
|
-
* @param source See
|
|
3531
|
-
* @param config See
|
|
3528
|
+
* To open the audio file, see {@link open open}. `open` and this API are mutually exclusive.
|
|
3529
|
+
* @param source See {@link MediaPlayerCustomSource MediaPlayerCustomSource}.
|
|
3530
|
+
* @param config See {@link MediaPlayerConfig MediaPlayerConfig}.
|
|
3532
3531
|
* @return
|
|
3533
3532
|
* - 0: Success.
|
|
3534
|
-
* - < 0 : Fail. See
|
|
3533
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3535
3534
|
* @note
|
|
3536
|
-
* - After calling this API, you must call
|
|
3537
|
-
* - To stop the raw data audio mixing, call
|
|
3535
|
+
* - After calling this API, you must call {@link pushExternalAudioFrame pushExternalAudioFrame} to push audio data and start the audio mixing.
|
|
3536
|
+
* - To stop the raw data audio mixing, call {@link stop stop}.
|
|
3538
3537
|
*
|
|
3539
3538
|
*/
|
|
3540
3539
|
openWithCustomSource(source: MediaPlayerCustomSource, config: MediaPlayerConfig): number;
|
|
3541
3540
|
/** {en}
|
|
3542
3541
|
* @detail api
|
|
3543
|
-
* @brief After calling
|
|
3542
|
+
* @brief After calling {@link open open}, {@link start start}, or {@link openWithCustomSource openWithCustomSource} to start audio mixing, call this method to stop audio mixing.
|
|
3544
3543
|
* @return
|
|
3545
3544
|
* - 0: Success.
|
|
3546
|
-
* - < 0 : Fail. See
|
|
3545
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3547
3546
|
*
|
|
3548
3547
|
*/
|
|
3549
3548
|
stop(): number;
|
|
3550
3549
|
/** {en}
|
|
3551
3550
|
* @detail api
|
|
3552
|
-
* @brief After calling
|
|
3551
|
+
* @brief After calling {@link open open}, or {@link start start} to start audio mixing, call this API to pause audio mixing.
|
|
3553
3552
|
* @return
|
|
3554
3553
|
* - 0: Success.
|
|
3555
|
-
* - < 0 : Fail. See
|
|
3554
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3556
3555
|
* @note
|
|
3557
|
-
* - After calling this API to pause audio mixing, call
|
|
3556
|
+
* - After calling this API to pause audio mixing, call {@link resume resume} to resume audio mixing.
|
|
3558
3557
|
* - The API is valid for audio file, not PCM data.
|
|
3559
3558
|
*
|
|
3560
3559
|
*/
|
|
3561
3560
|
pause(): number;
|
|
3562
3561
|
/** {en}
|
|
3563
3562
|
* @detail api
|
|
3564
|
-
* @brief After calling
|
|
3563
|
+
* @brief After calling {@link pause pause} to pause audio mixing, call this API to resume audio mixing.
|
|
3565
3564
|
* @return
|
|
3566
3565
|
* - 0: Success.
|
|
3567
|
-
* - < 0 : Fail. See
|
|
3568
|
-
* @note
|
|
3569
|
-
* The API is valid for audio file, not PCM data.
|
|
3566
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3567
|
+
* @note The API is valid for audio file, not PCM data.
|
|
3570
3568
|
*
|
|
3571
3569
|
*/
|
|
3572
3570
|
resume(): number;
|
|
@@ -3574,10 +3572,10 @@ export declare class IMediaPlayer {
|
|
|
3574
3572
|
* @detail api
|
|
3575
3573
|
* @brief Adjusts the volume of the specified audio mixing, including media file mixing and PCM mixing.
|
|
3576
3574
|
* @param volume The ratio of the volume to the original volume in \% with overflow protection. The range is `[0, 400]` and the recommended range is `[0, 100]`.
|
|
3577
|
-
* @param type See
|
|
3575
|
+
* @param type See {@link AudioMixingType AudioMixingType}.
|
|
3578
3576
|
* @return
|
|
3579
3577
|
* - 0: Success.
|
|
3580
|
-
* - < 0 : Fail. See
|
|
3578
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3581
3579
|
* @note Call this API only when audio is mixing.
|
|
3582
3580
|
*
|
|
3583
3581
|
*/
|
|
@@ -3585,7 +3583,7 @@ export declare class IMediaPlayer {
|
|
|
3585
3583
|
/** {en}
|
|
3586
3584
|
* @detail api
|
|
3587
3585
|
* @brief Gets the current volume.
|
|
3588
|
-
* @param type See
|
|
3586
|
+
* @param type See {@link AudioMixingType AudioMixingType}.
|
|
3589
3587
|
* @return
|
|
3590
3588
|
* - >0: Success, the current volume.
|
|
3591
3589
|
* - < 0: Failed.
|
|
@@ -3613,7 +3611,7 @@ export declare class IMediaPlayer {
|
|
|
3613
3611
|
* - < 0: Failed.
|
|
3614
3612
|
* @note
|
|
3615
3613
|
* - The actual playback time refers to the playback time of the song without being affected by stop, jump, double speed, and freeze. For example, if the song stops playing for 30 seconds at 1:30 or skips to 2:00, and then continues to play normally for 2 minutes, the actual playing time is 3 minutes and 30 seconds.
|
|
3616
|
-
* - Call this API only when audio is mixing and the interval set by
|
|
3614
|
+
* - Call this API only when audio is mixing and the interval set by {@link setProgressInterval setProgressInterval} is above `0`.
|
|
3617
3615
|
* - The API is valid for audio file, not PCM data.
|
|
3618
3616
|
*
|
|
3619
3617
|
*/
|
|
@@ -3636,7 +3634,7 @@ export declare class IMediaPlayer {
|
|
|
3636
3634
|
* @param pitch The increase or decrease value compared with the original pitch of the music file. The range is `[-12, 12]`. The default value is 0. The pitch distance between two adjacent values is half a step. A positive value indicates a rising pitch, and a negative value indicates a falling pitch.
|
|
3637
3635
|
* @return
|
|
3638
3636
|
* - 0: Success.
|
|
3639
|
-
* - < 0 : Fail. See
|
|
3637
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3640
3638
|
* @note
|
|
3641
3639
|
* - Call this API only when audio is mixing.
|
|
3642
3640
|
* - Support audio file only and not PCM data.
|
|
@@ -3647,10 +3645,10 @@ export declare class IMediaPlayer {
|
|
|
3647
3645
|
* @detail api
|
|
3648
3646
|
* @brief Sets the starting playback position of the media file.
|
|
3649
3647
|
* @param position The starting position of the media file in milliseconds. <br>
|
|
3650
|
-
* You can get the total duration of the media file through
|
|
3648
|
+
* You can get the total duration of the media file through {@link getTotalDuration getTotalDuration}. The value of position should be less than the total duration of the media file.
|
|
3651
3649
|
* @return
|
|
3652
3650
|
* - 0: Success.
|
|
3653
|
-
* - < 0 : Fail. See
|
|
3651
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3654
3652
|
* @note
|
|
3655
3653
|
* - The API is valid for audio file, not PCM data.
|
|
3656
3654
|
* - When playing online files, calling this API may cause playback delay.
|
|
@@ -3660,10 +3658,10 @@ export declare class IMediaPlayer {
|
|
|
3660
3658
|
/** {en}
|
|
3661
3659
|
* @detail api
|
|
3662
3660
|
* @brief Sets the channel mode of the mixing of the media file.
|
|
3663
|
-
* @param mode The mode of channel. The default channel mode is the same as the source file. See
|
|
3661
|
+
* @param mode The mode of channel. The default channel mode is the same as the source file. See {@link AudioMixingDualMonoMode AudioMixingDualMonoMode}.
|
|
3664
3662
|
* @return
|
|
3665
3663
|
* - 0: Success.
|
|
3666
|
-
* - < 0 : Fail. See
|
|
3664
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3667
3665
|
* @note
|
|
3668
3666
|
* - Call this API only when audio is mixing.
|
|
3669
3667
|
* - Audio file is supported, but not PCM data.
|
|
@@ -3684,10 +3682,10 @@ export declare class IMediaPlayer {
|
|
|
3684
3682
|
/** {en}
|
|
3685
3683
|
* @detail api
|
|
3686
3684
|
* @brief Specifies the playback track of the current media file.
|
|
3687
|
-
* @param index The specified playback audio track, starting from 0, and the range is `[0, getAudioTrackCount()-1]`. The value must be less than the return value of
|
|
3685
|
+
* @param index The specified playback audio track, starting from 0, and the range is `[0, getAudioTrackCount()-1]`. The value must be less than the return value of {@link getAudioTrackCount getAudioTrackCount}.
|
|
3688
3686
|
* @return
|
|
3689
3687
|
* - 0: Success.
|
|
3690
|
-
* - < 0 : Fail. See
|
|
3688
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3691
3689
|
* @note
|
|
3692
3690
|
* - Call this API only when audio is mixing.
|
|
3693
3691
|
* - This API is valid for audio file, not PCM data.
|
|
@@ -3700,7 +3698,7 @@ export declare class IMediaPlayer {
|
|
|
3700
3698
|
* @param speed The ratio of the actual playback speed than that of the original speed of the audio file in \%. The range is `[50,200]`. The default value is 100.
|
|
3701
3699
|
* @return
|
|
3702
3700
|
* - 0: Success.
|
|
3703
|
-
* - < 0 : Fail. See
|
|
3701
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3704
3702
|
* @note
|
|
3705
3703
|
* - Call this API only when audio is mixing.
|
|
3706
3704
|
* - The API is valid for audio file and not PCM data.
|
|
@@ -3709,13 +3707,13 @@ export declare class IMediaPlayer {
|
|
|
3709
3707
|
setPlaybackSpeed(speed: number): number;
|
|
3710
3708
|
/** {en}
|
|
3711
3709
|
* @detail api
|
|
3712
|
-
* @brief Set the interval of the periodic callback
|
|
3710
|
+
* @brief Set the interval of the periodic callback {@link onMediaPlayerPlayingProgress onMediaPlayerPlayingProgress} during audio mixing.
|
|
3713
3711
|
* @param interval interval in ms. <br>
|
|
3714
3712
|
* - interval > 0: The callback is enabled. The actual interval is `10*(mod(10)+1)`.
|
|
3715
3713
|
* - interval <= 0: The callback is disabled.
|
|
3716
3714
|
* @return
|
|
3717
3715
|
* - 0: Success.
|
|
3718
|
-
* - < 0 : Fail. See
|
|
3716
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3719
3717
|
* @note
|
|
3720
3718
|
* - Call this API only when audio is mixing.
|
|
3721
3719
|
* - This API is valid for audio file, not PCM data.
|
|
@@ -3724,12 +3722,12 @@ export declare class IMediaPlayer {
|
|
|
3724
3722
|
setProgressInterval(interval: number): number;
|
|
3725
3723
|
/** {en}
|
|
3726
3724
|
* @detail api
|
|
3727
|
-
* @brief To call
|
|
3725
|
+
* @brief To call {@link enableVocalInstrumentBalance enableVocalInstrumentBalance} to adjust the volume of the mixed media file or the PCM audio data, you must pass in its original loudness through this API.
|
|
3728
3726
|
* @param loudness Original loudness in lufs. The range is `[-70.0, 0.0]`. <br>
|
|
3729
3727
|
* When the value is less than -70.0lufs, it will be adjusted to -70.0lufs by default, and if it is more than 0.0lufs, the loudness will not be equalized. The default value is 1.0lufs, which means no processing.
|
|
3730
3728
|
* @return
|
|
3731
3729
|
* - 0: Success.
|
|
3732
|
-
* - < 0 : Fail. See
|
|
3730
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3733
3731
|
* @note
|
|
3734
3732
|
* - Call this API only when audio is mixing.
|
|
3735
3733
|
* - The API is valid for audio file and PCM data.
|
|
@@ -3739,26 +3737,25 @@ export declare class IMediaPlayer {
|
|
|
3739
3737
|
/** {en}
|
|
3740
3738
|
* @detail api
|
|
3741
3739
|
* @brief Register an observer to receive related callbacks when the local media file is mixing.
|
|
3742
|
-
* @param observer See
|
|
3740
|
+
* @param observer See {@link IMediaPlayerAudioFrameObserver IMediaPlayerAudioFrameObserver}.
|
|
3743
3741
|
* @return
|
|
3744
3742
|
* - 0: Success.
|
|
3745
|
-
* - < 0 : Fail. See
|
|
3746
|
-
* @note
|
|
3747
|
-
* The API is valid for audio file, not PCM data.
|
|
3743
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3744
|
+
* @note The API is valid for audio file, not PCM data.
|
|
3748
3745
|
*
|
|
3749
3746
|
*/
|
|
3750
3747
|
registerAudioFrameObserver(observer: IMediaPlayerAudioFrameObserver): number;
|
|
3751
3748
|
/** {en}
|
|
3752
3749
|
* @detail api
|
|
3753
3750
|
* @brief Push PCM audio frame data for mixing.
|
|
3754
|
-
* @param audioFrame See
|
|
3751
|
+
* @param audioFrame See {@link AudioFrame AudioFrame}. <br>
|
|
3755
3752
|
* - The audio sampling format must be S16. The data format within the audio buffer must be PCM, and its capacity size should be `audioFrame.samples × audioFrame.channel × 2`.
|
|
3756
3753
|
* - A specific sample rate and the number of channels must be specified. Setting them to automatic is not supported.
|
|
3757
3754
|
* @return
|
|
3758
3755
|
* - 0: Success.
|
|
3759
3756
|
* - < 0: Failed.
|
|
3760
3757
|
* @note
|
|
3761
|
-
* - Before calling this method, the raw audio data mixing must be enabled through
|
|
3758
|
+
* - Before calling this method, the raw audio data mixing must be enabled through {@link openWithCustomSource openWithCustomSource}.
|
|
3762
3759
|
* - Suggestions: Before pushing data for the first time, please cache a certain amount of data (like 200 ms) on the application side, and then push it at once. Schedule subsequent push operation every 10 ms with audio data of 10 ms.
|
|
3763
3760
|
* - To pause the playback, just pause the push.
|
|
3764
3761
|
*
|
|
@@ -3767,7 +3764,7 @@ export declare class IMediaPlayer {
|
|
|
3767
3764
|
/** {en}
|
|
3768
3765
|
* @detail api
|
|
3769
3766
|
* @brief Set the event handler.
|
|
3770
|
-
* @param handler See
|
|
3767
|
+
* @param handler See {@link IMediaPlayerEventHandler IMediaPlayerEventHandler}.
|
|
3771
3768
|
* @return
|
|
3772
3769
|
* - 0: Success.
|
|
3773
3770
|
* - < 0: Failed.
|
|
@@ -3784,7 +3781,7 @@ export declare class IAudioEffectPlayer {
|
|
|
3784
3781
|
* @brief Starts to play the audio effect file. <br>
|
|
3785
3782
|
* This API can be called multiple times with different IDs and filepaths for multiple effects at the same time.
|
|
3786
3783
|
* @param effectId Audio effect ID. Used for identifying the audio effect, please ensure that the audio effect ID is unique. <br>
|
|
3787
|
-
* If this API is called repeatedly with the same ID, the previous effect will stop and the next effect will start, and you'll receive
|
|
3784
|
+
* If this API is called repeatedly with the same ID, the previous effect will stop and the next effect will start, and you'll receive {@link onAudioEffectPlayerStateChanged onAudioEffectPlayerStateChanged}.
|
|
3788
3785
|
* @param filePath Audio effect file paths. <br>
|
|
3789
3786
|
* URL of online file, URI of local file, full path to local file, or path to local file starting with `/assets/` are supported. For URL of online file, only the https protocol is supported. <br>
|
|
3790
3787
|
* Recommended sample rate for audio effect files: 8KHz、16KHz、22.05KHz、44.1KHz、48KHz. <br>
|
|
@@ -3802,13 +3799,13 @@ export declare class IAudioEffectPlayer {
|
|
|
3802
3799
|
* <tr><td>iOS/macOS</td><td>Y</td><td></td><td>Y</td><td>Y</td><td></td><td>Y</td><td></td><td></td><td></td></tr>
|
|
3803
3800
|
* <tr><td>Windows</td><td>Y</td><td></td><td>Y</td><td>Y</td><td>Y</td><td>Y</td><td></td><td>Y</td><td>Y</td></tr>
|
|
3804
3801
|
* </table>
|
|
3805
|
-
* @param config See
|
|
3802
|
+
* @param config See {@link AudioEffectPlayerConfig AudioEffectPlayerConfig}.
|
|
3806
3803
|
* @return
|
|
3807
3804
|
* - 0: Success.
|
|
3808
|
-
* - < 0 : Fail. See
|
|
3805
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3809
3806
|
* @note
|
|
3810
|
-
* - If the file has been loaded into memory via
|
|
3811
|
-
* - After starting to play an audio effect file, you can call the
|
|
3807
|
+
* - If the file has been loaded into memory via {@link preload preload}, make sure that the ID here is the same as the ID set by {@link preload preload}.
|
|
3808
|
+
* - After starting to play an audio effect file, you can call the {@link stop stop} API to stop playing the audio effect file.
|
|
3812
3809
|
*
|
|
3813
3810
|
*/
|
|
3814
3811
|
start(effectId: number, filePath: string, config: AudioEffectPlayerConfig): number;
|
|
@@ -3818,9 +3815,9 @@ export declare class IAudioEffectPlayer {
|
|
|
3818
3815
|
* @param effectId Audio effect ID
|
|
3819
3816
|
* @return
|
|
3820
3817
|
* - 0: Success.
|
|
3821
|
-
* - < 0 : Fail. See
|
|
3818
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3822
3819
|
* @note
|
|
3823
|
-
* - After calling the
|
|
3820
|
+
* - After calling the {@link start start} API to start playing the audio effect file, you can call this API to stop playing the audio effect file.
|
|
3824
3821
|
* - After calling this API to stop playing an audio effect file, the audio effect file will be unloaded automatically.
|
|
3825
3822
|
*
|
|
3826
3823
|
*/
|
|
@@ -3830,9 +3827,9 @@ export declare class IAudioEffectPlayer {
|
|
|
3830
3827
|
* @brief Stops playback of all audio effect files.
|
|
3831
3828
|
* @return
|
|
3832
3829
|
* - 0: Success.
|
|
3833
|
-
* - < 0 : Fail. See
|
|
3830
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3834
3831
|
* @note
|
|
3835
|
-
* - After calling
|
|
3832
|
+
* - After calling {@link start start} to start playing audio effect files, you can call this API to stop playing all audio effect files.
|
|
3836
3833
|
* - After calling this API to stop playing all audio effect files, the audio effect files will be unloaded automatically.
|
|
3837
3834
|
*
|
|
3838
3835
|
*/
|
|
@@ -3842,17 +3839,17 @@ export declare class IAudioEffectPlayer {
|
|
|
3842
3839
|
* @brief Preloads specified music files into memory to avoid repeated loading when playing the same file frequently and reduce CPU usage.
|
|
3843
3840
|
* @param effectId Audio effect ID。Used for identifying the audio effect. Please ensure that the audio effect ID is unique. <br>
|
|
3844
3841
|
* If this API is called repeatedly with the same ID, the later one will overwrite the previous one. <br>
|
|
3845
|
-
* If you call
|
|
3846
|
-
* After calling this API to preload A.mp3, if you need to call
|
|
3842
|
+
* If you call {@link start start} first and then call this API with the same ID, the SDK will stop the previous effect and then load the next one, and you will receive {@link onAudioEffectPlayerStateChanged onAudioEffectPlayerStateChanged}. <br>
|
|
3843
|
+
* After calling this API to preload A.mp3, if you need to call {@link start start} to play B.mp3 with the same ID, please call {@link unload unload} to unload A.mp3 first, otherwise SDK will report an error AUDIO_MIXING_ERROR_LOAD_CONFLICT.
|
|
3847
3844
|
* @param filePath The filepath of effect file. URI of local file, full path to local file, or path to local files starting with `/assets/` are supported. <br>
|
|
3848
3845
|
* The length of the pre-loaded file must not exceed 20s. <br>
|
|
3849
|
-
* Audio effect file formats supported are the same as
|
|
3846
|
+
* Audio effect file formats supported are the same as {@link start start}.
|
|
3850
3847
|
* @return
|
|
3851
3848
|
* - 0: Success.
|
|
3852
|
-
* - < 0 : Fail. See
|
|
3849
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3853
3850
|
* @note
|
|
3854
|
-
* - This API just preloads the specified audio effect file, and only calls the
|
|
3855
|
-
* - The specified audio effect file preloaded by calling this API can be unloaded by
|
|
3851
|
+
* - This API just preloads the specified audio effect file, and only calls the {@link start start} API to start playing the specified audio effect file.
|
|
3852
|
+
* - The specified audio effect file preloaded by calling this API can be unloaded by {@link unload unload}.
|
|
3856
3853
|
*
|
|
3857
3854
|
*/
|
|
3858
3855
|
preload(effectId: number, filePath: string): number;
|
|
@@ -3862,8 +3859,8 @@ export declare class IAudioEffectPlayer {
|
|
|
3862
3859
|
* @param effectId Audio effect ID
|
|
3863
3860
|
* @return
|
|
3864
3861
|
* - 0: Success.
|
|
3865
|
-
* - < 0 : Fail. See
|
|
3866
|
-
* @note Call this API after
|
|
3862
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3863
|
+
* @note Call this API after {@link start start} or {@link preload preload}.
|
|
3867
3864
|
*
|
|
3868
3865
|
*/
|
|
3869
3866
|
unload(effectId: number): number;
|
|
@@ -3872,7 +3869,7 @@ export declare class IAudioEffectPlayer {
|
|
|
3872
3869
|
* @brief Unloads all audio effect files.
|
|
3873
3870
|
* @return
|
|
3874
3871
|
* - 0: Success.
|
|
3875
|
-
* - < 0 : Fail. See
|
|
3872
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3876
3873
|
*
|
|
3877
3874
|
*/
|
|
3878
3875
|
unloadAll(): number;
|
|
@@ -3882,10 +3879,10 @@ export declare class IAudioEffectPlayer {
|
|
|
3882
3879
|
* @param effectId Audio effect ID
|
|
3883
3880
|
* @return
|
|
3884
3881
|
* - 0: Success.
|
|
3885
|
-
* - < 0 : Fail. See
|
|
3882
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3886
3883
|
* @note
|
|
3887
|
-
* - After calling the
|
|
3888
|
-
* - After calling this API to pause the audio effect file, you can call the
|
|
3884
|
+
* - After calling the {@link start start} API to start playing the audio effect file, you can pause the audio effect file by calling this API.
|
|
3885
|
+
* - After calling this API to pause the audio effect file, you can call the {@link resume resume} API to resume playback.
|
|
3889
3886
|
*
|
|
3890
3887
|
*/
|
|
3891
3888
|
pause(effectId: number): number;
|
|
@@ -3894,10 +3891,10 @@ export declare class IAudioEffectPlayer {
|
|
|
3894
3891
|
* @brief Pauses the Playback of all audio effect files.
|
|
3895
3892
|
* @return
|
|
3896
3893
|
* - 0: Success.
|
|
3897
|
-
* - < 0 : Fail. See
|
|
3894
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3898
3895
|
* @note
|
|
3899
|
-
* - After calling the
|
|
3900
|
-
* - After calling this API to pause the playback of all audio effect files, you can call the
|
|
3896
|
+
* - After calling the {@link start start} API to start playing audio effect files, you can pause playing all audio effect files by calling this API.
|
|
3897
|
+
* - After calling this API to pause the playback of all audio effect files, you can call the {@link resumeAll resumeAll} API to resume all playback.
|
|
3901
3898
|
*
|
|
3902
3899
|
*/
|
|
3903
3900
|
pauseAll(): number;
|
|
@@ -3907,8 +3904,8 @@ export declare class IAudioEffectPlayer {
|
|
|
3907
3904
|
* @param effectId Audio effect ID
|
|
3908
3905
|
* @return
|
|
3909
3906
|
* - 0: Success.
|
|
3910
|
-
* - < 0 : Fail. See
|
|
3911
|
-
* @note After calling the
|
|
3907
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3908
|
+
* @note After calling the {@link pause pause} API to pause the audio effect file, you can resume playback by calling this API.
|
|
3912
3909
|
*
|
|
3913
3910
|
*/
|
|
3914
3911
|
resume(effectId: number): number;
|
|
@@ -3917,8 +3914,8 @@ export declare class IAudioEffectPlayer {
|
|
|
3917
3914
|
* @brief Resumes the playback of all audio effect files.
|
|
3918
3915
|
* @return
|
|
3919
3916
|
* - 0: Success.
|
|
3920
|
-
* - < 0 : Fail. See
|
|
3921
|
-
* @note After calling the
|
|
3917
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3918
|
+
* @note After calling the {@link pauseAll pauseAll} API to pause all the audio effect files being played, you can resume playback by calling this API.
|
|
3922
3919
|
*
|
|
3923
3920
|
*/
|
|
3924
3921
|
resumeAll(): number;
|
|
@@ -3927,13 +3924,13 @@ export declare class IAudioEffectPlayer {
|
|
|
3927
3924
|
* @brief Sets the start position of the audio effect file.
|
|
3928
3925
|
* @param effectId Audio effect ID
|
|
3929
3926
|
* @param position The starting playback position of the audio effect file in milliseconds. <br>
|
|
3930
|
-
* You can get the total duration of the audio effect file by calling
|
|
3927
|
+
* You can get the total duration of the audio effect file by calling {@link getDuration getDuration}, the value of position should be less than the total duration of the audio effect file.
|
|
3931
3928
|
* @return
|
|
3932
3929
|
* - 0: Success.
|
|
3933
|
-
* - < 0 : Fail. See
|
|
3930
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3934
3931
|
* @note
|
|
3935
3932
|
* - When playing online files, calling this API may cause a delay in playback.
|
|
3936
|
-
* - Call this API after
|
|
3933
|
+
* - Call this API after {@link start start}.
|
|
3937
3934
|
*
|
|
3938
3935
|
*/
|
|
3939
3936
|
setPosition(effectId: number, position: number): number;
|
|
@@ -3946,7 +3943,7 @@ export declare class IAudioEffectPlayer {
|
|
|
3946
3943
|
* - < 0: Failure.
|
|
3947
3944
|
* @note
|
|
3948
3945
|
* - When playing online files, calling this API may cause a delay in playback.
|
|
3949
|
-
* - Call this API after
|
|
3946
|
+
* - Call this API after {@link start start}.
|
|
3950
3947
|
*
|
|
3951
3948
|
*/
|
|
3952
3949
|
getPosition(effectId: number): number;
|
|
@@ -3957,8 +3954,8 @@ export declare class IAudioEffectPlayer {
|
|
|
3957
3954
|
* @param volume The ratio of the volume to the original volume in \% with overflow protection. The range is `[0, 400]` and the recommended range is `[0, 100]`.
|
|
3958
3955
|
* @return
|
|
3959
3956
|
* - 0: Success.
|
|
3960
|
-
* - < 0 : Fail. See
|
|
3961
|
-
* @note Call this API after
|
|
3957
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3958
|
+
* @note Call this API after {@link start start}.
|
|
3962
3959
|
*
|
|
3963
3960
|
*/
|
|
3964
3961
|
setVolume(effectId: number, volume: number): number;
|
|
@@ -3968,8 +3965,8 @@ export declare class IAudioEffectPlayer {
|
|
|
3968
3965
|
* @param volume The ratio of the volume to the original volume in \% with overflow protection. The range is `[0, 400]` and the recommended range is `[0, 100]`.
|
|
3969
3966
|
* @return
|
|
3970
3967
|
* - 0: Success.
|
|
3971
|
-
* - < 0 : Fail. See
|
|
3972
|
-
* @note This API has a lower priority than
|
|
3968
|
+
* - < 0 : Fail. See {@link ReturnStatus ReturnStatus} for more details.
|
|
3969
|
+
* @note This API has a lower priority than {@link setVolume setVolume}, i.e. the volume of the audio effect set by {@link setVolume setVolume} is not affected by this API.
|
|
3973
3970
|
*
|
|
3974
3971
|
*/
|
|
3975
3972
|
setVolumeAll(volume: number): number;
|
|
@@ -3980,7 +3977,7 @@ export declare class IAudioEffectPlayer {
|
|
|
3980
3977
|
* @return
|
|
3981
3978
|
* - >0: Success, the current volume value.
|
|
3982
3979
|
* - < 0: Failed.
|
|
3983
|
-
* @note Call this API after
|
|
3980
|
+
* @note Call this API after {@link start start}.
|
|
3984
3981
|
*
|
|
3985
3982
|
*/
|
|
3986
3983
|
getVolume(effectId: number): number;
|
|
@@ -3991,14 +3988,14 @@ export declare class IAudioEffectPlayer {
|
|
|
3991
3988
|
* @return
|
|
3992
3989
|
* - >0: Success, the duration of the audio effect file in milliseconds.
|
|
3993
3990
|
* - < 0: failed.
|
|
3994
|
-
* @note Call this API after
|
|
3991
|
+
* @note Call this API after {@link start start}.
|
|
3995
3992
|
*
|
|
3996
3993
|
*/
|
|
3997
3994
|
getDuration(effectId: number): number;
|
|
3998
3995
|
/** {en}
|
|
3999
3996
|
* @detail api
|
|
4000
3997
|
* @brief Set the event handler.
|
|
4001
|
-
* @param handler See
|
|
3998
|
+
* @param handler See {@link IAudioEffectPlayerEventHandler IAudioEffectPlayerEventHandler}.
|
|
4002
3999
|
* @return
|
|
4003
4000
|
* - 0: Success.
|
|
4004
4001
|
* - < 0: Failed.
|