@byteplus/react-native-live-pull 1.3.0 → 1.3.2-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/android/build.gradle +1 -1
- package/package.json +3 -3
- package/react-native-velive-pull.podspec +10 -3
- package/lib/commonjs/index.js +0 -14555
- package/lib/module/index.js +0 -14543
- package/lib/typescript/codegen/android/api.d.ts +0 -318
- package/lib/typescript/codegen/android/callback.d.ts +0 -206
- package/lib/typescript/codegen/android/errorcode.d.ts +0 -174
- package/lib/typescript/codegen/android/external.d.ts +0 -1
- package/lib/typescript/codegen/android/index.d.ts +0 -6
- package/lib/typescript/codegen/android/keytype.d.ts +0 -749
- package/lib/typescript/codegen/android/types.d.ts +0 -31
- package/lib/typescript/codegen/ios/api.d.ts +0 -295
- package/lib/typescript/codegen/ios/callback.d.ts +0 -176
- package/lib/typescript/codegen/ios/errorcode.d.ts +0 -160
- package/lib/typescript/codegen/ios/external.d.ts +0 -1
- package/lib/typescript/codegen/ios/index.d.ts +0 -6
- package/lib/typescript/codegen/ios/keytype.d.ts +0 -695
- package/lib/typescript/codegen/ios/types.d.ts +0 -46
- package/lib/typescript/codegen/pack/api.d.ts +0 -367
- package/lib/typescript/codegen/pack/callback.d.ts +0 -255
- package/lib/typescript/codegen/pack/errorcode.d.ts +0 -187
- package/lib/typescript/codegen/pack/external.d.ts +0 -1
- package/lib/typescript/codegen/pack/index.d.ts +0 -6
- package/lib/typescript/codegen/pack/keytype.d.ts +0 -909
- package/lib/typescript/codegen/pack/types.d.ts +0 -68
- package/lib/typescript/component.d.ts +0 -15
- package/lib/typescript/core/api.d.ts +0 -114
- package/lib/typescript/core/appState.d.ts +0 -3
- package/lib/typescript/core/callback.d.ts +0 -53
- package/lib/typescript/core/env.d.ts +0 -38
- package/lib/typescript/core/errorcode.d.ts +0 -1
- package/lib/typescript/core/index.d.ts +0 -6
- package/lib/typescript/core/keytype.d.ts +0 -33
- package/lib/typescript/core/player.d.ts +0 -16
- package/lib/typescript/index.d.ts +0 -3
- package/lib/typescript/platforms/android/extends.d.ts +0 -39
- package/lib/typescript/platforms/android/pictureInpicture.d.ts +0 -26
- package/lib/typescript/platforms/ios/extends.d.ts +0 -43
- package/lib/typescript/platforms/ios/pictureInpicture.d.ts +0 -32
- package/lib/typescript/runtime/index.d.ts +0 -1
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
export type String = string;
|
|
2
|
-
export type Boolean = boolean;
|
|
3
|
-
export type Void = void;
|
|
4
|
-
export type int = number;
|
|
5
|
-
export type float = number;
|
|
6
|
-
export type double = number;
|
|
7
|
-
export type long = number;
|
|
8
|
-
export type Integer = number;
|
|
9
|
-
export type Double = number;
|
|
10
|
-
export type List<T = any> = Array<T>;
|
|
11
|
-
export type list<T = any> = Array<T>;
|
|
12
|
-
export type ArrayList<T = any> = Array<T>;
|
|
13
|
-
export type Map<K extends keyof any = any, V = any> = Record<K, V>;
|
|
14
|
-
export type HashMap<K extends keyof any = any, V = any> = Record<K, V>;
|
|
15
|
-
export type Pair<K extends keyof any = any, V = any> = Record<K, V>;
|
|
16
|
-
export type set<T = any> = Set<T>;
|
|
17
|
-
export type map = Object;
|
|
18
|
-
export type struct = Object;
|
|
19
|
-
export type Bitmap = unknown;
|
|
20
|
-
export type EGLContext = unknown;
|
|
21
|
-
export type ByteArray = number;
|
|
22
|
-
export type ByteBuffer = ArrayBuffer;
|
|
23
|
-
export type Matrix = unknown;
|
|
24
|
-
export type SurfaceHolder = unknown;
|
|
25
|
-
export type Surface = unknown;
|
|
26
|
-
export type Runnable = unknown;
|
|
27
|
-
export type View = unknown;
|
|
28
|
-
export type Intent = unknown;
|
|
29
|
-
export type Context = unknown;
|
|
30
|
-
export type Bundle = any;
|
|
31
|
-
export type JSONObject = any;
|
|
@@ -1,295 +0,0 @@
|
|
|
1
|
-
import { VeLivePlayerLogLevel, VeLivePlayerType, VeLivePlayerConfiguration, VeLivePlayerFillMode, VeLivePlayerStreamData, VeLivePlayerResolution, VeLivePlayerRotation, VeLivePlayerMirror, VeLivePlayerPixelFormat, VeLivePlayerVideoBufferType } from './keytype';
|
|
2
|
-
import { NSString, id, float, BOOL, NSDictionary, int } from './types';
|
|
3
|
-
import { VeLivePlayerObserver } from './callback';
|
|
4
|
-
import { UIView } from './external';
|
|
5
|
-
export declare class TVLManager {
|
|
6
|
-
|
|
7
|
-
/** {en}
|
|
8
|
-
* @detail api
|
|
9
|
-
* @brief Sets the level of the output log.
|
|
10
|
-
* @param logLevel The level of the output log. For details, see VeLivePlayerLogLevel{@link #VeLivePlayerLogLevel}.
|
|
11
|
-
* @order 5
|
|
12
|
-
*/
|
|
13
|
-
static setLogLevel(logLevel: VeLivePlayerLogLevel): void;
|
|
14
|
-
|
|
15
|
-
/** {en}
|
|
16
|
-
* @detail api
|
|
17
|
-
* @brief Gets the version number of the Player SDK.
|
|
18
|
-
* @return <br>
|
|
19
|
-
* The version number of the Player SDK.
|
|
20
|
-
* @order 4
|
|
21
|
-
*/
|
|
22
|
-
static getVersion(): NSString;
|
|
23
|
-
|
|
24
|
-
/** {en}
|
|
25
|
-
* @detail keytype
|
|
26
|
-
* @brief The player observer.
|
|
27
|
-
*/
|
|
28
|
-
observer: id<VeLivePlayerObserver>;
|
|
29
|
-
|
|
30
|
-
/** {en}
|
|
31
|
-
* @detail keytype
|
|
32
|
-
* @brief The view used by the player to render video. Add `playerView` to the view hierarchy of your app to display the video content.
|
|
33
|
-
*/
|
|
34
|
-
playerView: UIView;
|
|
35
|
-
|
|
36
|
-
/** {en}
|
|
37
|
-
* @detail keytype
|
|
38
|
-
* @brief The player volume. The default value is `1.0`. The value range is [0.0, 1.0].
|
|
39
|
-
*/
|
|
40
|
-
volume: float;
|
|
41
|
-
|
|
42
|
-
/** {en}
|
|
43
|
-
* @detail keytype
|
|
44
|
-
* @brief Checks whether the player is playing.
|
|
45
|
-
* @return Whether the player is playing. <br>
|
|
46
|
-
* - YES: The player is playing;
|
|
47
|
-
* - NO: The player is not playing.
|
|
48
|
-
*/
|
|
49
|
-
isPlaying: BOOL;
|
|
50
|
-
|
|
51
|
-
/** {en}
|
|
52
|
-
* @detail api
|
|
53
|
-
* @brief Initializes the player.
|
|
54
|
-
* @order 9
|
|
55
|
-
*/
|
|
56
|
-
init(): this;
|
|
57
|
-
|
|
58
|
-
/** {en}
|
|
59
|
-
* @brief Initializes the specified type of player.
|
|
60
|
-
* @param type The player type. Refer to [VeLivePlayerType](docs-player-sdk-for-ios-type-definition#VeLivePlayerType) for details.
|
|
61
|
-
*/
|
|
62
|
-
initWithType(type: VeLivePlayerType): this;
|
|
63
|
-
|
|
64
|
-
/** {en}
|
|
65
|
-
* @detail api
|
|
66
|
-
* @brief Configures player settings, including whether to turn on SEI messaging, hardware decoding, and local DNS prefetch.
|
|
67
|
-
* @notes <br>
|
|
68
|
-
* Call this method before calling play{@link #VeLivePlayer#play}.
|
|
69
|
-
* @param config Player configurations. Refer to VeLivePlayerConfiguration{@link #VeLivePlayerConfiguration} for details.
|
|
70
|
-
* @order 1
|
|
71
|
-
*/
|
|
72
|
-
setConfig(config: VeLivePlayerConfiguration): void;
|
|
73
|
-
|
|
74
|
-
/** {en}
|
|
75
|
-
* @detail api
|
|
76
|
-
* @brief Sets the player observer to listen to the VeLivePlayer's events, such as playback errors or status updates, rendering of the first audio and video frame, and resolution switching.
|
|
77
|
-
* @notes <br>
|
|
78
|
-
* Call this method before calling play{@link #VeLivePlayer#play}.
|
|
79
|
-
* @param observer The player observer. See VeLivePlayerObserver{@link #VeLivePlayerObserver} for details.
|
|
80
|
-
* @order 2
|
|
81
|
-
*/
|
|
82
|
-
setObserver(observer: id<VeLivePlayerObserver>): void;
|
|
83
|
-
|
|
84
|
-
/** {en}
|
|
85
|
-
* @detail api
|
|
86
|
-
* @brief Sets the fill mode of the player screen.
|
|
87
|
-
* @notes
|
|
88
|
-
* - Call this method before calling [play](#TVLManager(VeLivePlayer)-play) to set the initial fill mode of the player.
|
|
89
|
-
* - You can call this method during playback to dynamically adjust the fill mode.
|
|
90
|
-
* @order 3
|
|
91
|
-
* @param fillMode The fill mode of SurfaceView. The default value is `VeLivePlayerFillModeAspectFill`. See VeLivePlayerFillMode{@link #VeLivePlayerFillMode} for details.
|
|
92
|
-
*/
|
|
93
|
-
setRenderFillMode(fillMode: VeLivePlayerFillMode): Promise<void>;
|
|
94
|
-
|
|
95
|
-
/** {en}
|
|
96
|
-
* @detail api
|
|
97
|
-
* @brief Sets a pull stream address.
|
|
98
|
-
* @notes
|
|
99
|
-
* Call this method before calling [play](#TVLManager(VeLivePlayer)-play).
|
|
100
|
-
* @order 6
|
|
101
|
-
* @param url The pull stream address.
|
|
102
|
-
*/
|
|
103
|
-
setPlayUrl(url: NSString): void;
|
|
104
|
-
|
|
105
|
-
/** {en}
|
|
106
|
-
* @detail api
|
|
107
|
-
* @brief Sets the mapping of domain names to server IP addresses.
|
|
108
|
-
* @param hostIpMap The mapping of domain names to server IP addresses. The `Map` object uses the domain name as the key, and the corresponding value is a list of IP addresses for the servers associated with that domain. The value is of the `List` type.
|
|
109
|
-
* @order 17
|
|
110
|
-
*/
|
|
111
|
-
setUrlHostIP(hostIpMap: NSDictionary): void;
|
|
112
|
-
|
|
113
|
-
/** {en}
|
|
114
|
-
* @detail api
|
|
115
|
-
* @brief Configures advanced settings for the player, including offscreen rendering, maximum buffer duration, and adaptive bitrate (ABR) algorithms. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if you need further information.
|
|
116
|
-
* @param key The parameter name of the advanced setting.
|
|
117
|
-
* @param value The parameter value of the advanced setting.
|
|
118
|
-
* @order 18
|
|
119
|
-
*/
|
|
120
|
-
setProperty(key: NSString, value: id): void;
|
|
121
|
-
|
|
122
|
-
/** {en}
|
|
123
|
-
* @detail api
|
|
124
|
-
* @brief Sets multiple live streams. Call this method if you need to enable features requiring multiple live streams, such as adaptive bitrate (ABR), manual resolution switching, and primary and backup streams.
|
|
125
|
-
* @param streamData Configurations for multiple pull stream addresses. See VeLivePlayerStreamData{@link #VeLivePlayerStreamData} for details.
|
|
126
|
-
* @notes <br>
|
|
127
|
-
* Call this method before calling play{@link #VeLivePlayer#play}.
|
|
128
|
-
* @order 7
|
|
129
|
-
*/
|
|
130
|
-
setPlayStreamData(streamData: VeLivePlayerStreamData): void;
|
|
131
|
-
|
|
132
|
-
/** {en}
|
|
133
|
-
* @detail api
|
|
134
|
-
* @brief Starts or resumes playback.
|
|
135
|
-
* @notes
|
|
136
|
-
* After you call this method, the [onPlayerStatusUpdate:status:](docs-player-sdk-for-ios-callback#VeLivePlayerObserver-onplayerstatusupdate-status) callback is triggered both when the player finishes preparing for stream pulling and when the first frame is rendered.
|
|
137
|
-
* @order 10
|
|
138
|
-
*/
|
|
139
|
-
play(): Promise<void>;
|
|
140
|
-
|
|
141
|
-
/** {en}
|
|
142
|
-
* @detail api
|
|
143
|
-
* @brief Pauses playback.
|
|
144
|
-
* @notes
|
|
145
|
-
* When playback is paused after you call this method, the [onPlayerStatusUpdate:status:](docs-player-sdk-for-ios-callback#VeLivePlayerObserver-onplayerstatusupdate-status) callback is triggered.
|
|
146
|
-
* @order 11
|
|
147
|
-
*/
|
|
148
|
-
pause(): Promise<void>;
|
|
149
|
-
|
|
150
|
-
/** {en}
|
|
151
|
-
* @detail api
|
|
152
|
-
* @brief Stops playback. This method does not destroy the player.
|
|
153
|
-
* @notes
|
|
154
|
-
* When playback stops after you call this method, the [onPlayerStatusUpdate:status:](docs-player-sdk-for-ios-callback#VeLivePlayerObserver-onplayerstatusupdate-status) callback is triggered.
|
|
155
|
-
* @order 12
|
|
156
|
-
*/
|
|
157
|
-
stop(): Promise<void>;
|
|
158
|
-
|
|
159
|
-
/** {en}
|
|
160
|
-
* @detail api
|
|
161
|
-
* @brief Stops playback and destroys the player.
|
|
162
|
-
* @order 13
|
|
163
|
-
*/
|
|
164
|
-
destroy(): void;
|
|
165
|
-
|
|
166
|
-
/** {en}
|
|
167
|
-
* @brief Check whether the player currently supports the specified resolution level.
|
|
168
|
-
* @param resolution Resolution levels. For details, please refer to [VeLivePlayerResolution](docs-player-sdk-for-ios-type-definition#VeLivePlayerResolution).
|
|
169
|
-
* @return - 0: Supported;
|
|
170
|
-
* - Others: Not supported. For details of other return values, please refer to [VeLivePlayerSupportResolutionSwitchError](docs-player-sdk-for-ios-type-definition#VeLivePlayerSupportResolutionSwitchError).
|
|
171
|
-
*/
|
|
172
|
-
isSupportResolutionSwitch(resolution: VeLivePlayerResolution): int;
|
|
173
|
-
|
|
174
|
-
/** {en}
|
|
175
|
-
* @detail api
|
|
176
|
-
* @brief Changes the video resolution.
|
|
177
|
-
* @notes
|
|
178
|
-
* - Call [setPlayStreamData:](#TVLManager(VeLivePlayer)-setplaystreamdata) to set multiple resolutions before calling this method.
|
|
179
|
-
* - Once the player switches to the new resolution after you call this method, the [onResolutionSwitch:resolution:error:reason:](docs-player-sdk-for-ios-callback#VeLivePlayerObserver-onresolutionswitch-resolution-error-reason) callback is triggered.
|
|
180
|
-
* @order 14
|
|
181
|
-
* @param resolution The video resolution. See VeLivePlayerResolution{@link #VeLivePlayerResolution} for details.
|
|
182
|
-
* @return <br>
|
|
183
|
-
* - YES: Success;
|
|
184
|
-
* - NO: Failure.
|
|
185
|
-
*/
|
|
186
|
-
switchResolution(resolution: VeLivePlayerResolution): void;
|
|
187
|
-
|
|
188
|
-
/** {en}
|
|
189
|
-
* @detail api
|
|
190
|
-
* @brief Sets whether to mute playback.
|
|
191
|
-
* @param mute Whether to mute playback. The default value is `NO`. <br>
|
|
192
|
-
* - YES: Mute;
|
|
193
|
-
* - NO: Do not mute.
|
|
194
|
-
* @order 15
|
|
195
|
-
*/
|
|
196
|
-
setMute(mute: BOOL): void;
|
|
197
|
-
|
|
198
|
-
/** {en}
|
|
199
|
-
* @detail api
|
|
200
|
-
* @brief Checks whether playback is muted.
|
|
201
|
-
* @return Whether playback is muted. <br>
|
|
202
|
-
* - YES: Muted;
|
|
203
|
-
* - NO: Not muted.
|
|
204
|
-
* @order 16
|
|
205
|
-
*/
|
|
206
|
-
isMute(): BOOL;
|
|
207
|
-
|
|
208
|
-
/** {en}
|
|
209
|
-
* @detail api
|
|
210
|
-
* @brief Sets the clockwise rotation angle of the video.
|
|
211
|
-
* @param rotation The clockwise rotation angle of the video. Rotation is disabled by default. See VeLivePlayerRotation{@link #VeLivePlayerRotation} for details.
|
|
212
|
-
* @notes <br>
|
|
213
|
-
* - You can change the rotation angle before and during playback.
|
|
214
|
-
* - Each time this method is called, the player rotates the video based on the original video.
|
|
215
|
-
* - When you apply both rotation and mirroring to the video, the player will mirror the video and then rotate it.
|
|
216
|
-
* @order 23
|
|
217
|
-
*/
|
|
218
|
-
setRenderRotation(rotation: VeLivePlayerRotation): Promise<void>;
|
|
219
|
-
|
|
220
|
-
/** {en}
|
|
221
|
-
* @detail api
|
|
222
|
-
* @brief Configures mirroring settings.
|
|
223
|
-
* @param mirror Mirroring settings. Mirroring is disabled by default. See VeLivePlayerMirror{@link #VeLivePlayerMirror} for details.
|
|
224
|
-
* @notes <br>
|
|
225
|
-
* - You can change the mirroring settings before and during playback.
|
|
226
|
-
* - Each time this method is called, the player applies the mirroring settings to the original video.
|
|
227
|
-
* - When you apply both rotation and mirroring to the video, the player will mirror the video and then rotate it.
|
|
228
|
-
* @order 24
|
|
229
|
-
*/
|
|
230
|
-
setRenderMirror(mirror: VeLivePlayerMirror): Promise<void>;
|
|
231
|
-
|
|
232
|
-
/** {en}
|
|
233
|
-
* @detail api
|
|
234
|
-
* @brief Takes a screenshot of the video.
|
|
235
|
-
* @notes
|
|
236
|
-
* - This method only takes effect during playback.
|
|
237
|
-
* - When a screenshot is captured after you call this method, the [onSnapshotComplete:image:](docs-player-sdk-for-ios-callback#VeLivePlayerObserver-onsnapshotcomplete-image) callback is triggered containing the `UIImage` object of the screenshot.
|
|
238
|
-
* @order 19
|
|
239
|
-
* @return
|
|
240
|
-
* - 0: Screenshot capturing is allowed;
|
|
241
|
-
* - VeLivePlayerErrorRefused{@link #VeLivePlayerErrorCode#VeLivePlayerErrorRefused}: Screenshot capturing is not allowed.
|
|
242
|
-
*/
|
|
243
|
-
snapshot(): int;
|
|
244
|
-
|
|
245
|
-
/** {en}
|
|
246
|
-
* @detail api
|
|
247
|
-
* @brief Sets the video frame observer.
|
|
248
|
-
* @notes
|
|
249
|
-
* - You can call this method to subscribe to decoded video data for external rendering.
|
|
250
|
-
* - After you call this method, the onRenderVideoFrame:videoFrame:is triggered once the SDK receives a video frame. The callback contains detailed information of the video frame.
|
|
251
|
-
* - If you use external rendering, you need to make sure the video and audio are synchronized.
|
|
252
|
-
* @order 20
|
|
253
|
-
* @param enable Whether to enable the video frame callback. The default value is `NO`. <br>
|
|
254
|
-
* - YES: Enable;
|
|
255
|
-
* - NO: Disable.
|
|
256
|
-
* @param pixelFormat The pixel format of the video frame in the callback. See VeLivePlayerPixelFormat{@link #VeLivePlayerPixelFormat} for details.
|
|
257
|
-
* @param bufferType The encapsulation format of the video data in the callback. See VeLivePlayerVideoBufferType{@link #VeLivePlayerVideoBufferType} for details.
|
|
258
|
-
*/
|
|
259
|
-
enableVideoFrameObserver(enable: BOOL, pixelFormat: VeLivePlayerPixelFormat, bufferType: VeLivePlayerVideoBufferType): void;
|
|
260
|
-
|
|
261
|
-
/** {en}
|
|
262
|
-
* @detail api
|
|
263
|
-
* @brief Sets the audio frame observer.
|
|
264
|
-
* @notes
|
|
265
|
-
* - You can call this method to subscribe to decoded audio data for external rendering.
|
|
266
|
-
* - After you call this method, the [onRenderAudioFrame:audioFrame:](docs-player-sdk-for-ios-callback#VeLivePlayerObserver-onrenderaudioframe-audioframe) callback is triggered once the SDK receives a audio frame. The callback contains detailed information of the audio frame.
|
|
267
|
-
* - If you use external rendering, you need to make sure the video and audio are synchronized.
|
|
268
|
-
* @order 21
|
|
269
|
-
* @param enable Whether to enable the audio frame callback. The default value is `NO`. <br>
|
|
270
|
-
* - YES: Enable;
|
|
271
|
-
* - NO: Disable.
|
|
272
|
-
* @param enableRendering Whether to enable player rendering. The default value is `NO`. <br>
|
|
273
|
-
* - YES: Enable;
|
|
274
|
-
* - NO: Disable.
|
|
275
|
-
*/
|
|
276
|
-
enableAudioFrameObserver(enable: BOOL, enableRendering: BOOL): void;
|
|
277
|
-
|
|
278
|
-
/** {en}
|
|
279
|
-
* @detail api
|
|
280
|
-
* @brief Enables or disables super resolution.
|
|
281
|
-
* @notes
|
|
282
|
-
* - Call this method after receiving the onFirstVideoFrameRender:isFirstFrame:callback, or during playback.
|
|
283
|
-
* - Support calling this method during playback to turn on or off super-resolution.
|
|
284
|
-
* - If the SDK fails to enable super resolution due to device model, video resolution or frame rate, you will receive the [onStreamFailedOpenSuperResolution:error:](docs-player-sdk-for-ios-callback#VeLivePlayerObserver-onstreamfailedopensuperresolution-error).
|
|
285
|
-
* @order 22
|
|
286
|
-
* @param enable Whether to enable super resolution. The default value is NO.
|
|
287
|
-
* - YES: Turn on;
|
|
288
|
-
* - NO: Turn off.
|
|
289
|
-
*/
|
|
290
|
-
setEnableSuperResolution(enable: BOOL): void;
|
|
291
|
-
setVolume(volume: float): void;
|
|
292
|
-
setEnableIgnoreAudioInterruption(enable: BOOL): void;
|
|
293
|
-
setAllowsVideoRendering(enable: BOOL): void;
|
|
294
|
-
addExtraHttpRequestHeadersByUser(headers: NSDictionary): void;
|
|
295
|
-
}
|
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
import { TVLManager } from './api';
|
|
2
|
-
import { VeLivePlayerError } from './errorcode';
|
|
3
|
-
import { BOOL, int64_t, int, NSString, NSData, UIImage } from './types';
|
|
4
|
-
import { VeLivePlayerResolution, VeLivePlayerResolutionSwitchReason, VeLivePlayerStreamType, VeLivePlayerStatus, VeLivePlayerStatistics, VeLivePlayerVideoFrame, VeLivePlayerAudioFrame } from './keytype';
|
|
5
|
-
export declare class VeLivePlayerObserver {
|
|
6
|
-
|
|
7
|
-
/** {en}
|
|
8
|
-
* @detail callback
|
|
9
|
-
* @brief Occurs when a player error occurs.
|
|
10
|
-
* @param player The player object that triggers the callback function.
|
|
11
|
-
* @param error The error message. See VeLivePlayerError{@link #VeLivePlayerError} for details.
|
|
12
|
-
* @order 1
|
|
13
|
-
*/
|
|
14
|
-
onError$error?(player: TVLManager, error: VeLivePlayerError): void;
|
|
15
|
-
|
|
16
|
-
/** {en}
|
|
17
|
-
* @detail callback
|
|
18
|
-
* @brief Occurs when the first video frame is rendered at the beginning of playback or after a retry during playback.
|
|
19
|
-
* @param player The player object that triggers the callback function.
|
|
20
|
-
* @param isFirstFrame Whether the video frame is the first video frame rendered at the beginning of playback. <br>
|
|
21
|
-
* - YES: The video frame is the first video frame rendered at the beginning of playback;
|
|
22
|
-
* - NO: The video frame is the first video frame rendered after a retry during playback.
|
|
23
|
-
* @order 2
|
|
24
|
-
*/
|
|
25
|
-
onFirstVideoFrameRender$isFirstFrame?(player: TVLManager, isFirstFrame: BOOL): void;
|
|
26
|
-
|
|
27
|
-
/** {en}
|
|
28
|
-
* @detail callback
|
|
29
|
-
* @brief Occurs when the first audio frame is rendered at the beginning of playback or after a retry during playback.
|
|
30
|
-
* @param player The player object that triggers the callback function.
|
|
31
|
-
* @param isFirstFrame Whether the audio frame is the first audio frame rendered at the beginning of playback. <br>
|
|
32
|
-
* - YES: The audio frame is the first audio frame rendered at the beginning of playback;
|
|
33
|
-
* - NO: The audio frame is the first audio frame rendered after a retry during playback.
|
|
34
|
-
*/
|
|
35
|
-
onFirstAudioFrameRender$isFirstFrame?(player: TVLManager, isFirstFrame: BOOL): void;
|
|
36
|
-
|
|
37
|
-
/** {en}
|
|
38
|
-
* @detail callback
|
|
39
|
-
* @brief Occurs when a playback stutter starts.
|
|
40
|
-
* @param player The player object that triggers the callback function.
|
|
41
|
-
* @order 3
|
|
42
|
-
*
|
|
43
|
-
*/
|
|
44
|
-
onStallStart?(player: TVLManager): void;
|
|
45
|
-
|
|
46
|
-
/** {en}
|
|
47
|
-
* @detail callback
|
|
48
|
-
* @brief Occurs when a playback stutter stops, that is, when playback resumes after there is enough audio buffer.
|
|
49
|
-
* @param player The player object that triggers the callback function.
|
|
50
|
-
* @order 4
|
|
51
|
-
*/
|
|
52
|
-
onStallEnd?(player: TVLManager): void;
|
|
53
|
-
|
|
54
|
-
/** {en}
|
|
55
|
-
* @detail callback
|
|
56
|
-
* @brief Occurs when video rendering stutters.
|
|
57
|
-
* @param player The player object that triggers the callback function.
|
|
58
|
-
* @param stallTime The stutter duration, in milliseconds.
|
|
59
|
-
*/
|
|
60
|
-
onVideoRenderStall$stallTime?(player: TVLManager, stallTime: int64_t): void;
|
|
61
|
-
|
|
62
|
-
/** {en}
|
|
63
|
-
* @detail callback
|
|
64
|
-
* @brief Occurs when audio rendering stutters.
|
|
65
|
-
* @param player The player object that triggers the callback function.
|
|
66
|
-
* @param stallTime The stutter duration, in milliseconds.
|
|
67
|
-
*/
|
|
68
|
-
onAudioRenderStall$stallTime?(player: TVLManager, stallTime: int64_t): void;
|
|
69
|
-
|
|
70
|
-
/** {en}
|
|
71
|
-
* @detail callback
|
|
72
|
-
* @brief Occurs when the video resolution changes.
|
|
73
|
-
* @param player The player object that triggers the callback function.
|
|
74
|
-
* @param resolution The updated resolution. See VeLivePlayerResolution{@link #VeLivePlayerResolution} for details.
|
|
75
|
-
* @param error Whether an error occurred during resolution switching. See VeLivePlayerError{@link #VeLivePlayerError} for details.
|
|
76
|
-
* @param reason The reason for resolution switching. See VeLivePlayerResolutionSwitchReason{@link #VeLivePlayerResolutionSwitchReason} for details.
|
|
77
|
-
* @order 5
|
|
78
|
-
*/
|
|
79
|
-
onResolutionSwitch$resolution$error$reason?(player: TVLManager, resolution: VeLivePlayerResolution, error: VeLivePlayerError, reason: VeLivePlayerResolutionSwitchReason): void;
|
|
80
|
-
|
|
81
|
-
/** {en}
|
|
82
|
-
* @detail callback
|
|
83
|
-
* @brief Occurs when the video size changes.
|
|
84
|
-
* @param player The player object that triggers the callback function.
|
|
85
|
-
* @param width The updated width of the video, in pixels.
|
|
86
|
-
* @param height The updated height of the video, in pixels.
|
|
87
|
-
* @order 6
|
|
88
|
-
*/
|
|
89
|
-
onVideoSizeChanged$width$height?(player: TVLManager, width: int, height: int): void;
|
|
90
|
-
|
|
91
|
-
/** {en}
|
|
92
|
-
* @detail api
|
|
93
|
-
* @brief String SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableSei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
|
|
94
|
-
* @param player The player object that triggers the callback function.
|
|
95
|
-
* @param message The SEI message.
|
|
96
|
-
* @order 7
|
|
97
|
-
*/
|
|
98
|
-
onReceiveSeiMessage$message?(player: TVLManager, message: NSString): void;
|
|
99
|
-
|
|
100
|
-
/** {en}
|
|
101
|
-
* @detail api
|
|
102
|
-
* @brief Binary SEI message callback. This callback is triggered when the player SDK receives an SEI message. It is necessary to enable the `enableBinarySei` property in `VeLivePlayerConfiguration`. When the `enableBinarySei` property is enabled, the string SEI message will no longer be sent.
|
|
103
|
-
* @param player The player object that triggers the callback function.
|
|
104
|
-
* @param message The SEI message.
|
|
105
|
-
* @order 7
|
|
106
|
-
*/
|
|
107
|
-
onReceiveBinarySeiMessage$message?(player: TVLManager, message: NSData): void;
|
|
108
|
-
|
|
109
|
-
/** {en}
|
|
110
|
-
* @detail callback
|
|
111
|
-
* @brief Occurs when the player switches between the primary stream and the backup stream.
|
|
112
|
-
* @param player The player object that triggers the callback function.
|
|
113
|
-
* @param streamType The type of the updated stream. See VeLivePlayerStreamType{@link #VeLivePlayerStreamType} for details.
|
|
114
|
-
* @param error The reason for the switch. See VeLivePlayerError{@link #VeLivePlayerError} for details.
|
|
115
|
-
* @order 8
|
|
116
|
-
*/
|
|
117
|
-
onMainBackupSwitch$streamType$error?(player: TVLManager, streamType: VeLivePlayerStreamType, error: VeLivePlayerError): void;
|
|
118
|
-
|
|
119
|
-
/** {en}
|
|
120
|
-
* @detail callback
|
|
121
|
-
* @brief Occurs when the playback status changes.
|
|
122
|
-
* @param player The player object that triggers the callback function.
|
|
123
|
-
* @param status The updated status of the player. See VeLivePlayerStatus{@link #VeLivePlayerStatus} for details.
|
|
124
|
-
* @order 9
|
|
125
|
-
*/
|
|
126
|
-
onPlayerStatusUpdate$status?(player: TVLManager, status: VeLivePlayerStatus): void;
|
|
127
|
-
|
|
128
|
-
/** {en}
|
|
129
|
-
* @detail callback
|
|
130
|
-
* @brief Occurs periodically to report information such as the current pull stream address, bitrate, and frame rate.
|
|
131
|
-
* @param player The player object that triggers the callback function.
|
|
132
|
-
* @param statistics The playback statistics. See VeLivePlayerStatistics{@link #VeLivePlayerStatistics} for details.
|
|
133
|
-
* @order 10
|
|
134
|
-
*/
|
|
135
|
-
onStatistics$statistics?(player: TVLManager, statistics: VeLivePlayerStatistics): void;
|
|
136
|
-
|
|
137
|
-
/** {en}
|
|
138
|
-
* @detail callback
|
|
139
|
-
* @brief Occurs when a screenshot is taken after snapshot{@link #VeLivePlayer#snapshot} is called.
|
|
140
|
-
* @param player The player object that triggers the callback function.
|
|
141
|
-
* @param image The UIImage object of the screenshot.
|
|
142
|
-
* @order 11
|
|
143
|
-
*/
|
|
144
|
-
onSnapshotComplete$image?(player: TVLManager, image: UIImage): void;
|
|
145
|
-
|
|
146
|
-
/** {en}
|
|
147
|
-
* @detail callback
|
|
148
|
-
* @brief Occurs when the player decodes a video frame. Call [enableVideoFrameObserver:pixelFormat:bufferType:](docs-player-sdk-for-ios-api#TVLManager(VeLivePlayer)-enablevideoframeobserver-pixelformat-buffertype) to enable video frame callback.
|
|
149
|
-
* @notes <br>
|
|
150
|
-
* If you use the texture format for external rendering, we recommend that you render the video in the callback thread.
|
|
151
|
-
* @order 12
|
|
152
|
-
* @param player The player object that triggers the callback function.
|
|
153
|
-
* @param videoFrame The video frame, including the pixel format, encapsulation format, width and height of the video, and other information. See VeLivePlayerVideoFrame{@link #VeLivePlayerVideoFrame} for details.
|
|
154
|
-
*/
|
|
155
|
-
onRenderVideoFrame$videoFrame?(player: TVLManager, videoFrame: VeLivePlayerVideoFrame): void;
|
|
156
|
-
|
|
157
|
-
/** {en}
|
|
158
|
-
* @detail callback
|
|
159
|
-
* @brief Occurs when the player decodes an audio frame. Call [enableAudioFrameObserver:enableRendering:](docs-player-sdk-for-ios-api#TVLManager(VeLivePlayer)-enableaudioframeobserver-enablerendering) to enable audio frame callback.
|
|
160
|
-
* @notes <br>
|
|
161
|
-
* The audio data returned by the callback is of type Float32 and in big-endian byte order.
|
|
162
|
-
* @order 13
|
|
163
|
-
* @param player The player object that triggers the callback function.
|
|
164
|
-
* @param audioFrame The audio frame. See VeLivePlayerAudioFrame{@link #VeLivePlayerAudioFrame} for details.
|
|
165
|
-
*/
|
|
166
|
-
onRenderAudioFrame$audioFrame?(player: TVLManager, audioFrame: VeLivePlayerAudioFrame): void;
|
|
167
|
-
|
|
168
|
-
/** {en}
|
|
169
|
-
* @detail callback
|
|
170
|
-
* @brief Occurs when the SDK fails to enable super resolution after [setEnableSuperResolution:](docs-player-sdk-for-ios-api#TVLManager(VeLivePlayer)-setenablesuperresolution) is called.
|
|
171
|
-
* @order 14
|
|
172
|
-
* @param player The player object that triggers the callback function.
|
|
173
|
-
* @param error The reason of the failure. See VeLivePlayerErrorCode{@link #VeLivePlayerErrorCode} for details.
|
|
174
|
-
*/
|
|
175
|
-
onStreamFailedOpenSuperResolution$error?(player: TVLManager, error: VeLivePlayerError): void;
|
|
176
|
-
}
|
|
@@ -1,160 +0,0 @@
|
|
|
1
|
-
import { NSInteger, NSString } from './types';
|
|
2
|
-
export declare class VeLivePlayerError {
|
|
3
|
-
|
|
4
|
-
/** {en}
|
|
5
|
-
* @brief The error code.
|
|
6
|
-
*/
|
|
7
|
-
errorCode: NSInteger;
|
|
8
|
-
|
|
9
|
-
/** {en}
|
|
10
|
-
* @brief The error message.
|
|
11
|
-
*/
|
|
12
|
-
errorMsg: NSString;
|
|
13
|
-
init(): this;
|
|
14
|
-
}
|
|
15
|
-
export declare enum VeLivePlayerErrorCode {
|
|
16
|
-
|
|
17
|
-
/** {en}
|
|
18
|
-
* @brief No error.
|
|
19
|
-
*
|
|
20
|
-
*/
|
|
21
|
-
VeLivePlayerNoError = 0,
|
|
22
|
-
|
|
23
|
-
/** {en}
|
|
24
|
-
* @brief The SDK license is invalid. This error may occur due to incorrect integration of the license or if the license has expired. Review how the license was integrated and ensure that it is still valid.
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
27
|
-
VeLivePlayerInvalidLicense = -1,
|
|
28
|
-
|
|
29
|
-
/** {en}
|
|
30
|
-
* @brief Invalid parameters. Check the input parameter and call the method again.
|
|
31
|
-
*
|
|
32
|
-
*/
|
|
33
|
-
VeLivePlayerInvalidParameter = -2,
|
|
34
|
-
|
|
35
|
-
/** {en}
|
|
36
|
-
* @brief The method call has been rejected. This error may occur when the method is called at an incorrect time.
|
|
37
|
-
*
|
|
38
|
-
*/
|
|
39
|
-
VeLivePlayerErrorRefused = -3,
|
|
40
|
-
|
|
41
|
-
/** {en}
|
|
42
|
-
* @brief Failed to load the library file. This error may occur due to incorrect integration of the SDK license.
|
|
43
|
-
*
|
|
44
|
-
*/
|
|
45
|
-
VeLivePlayerErrorLibraryLoadFailed = -4,
|
|
46
|
-
|
|
47
|
-
/** {en}
|
|
48
|
-
* @brief The pull stream address does not exist or is invalid. This error may occur if the pull stream address is empty, or if the format or length of the address is invalid.
|
|
49
|
-
*
|
|
50
|
-
*/
|
|
51
|
-
VeLivePlayerErrorPlayUrl = -100,
|
|
52
|
-
|
|
53
|
-
/** {en}
|
|
54
|
-
* @brief Unable to get the stream data. This error may occur if the live stream does not exist, is interrupted, or has ended. Please check the status of the live stream.
|
|
55
|
-
*
|
|
56
|
-
*/
|
|
57
|
-
VeLivePlayerErrorNoStreamData = -101,
|
|
58
|
-
|
|
59
|
-
/** {en}
|
|
60
|
-
* @brief An internal retry to play the live stream, which might happen due to an internal player error.
|
|
61
|
-
*
|
|
62
|
-
*/
|
|
63
|
-
VeLivePlayerErrorInternalRetryStart = -102,
|
|
64
|
-
|
|
65
|
-
/** {en}
|
|
66
|
-
* @brief An internal retry failed and the maximum number of internal retries is reached. The player has stopped retrying. You may attempt a manual retry.
|
|
67
|
-
*
|
|
68
|
-
*/
|
|
69
|
-
VeLivePlayerErrorInternalRetryFailed = -103,
|
|
70
|
-
|
|
71
|
-
/** {en}
|
|
72
|
-
* @brief DNS parsing failed. This error may occur due to an error in the pull stream address or the client's network conditions. If the error persists after you verify the pull stream address and network conditions, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
|
|
73
|
-
*
|
|
74
|
-
*/
|
|
75
|
-
VeLivePlayerErrorDnsParseFailed = -200,
|
|
76
|
-
|
|
77
|
-
/** {en}
|
|
78
|
-
* @brief The network request failed. Check the network conditions. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
|
|
79
|
-
*
|
|
80
|
-
*/
|
|
81
|
-
VeLivePlayerErrorNetworkRequestFailed = -201,
|
|
82
|
-
|
|
83
|
-
/** {en}
|
|
84
|
-
* @brief Video decapsulation failed. This error may occur if the live stream uses an unsupported format or protocol, or if there is an audio or video error. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
|
|
85
|
-
*
|
|
86
|
-
*/
|
|
87
|
-
VeLivePlayerErrorDemuxFailed = -300,
|
|
88
|
-
|
|
89
|
-
/** {en}
|
|
90
|
-
* @brief Decoding failed. This error may occur if the live stream uses an unsupported audio or video format. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
|
|
91
|
-
*
|
|
92
|
-
*/
|
|
93
|
-
VeLivePlayerErrorDecodeFailed = -301,
|
|
94
|
-
|
|
95
|
-
/** {en}
|
|
96
|
-
* @brief Rendering failed. This error may occur if there is an issue with the audio or video output devices. If the error persists, [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
|
|
97
|
-
*
|
|
98
|
-
*/
|
|
99
|
-
VeLivePlayerErrorAVOutputFailed = -302,
|
|
100
|
-
|
|
101
|
-
/** {en}
|
|
102
|
-
* @brief The device model does not support super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
|
|
103
|
-
*
|
|
104
|
-
*/
|
|
105
|
-
VeLivePlayerErrorSRDeviceUnsupported = -303,
|
|
106
|
-
|
|
107
|
-
/** {en}
|
|
108
|
-
* @brief The current resolution exceeds the upper limit allowed for super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
|
|
109
|
-
*
|
|
110
|
-
*/
|
|
111
|
-
VeLivePlayerErrorSRResolutionUnsupported = -304,
|
|
112
|
-
|
|
113
|
-
/** {en}
|
|
114
|
-
* @brief The current frame rate exceeds the upper limit allowed for super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for any assistance you may need.
|
|
115
|
-
*
|
|
116
|
-
*/
|
|
117
|
-
VeLivePlayerErrorSRFpsUnsupported = -305,
|
|
118
|
-
|
|
119
|
-
/** {en}
|
|
120
|
-
* @brief Fails to initialize super resolution. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if the error persists.
|
|
121
|
-
*
|
|
122
|
-
*/
|
|
123
|
-
VeLivePlayerErrorSRInitFail = -306,
|
|
124
|
-
|
|
125
|
-
/** {en}
|
|
126
|
-
* @brief Fails to apply super resolution to the video. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support if the error persists.
|
|
127
|
-
*
|
|
128
|
-
*/
|
|
129
|
-
VeLivePlayerErrorSRExecuteFail = -307,
|
|
130
|
-
|
|
131
|
-
/** {en}
|
|
132
|
-
* @brief The SDK license does not provide support for the H.265 feature.
|
|
133
|
-
*
|
|
134
|
-
*/
|
|
135
|
-
VeLivePlayerLicenseUnsupportedH265 = -308,
|
|
136
|
-
|
|
137
|
-
/** {en}
|
|
138
|
-
* @brief The player does not support switching of definition.
|
|
139
|
-
*
|
|
140
|
-
*/
|
|
141
|
-
VeLivePlayerErrorNotSupportResolutionSwitch = -310,
|
|
142
|
-
|
|
143
|
-
/** {en}
|
|
144
|
-
* @brief DRM authentication fails
|
|
145
|
-
*
|
|
146
|
-
*/
|
|
147
|
-
VeLivePlayerDRMFetchCKCFailed = -400,
|
|
148
|
-
|
|
149
|
-
/** {en}
|
|
150
|
-
* @brief Fails to generate Server Playback Context (SPC)
|
|
151
|
-
*
|
|
152
|
-
*/
|
|
153
|
-
VeLivePlayerDRMFetchSPCFailed = -401,
|
|
154
|
-
|
|
155
|
-
/** {en}
|
|
156
|
-
* @brief Internal error. [Create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance.
|
|
157
|
-
*
|
|
158
|
-
*/
|
|
159
|
-
VeLivePlayerErrorInternal = -999
|
|
160
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { VeLivePlayerLogConfig, UIView } from '../../platforms/ios/extends';
|