@dcloudio/uni-app-x 0.5.11 → 0.5.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dcloudio/uni-app-x",
3
- "version": "0.5.11",
3
+ "version": "0.5.13",
4
4
  "description": "uni-app x types",
5
5
  "typings": "index.d.ts",
6
6
  "author": "DCloud",
@@ -0,0 +1,23 @@
1
+ type DoubleClickCallback = () => void;
2
+
3
+ interface INavigationBar {
4
+ /**
5
+ * 滚动更新
6
+ */
7
+ updateByScroll(scrollY: number): void;
8
+
9
+ /**
10
+ * 添加双击事件监听
11
+ */
12
+ addNavigationBarDoubleClickListener(callback: DoubleClickCallback): void;
13
+
14
+ /**
15
+ * 移除双击事件监听
16
+ */
17
+ removeNavigationBarDoubleClickListener(callback: DoubleClickCallback): void;
18
+
19
+ /**
20
+ * 移除全部双击事件监听
21
+ */
22
+ removeAllNavigationBarDoubleClickListener(): void;
23
+ }
@@ -1,41 +1,88 @@
1
1
  /// <reference path='./IDocument.d.ts' />
2
2
  /// <reference path='./NodeData.d.ts' />
3
+ /// <reference path='./INavigationBar.d.ts' />
4
+
5
+ declare enum Type {
6
+ DEFAULT,
7
+ POPUP
8
+ }
9
+
10
+ // TODO
11
+ declare class UniCallbackWrapper {
12
+
13
+ }
14
+
15
+ // TODO
16
+ declare class NavigationBarButtonTapEvent {
17
+
18
+ }
19
+
20
+ // TODO
21
+ declare class WebViewServiceMessageEvent {
22
+
23
+ }
24
+
25
+ // TODO
26
+ declare class ViewToTempFilePathOptions {
27
+
28
+ }
29
+
30
+ // TODO
31
+ declare class NavigationBarSearchInputEvent {
32
+
33
+ }
3
34
 
4
35
  /**
5
36
  * @package io.dcloud.uniapp.runtime
6
37
  * @autodoc false
7
38
  */
8
39
  declare interface IPage {
40
+ pageUrl: string;
41
+ type: Type;
42
+ // 不适合出现在 interface
43
+ // pageEventHelper: PageEventHelper
44
+ animationOption: Map<string, any> | null;
45
+ animDuration: number;
46
+ isDestroy: boolean;
9
47
  /**
10
48
  * 页面id
11
49
  */
12
50
  pageId: string
51
+ // 不适合出现在 interface
52
+ // containerView: View | null
13
53
  /**
14
54
  * document对象
15
55
  */
16
56
  document: IDocument
57
+ isChild: boolean;
58
+ navigationBar: INavigationBar | null
59
+ // 不适合出现在 interface
60
+ // pageActivity: UniPageActivity | null
61
+ tabsNode: ITabsNode | null;
62
+ // 不适合出现在 interface
63
+ // fonts: Map<string, Typeface | null>
64
+ /**
65
+ * 开启排版渲染
66
+ * @param callback 首次排版回调监听器
67
+ */
68
+ startRender(callback?: () => void): void
17
69
  /**
18
70
  * 显示页面
19
71
  * @param {Map<String, Any>} options 显示配置项
20
- * @param {() => void} callback 显示完毕监听器
72
+ * @param callback 显示完毕监听器
21
73
  */
22
74
  show(options?: any, callback?: () => void): void
75
+ hide(options?: Map<string, any>): void
23
76
  /**
24
77
  * 关闭页面
25
78
  * @param {Map<String, Any>} options 关闭配置项
26
- * @param {() => void} callback 关闭完毕监听器
79
+ * @param callback 关闭完毕监听器
27
80
  */
28
81
  close(options?: any, callback?: () => void): void
29
- /**
30
- * 开启排版渲染
31
- * @param {() => void} callback 首次排版回调监听器
32
- */
33
- startRender(callback?: () => void): void
34
- /**
35
- * 停止排版渲染
36
- */
37
- stopRender(): void
38
-
82
+ destroy(): void;
83
+ updateStyle(style: Map<string, any>): void
84
+ createDocument(documentData: INodeData): IDocument
85
+ createDocument(tagName: string, data: Map<string, any>): IDocument
39
86
  addPageEventListener(
40
87
  type:
41
88
  | 'onReady'
@@ -50,26 +97,33 @@ declare interface IPage {
50
97
  | 'onWebViewServiceMessage',
51
98
  callback: (event: PageEvent) => void
52
99
  ): void
53
-
100
+ addEventListener<T extends Event>(event: string, callback: (event: T) => void): UniCallbackWrapper
101
+ addResizeEventListener(callback: (event: ResizeEvent) => void): UniCallbackWrapper
102
+ addNavigationBarButtonTapListener(callback: (event: NavigationBarButtonTapEvent) => void): UniCallbackWrapper
103
+ addNavigationBarSearchInputChangedListener(callback: (event: NavigationBarSearchInputEvent) => void): UniCallbackWrapper
104
+ addNavigationBarSearchInputConfirmedListener(callback: (event: NavigationBarSearchInputEvent) => void): UniCallbackWrapper
105
+ addNavigationBarSearchInputClickedListener(callback: (event: PageEvent) => void): UniCallbackWrapper
54
106
  addPageScrollEventListener(callback: (event: PageScrollEvent) => void): void
55
-
107
+ addWebViewServiceMessageEventListener(callback: (event: WebViewServiceMessageEvent) => void): UniCallbackWrapper
108
+ removeEventListener(callbackWrapper: UniCallbackWrapper): void
109
+ removeEventListener(event: string, callbackWrapper: UniCallbackWrapper): void
110
+ dispatchPageEvent(event: string, data: PageEvent): void
56
111
  viewToTempFilePath(options: ViewToTempFilePathOptions): void
57
-
112
+ dispatchActivityState(key: number, ...params: any[]): void
113
+ // LoadFontFaceOptions 类型全局命名冲突
114
+ // loadFontFace(options: LoadFontFaceOptions): void
115
+ /**
116
+ * 停止排版渲染
117
+ */
118
+ stopRender(): void
119
+ startPullDownRefresh(): void
120
+ stopPullDownRefresh(): void
58
121
  getPageRenderDuration(): number
59
-
60
122
  getPageLayoutDuration(): number
61
-
123
+ getPageRenderCount(): number
124
+ getPageLayoutCount(): number
125
+ getFirstRenderStartTime(): number
126
+ getFirstLayoutStartTime(): number
62
127
  getFirstPageRenderDuration(): number
63
-
64
128
  getFirstPageLayoutDuration(): number
65
-
66
- startPullDownRefresh(): void
67
-
68
- stopPullDownRefresh(): void
69
-
70
- loadFontFace(options: LoadFontFaceOptions): void
71
-
72
- updateStyle(style: Map<String, any | null>): void
73
-
74
- createDocument(documentData: INodeData): IDocument
75
129
  }
@@ -1,72 +1,156 @@
1
1
  import {
2
+ MediaErrorCode as MediaErrorCodeOrigin,
3
+ IMediaError as IMediaErrorOrigin,
4
+ ChooseImageSuccess as ChooseImageSuccessOrigin,
5
+ ChooseImageFail as ChooseImageFailOrigin,
2
6
  ChooseImageSuccessCallback as ChooseImageSuccessCallbackOrigin,
7
+ ChooseImageFailCallback as ChooseImageFailCallbackOrigin,
8
+ ChooseImageCompleteCallback as ChooseImageCompleteCallbackOrigin,
3
9
  ChooseImageCropOptions as ChooseImageCropOptionsOrigin,
4
10
  ChooseImageOptions as ChooseImageOptionsOrigin,
5
11
  ChooseImage as ChooseImageOrigin,
6
- PreviewImageSuccessCallback as PreviewImageSuccessCallbackOrigin,
12
+ PreviewImageSuccess as PreviewImageSuccessOrigin,
7
13
  LongPressActionsSuccessData as LongPressActionsSuccessDataOrigin,
8
14
  LongPressActionsOptions as LongPressActionsOptionsOrigin,
15
+ PreviewImageFail as PreviewImageFailOrigin,
16
+ PreviewImageSuccessCallback as PreviewImageSuccessCallbackOrigin,
17
+ PreviewImageFailCallback as PreviewImageFailCallbackOrigin,
18
+ PreviewImageCompleteCallback as PreviewImageCompleteCallbackOrigin,
9
19
  PreviewImageOptions as PreviewImageOptionsOrigin,
10
20
  PreviewImage as PreviewImageOrigin,
11
21
  ClosePreviewImage as ClosePreviewImageOrigin,
22
+ ClosePreviewImageSuccess as ClosePreviewImageSuccessOrigin,
23
+ ClosePreviewImageFail as ClosePreviewImageFailOrigin,
12
24
  ClosePreviewImageSuccessCallback as ClosePreviewImageSuccessCallbackOrigin,
25
+ ClosePreviewImageFailCallback as ClosePreviewImageFailCallbackOrigin,
26
+ ClosePreviewImageCompleteCallback as ClosePreviewImageCompleteCallbackOrigin,
13
27
  ClosePreviewImageOptions as ClosePreviewImageOptionsOrigin,
14
28
  GetImageInfo as GetImageInfoOrigin,
29
+ GetImageInfoSuccess as GetImageInfoSuccessOrigin,
30
+ GetImageInfoFail as GetImageInfoFailOrigin,
15
31
  GetImageInfoSuccessCallback as GetImageInfoSuccessCallbackOrigin,
32
+ GetImageInfoFailCallback as GetImageInfoFailCallbackOrigin,
33
+ GetImageInfoCompleteCallback as GetImageInfoCompleteCallbackOrigin,
16
34
  GetImageInfoOptions as GetImageInfoOptionsOrigin,
17
35
  SaveImageToPhotosAlbum as SaveImageToPhotosAlbumOrigin,
36
+ SaveImageToPhotosAlbumSuccess as SaveImageToPhotosAlbumSuccessOrigin,
37
+ SaveImageToPhotosAlbumFail as SaveImageToPhotosAlbumFailOrigin,
18
38
  SaveImageToPhotosAlbumSuccessCallback as SaveImageToPhotosAlbumSuccessCallbackOrigin,
39
+ SaveImageToPhotosAlbumFailCallback as SaveImageToPhotosAlbumFailCallbackOrigin,
40
+ SaveImageToPhotosAlbumCompleteCallback as SaveImageToPhotosAlbumCompleteCallbackOrigin,
19
41
  SaveImageToPhotosAlbumOptions as SaveImageToPhotosAlbumOptionsOrigin,
20
42
  CompressImage as CompressImageOrigin,
43
+ CompressImageSuccess as CompressImageSuccessOrigin,
44
+ CompressImageFail as CompressImageFailOrigin,
21
45
  CompressImageSuccessCallback as CompressImageSuccessCallbackOrigin,
46
+ CompressImageFailCallback as CompressImageFailCallbackOrigin,
47
+ CompressImageCompleteCallback as CompressImageCompleteCallbackOrigin,
22
48
  CompressImageOptions as CompressImageOptionsOrigin,
49
+ ChooseVideoSuccess as ChooseVideoSuccessOrigin,
50
+ ChooseVideoFail as ChooseVideoFailOrigin,
23
51
  ChooseVideoSuccessCallback as ChooseVideoSuccessCallbackOrigin,
52
+ ChooseVideoFailCallback as ChooseVideoFailCallbackOrigin,
53
+ ChooseVideoCompleteCallback as ChooseVideoCompleteCallbackOrigin,
24
54
  ChooseVideoOptions as ChooseVideoOptionsOrigin,
25
55
  ChooseVideo as ChooseVideoOrigin,
56
+ GetVideoInfoSuccess as GetVideoInfoSuccessOrigin,
57
+ GetVideoInfoFail as GetVideoInfoFailOrigin,
26
58
  GetVideoInfoSuccessCallback as GetVideoInfoSuccessCallbackOrigin,
59
+ GetVideoInfoFailCallback as GetVideoInfoFailCallbackOrigin,
60
+ GetVideoInfoCompleteCallback as GetVideoInfoCompleteCallbackOrigin,
27
61
  GetVideoInfoOptions as GetVideoInfoOptionsOrigin,
28
62
  GetVideoInfo as GetVideoInfoOrigin,
63
+ SaveVideoToPhotosAlbumSuccess as SaveVideoToPhotosAlbumSuccessOrigin,
64
+ SaveVideoToPhotosAlbumFail as SaveVideoToPhotosAlbumFailOrigin,
29
65
  SaveVideoToPhotosAlbumSuccessCallback as SaveVideoToPhotosAlbumSuccessCallbackOrigin,
66
+ SaveVideoToPhotosAlbumFailCallback as SaveVideoToPhotosAlbumFailCallbackOrigin,
67
+ SaveVideoToPhotosAlbumCompleteCallback as SaveVideoToPhotosAlbumCompleteCallbackOrigin,
30
68
  SaveVideoToPhotosAlbumOptions as SaveVideoToPhotosAlbumOptionsOrigin,
31
69
  SaveVideoToPhotosAlbum as SaveVideoToPhotosAlbumOrigin,
70
+ CompressVideoSuccess as CompressVideoSuccessOrigin,
71
+ CompressVideoFail as CompressVideoFailOrigin,
32
72
  CompressVideoSuccessCallback as CompressVideoSuccessCallbackOrigin,
73
+ CompressVideoFailCallback as CompressVideoFailCallbackOrigin,
74
+ CompressVideoCompleteCallback as CompressVideoCompleteCallbackOrigin,
33
75
  CompressVideoOptions as CompressVideoOptionsOrigin,
34
76
  CompressVideo as CompressVideoOrigin,
35
77
  Uni as UniOrigin
36
78
  } from './interface'
37
79
 
38
80
  declare global {
81
+ type MediaErrorCode = MediaErrorCodeOrigin
82
+ type IMediaError = IMediaErrorOrigin
83
+ type ChooseImageSuccess = ChooseImageSuccessOrigin
84
+ type ChooseImageFail = ChooseImageFailOrigin
39
85
  type ChooseImageSuccessCallback = ChooseImageSuccessCallbackOrigin
86
+ type ChooseImageFailCallback = ChooseImageFailCallbackOrigin
87
+ type ChooseImageCompleteCallback = ChooseImageCompleteCallbackOrigin
40
88
  type ChooseImageCropOptions = ChooseImageCropOptionsOrigin
41
89
  type ChooseImageOptions = ChooseImageOptionsOrigin
42
90
  type ChooseImage = ChooseImageOrigin
43
- type PreviewImageSuccessCallback = PreviewImageSuccessCallbackOrigin
91
+ type PreviewImageSuccess = PreviewImageSuccessOrigin
44
92
  type LongPressActionsSuccessData = LongPressActionsSuccessDataOrigin
45
93
  type LongPressActionsOptions = LongPressActionsOptionsOrigin
94
+ type PreviewImageFail = PreviewImageFailOrigin
95
+ type PreviewImageSuccessCallback = PreviewImageSuccessCallbackOrigin
96
+ type PreviewImageFailCallback = PreviewImageFailCallbackOrigin
97
+ type PreviewImageCompleteCallback = PreviewImageCompleteCallbackOrigin
46
98
  type PreviewImageOptions = PreviewImageOptionsOrigin
47
99
  type PreviewImage = PreviewImageOrigin
48
100
  type ClosePreviewImage = ClosePreviewImageOrigin
101
+ type ClosePreviewImageSuccess = ClosePreviewImageSuccessOrigin
102
+ type ClosePreviewImageFail = ClosePreviewImageFailOrigin
49
103
  type ClosePreviewImageSuccessCallback = ClosePreviewImageSuccessCallbackOrigin
104
+ type ClosePreviewImageFailCallback = ClosePreviewImageFailCallbackOrigin
105
+ type ClosePreviewImageCompleteCallback = ClosePreviewImageCompleteCallbackOrigin
50
106
  type ClosePreviewImageOptions = ClosePreviewImageOptionsOrigin
51
107
  type GetImageInfo = GetImageInfoOrigin
108
+ type GetImageInfoSuccess = GetImageInfoSuccessOrigin
109
+ type GetImageInfoFail = GetImageInfoFailOrigin
52
110
  type GetImageInfoSuccessCallback = GetImageInfoSuccessCallbackOrigin
111
+ type GetImageInfoFailCallback = GetImageInfoFailCallbackOrigin
112
+ type GetImageInfoCompleteCallback = GetImageInfoCompleteCallbackOrigin
53
113
  type GetImageInfoOptions = GetImageInfoOptionsOrigin
54
114
  type SaveImageToPhotosAlbum = SaveImageToPhotosAlbumOrigin
115
+ type SaveImageToPhotosAlbumSuccess = SaveImageToPhotosAlbumSuccessOrigin
116
+ type SaveImageToPhotosAlbumFail = SaveImageToPhotosAlbumFailOrigin
55
117
  type SaveImageToPhotosAlbumSuccessCallback = SaveImageToPhotosAlbumSuccessCallbackOrigin
118
+ type SaveImageToPhotosAlbumFailCallback = SaveImageToPhotosAlbumFailCallbackOrigin
119
+ type SaveImageToPhotosAlbumCompleteCallback = SaveImageToPhotosAlbumCompleteCallbackOrigin
56
120
  type SaveImageToPhotosAlbumOptions = SaveImageToPhotosAlbumOptionsOrigin
57
121
  type CompressImage = CompressImageOrigin
122
+ type CompressImageSuccess = CompressImageSuccessOrigin
123
+ type CompressImageFail = CompressImageFailOrigin
58
124
  type CompressImageSuccessCallback = CompressImageSuccessCallbackOrigin
125
+ type CompressImageFailCallback = CompressImageFailCallbackOrigin
126
+ type CompressImageCompleteCallback = CompressImageCompleteCallbackOrigin
59
127
  type CompressImageOptions = CompressImageOptionsOrigin
128
+ type ChooseVideoSuccess = ChooseVideoSuccessOrigin
129
+ type ChooseVideoFail = ChooseVideoFailOrigin
60
130
  type ChooseVideoSuccessCallback = ChooseVideoSuccessCallbackOrigin
131
+ type ChooseVideoFailCallback = ChooseVideoFailCallbackOrigin
132
+ type ChooseVideoCompleteCallback = ChooseVideoCompleteCallbackOrigin
61
133
  type ChooseVideoOptions = ChooseVideoOptionsOrigin
62
134
  type ChooseVideo = ChooseVideoOrigin
135
+ type GetVideoInfoSuccess = GetVideoInfoSuccessOrigin
136
+ type GetVideoInfoFail = GetVideoInfoFailOrigin
63
137
  type GetVideoInfoSuccessCallback = GetVideoInfoSuccessCallbackOrigin
138
+ type GetVideoInfoFailCallback = GetVideoInfoFailCallbackOrigin
139
+ type GetVideoInfoCompleteCallback = GetVideoInfoCompleteCallbackOrigin
64
140
  type GetVideoInfoOptions = GetVideoInfoOptionsOrigin
65
141
  type GetVideoInfo = GetVideoInfoOrigin
142
+ type SaveVideoToPhotosAlbumSuccess = SaveVideoToPhotosAlbumSuccessOrigin
143
+ type SaveVideoToPhotosAlbumFail = SaveVideoToPhotosAlbumFailOrigin
66
144
  type SaveVideoToPhotosAlbumSuccessCallback = SaveVideoToPhotosAlbumSuccessCallbackOrigin
145
+ type SaveVideoToPhotosAlbumFailCallback = SaveVideoToPhotosAlbumFailCallbackOrigin
146
+ type SaveVideoToPhotosAlbumCompleteCallback = SaveVideoToPhotosAlbumCompleteCallbackOrigin
67
147
  type SaveVideoToPhotosAlbumOptions = SaveVideoToPhotosAlbumOptionsOrigin
68
148
  type SaveVideoToPhotosAlbum = SaveVideoToPhotosAlbumOrigin
149
+ type CompressVideoSuccess = CompressVideoSuccessOrigin
150
+ type CompressVideoFail = CompressVideoFailOrigin
69
151
  type CompressVideoSuccessCallback = CompressVideoSuccessCallbackOrigin
152
+ type CompressVideoFailCallback = CompressVideoFailCallbackOrigin
153
+ type CompressVideoCompleteCallback = CompressVideoCompleteCallbackOrigin
70
154
  type CompressVideoOptions = CompressVideoOptionsOrigin
71
155
  type CompressVideo = CompressVideoOrigin
72
156
  interface Uni extends UniOrigin { }
@@ -1,6 +1,29 @@
1
1
 
2
+ /**
3
+ * 错误码
4
+ * - 1101001 用户取消
5
+ * - 1101002 urls至少包含一张图片地址
6
+ * - 1101003 文件不存在
7
+ * - 1101004 图片加载失败
8
+ * - 1101005 未获取权限
9
+ * - 1101006 图片或视频保存失败
10
+ * - 1101007 图片裁剪失败
11
+ * - 1101008 拍照或录像失败
12
+ * - 1101009 图片压缩失败
13
+ * - 1101010 其他错误
14
+ */
2
15
 
3
- export type ChooseImageSuccessCallback = {
16
+ export type MediaErrorCode = 1101001 | 1101002 | 1101003 | 1101004 | 1101005 | 1101006 | 1101007 | 1101008 | 1101009 | 1101010;
17
+
18
+ /**
19
+ * 图片或视频操作失败的错误回调
20
+ */
21
+ export interface IMediaError extends IUniError {
22
+ errCode : MediaErrorCode
23
+ };
24
+
25
+
26
+ export type ChooseImageSuccess = {
4
27
  /**
5
28
  * 调用API的名称
6
29
  */
@@ -10,6 +33,11 @@ export type ChooseImageSuccessCallback = {
10
33
  tempFiles : any
11
34
  }
12
35
 
36
+ export type ChooseImageFail = IMediaError;
37
+ export type ChooseImageSuccessCallback = (callback : ChooseImageSuccess) => void
38
+ export type ChooseImageFailCallback = (callback : ChooseImageFail) => void
39
+ export type ChooseImageCompleteCallback = (callback : any) => void
40
+
13
41
  export type ChooseImageCropOptions = {
14
42
  /**
15
43
  * 裁剪的宽度,单位为px,用于计算裁剪宽高比。
@@ -59,20 +87,20 @@ export type ChooseImageOptions = {
59
87
  /**
60
88
  * 成功则返回图片的本地文件路径列表 tempFilePaths
61
89
  */
62
- success ?: ((callback : ChooseImageSuccessCallback) => void) | null,
90
+ success ?: (ChooseImageSuccessCallback) | null,
63
91
  /**
64
92
  * 接口调用失败的回调函数
65
93
  */
66
- fail ?: ((callback : UniError) => void) | null,
94
+ fail ?: (ChooseImageFailCallback) | null,
67
95
  /**
68
96
  * 接口调用结束的回调函数(调用成功、失败都会执行)
69
97
  */
70
- complete ?: ((callback : any) => void) | null
98
+ complete ?: (ChooseImageCompleteCallback) | null
71
99
  }
72
100
 
73
101
  export type ChooseImage = (options : ChooseImageOptions) => void
74
102
 
75
- export type PreviewImageSuccessCallback = {
103
+ export type PreviewImageSuccess = {
76
104
  errSubject : string,
77
105
  errMsg : string
78
106
  }
@@ -110,6 +138,12 @@ export type LongPressActionsOptions = {
110
138
  complete : ((result : any) => void) | null
111
139
  };
112
140
 
141
+
142
+ export type PreviewImageFail = IMediaError;
143
+ export type PreviewImageSuccessCallback = (callback : PreviewImageSuccess) => void
144
+ export type PreviewImageFailCallback = (callback : PreviewImageFail) => void
145
+ export type PreviewImageCompleteCallback = ChooseImageCompleteCallback
146
+
113
147
  export type PreviewImageOptions = {
114
148
  /**
115
149
  * 当前显示图片的链接,不填则默认为 urls 的第一张
@@ -144,44 +178,49 @@ export type PreviewImageOptions = {
144
178
  /**
145
179
  * 接口调用成功的回调函数
146
180
  */
147
- success ?: ((result : PreviewImageSuccessCallback) => void) | null,
181
+ success ?: (PreviewImageSuccessCallback) | null,
148
182
  /**
149
183
  * 接口调用失败的回调函数
150
184
  */
151
- fail ?: ((result : UniError) => void) | null,
185
+ fail ?: (PreviewImageFailCallback) | null,
152
186
  /**
153
187
  * 接口调用结束的回调函数(调用成功、失败都会执行)
154
188
  */
155
- complete ?: ((result : any) => void) | null
189
+ complete ?: (PreviewImageCompleteCallback) | null
156
190
  };
157
191
 
158
192
  export type PreviewImage = (options : PreviewImageOptions) => void;
159
193
 
160
194
  export type ClosePreviewImage = (options : ClosePreviewImageOptions) => void;
161
- export type ClosePreviewImageSuccessCallback = {
195
+ export type ClosePreviewImageSuccess = {
162
196
  /**
163
197
  * 错误信息
164
198
  */
165
199
  errMsg : string
166
200
  };
167
201
 
202
+ export type ClosePreviewImageFail = IMediaError;
203
+ export type ClosePreviewImageSuccessCallback = (callback : ClosePreviewImageSuccess) => void
204
+ export type ClosePreviewImageFailCallback = (callback : ClosePreviewImageFail) => void
205
+ export type ClosePreviewImageCompleteCallback = ChooseImageCompleteCallback
206
+
168
207
  export type ClosePreviewImageOptions = {
169
208
  /**
170
209
  * 接口调用成功的回调函数
171
210
  */
172
- success ?: ((result : ClosePreviewImageSuccessCallback) => void) | null,
211
+ success ?: (ClosePreviewImageSuccessCallback) | null,
173
212
  /**
174
213
  * 接口调用失败的回调函数
175
214
  */
176
- fail ?: ((result : UniError) => void) | null,
215
+ fail ?: (ClosePreviewImageFailCallback) | null,
177
216
  /**
178
217
  * 接口调用结束的回调函数(调用成功、失败都会执行)
179
218
  */
180
- complete ?: ((result : any) => void) | null
219
+ complete ?: (ClosePreviewImageCompleteCallback) | null
181
220
  };
182
221
 
183
222
  export type GetImageInfo = (options : GetImageInfoOptions) => void;
184
- export type GetImageInfoSuccessCallback = {
223
+ export type GetImageInfoSuccess = {
185
224
  /**
186
225
  * 图片宽度,单位px
187
226
  */
@@ -204,6 +243,11 @@ export type GetImageInfoSuccessCallback = {
204
243
  type : string | null
205
244
  };
206
245
 
246
+ export type GetImageInfoFail = IMediaError;
247
+ export type GetImageInfoSuccessCallback = (callback : GetImageInfoSuccess) => void
248
+ export type GetImageInfoFailCallback = (callback : GetImageInfoFail) => void
249
+ export type GetImageInfoCompleteCallback = ChooseImageCompleteCallback
250
+
207
251
  export type GetImageInfoOptions = {
208
252
  /**
209
253
  * 图片的路径,可以是相对路径,临时文件路径,存储文件路径,网络图片路径
@@ -212,26 +256,31 @@ export type GetImageInfoOptions = {
212
256
  /**
213
257
  * 接口调用成功的回调函数
214
258
  */
215
- success ?: ((result : GetImageInfoSuccessCallback) => void) | null,
259
+ success ?: (GetImageInfoSuccessCallback) | null,
216
260
  /**
217
261
  * 接口调用失败的回调函数
218
262
  */
219
- fail ?: ((result : UniError) => void) | null,
263
+ fail ?: (GetImageInfoFailCallback) | null,
220
264
  /**
221
265
  * 接口调用结束的回调函数(调用成功、失败都会执行)
222
266
  */
223
- complete ?: ((result : any) => void) | null
267
+ complete ?: (GetImageInfoCompleteCallback) | null
224
268
  };
225
269
 
226
270
  export type SaveImageToPhotosAlbum = (options : SaveImageToPhotosAlbumOptions) => void;
227
271
 
228
- export type SaveImageToPhotosAlbumSuccessCallback = {
272
+ export type SaveImageToPhotosAlbumSuccess = {
229
273
  /**
230
274
  * 保存到相册的图片路径
231
275
  */
232
276
  path : string
233
277
  };
234
278
 
279
+ export type SaveImageToPhotosAlbumFail = IMediaError;
280
+ export type SaveImageToPhotosAlbumSuccessCallback = (callback : SaveImageToPhotosAlbumSuccess) => void
281
+ export type SaveImageToPhotosAlbumFailCallback = (callback : SaveImageToPhotosAlbumFail) => void
282
+ export type SaveImageToPhotosAlbumCompleteCallback = ChooseImageCompleteCallback
283
+
235
284
  export type SaveImageToPhotosAlbumOptions = {
236
285
  /**
237
286
  * 图片文件路径,可以是临时文件路径也可以是永久文件路径,不支持网络图片路径
@@ -240,23 +289,29 @@ export type SaveImageToPhotosAlbumOptions = {
240
289
  /**
241
290
  * 接口调用成功的回调函数
242
291
  */
243
- success ?: ((result : SaveImageToPhotosAlbumSuccessCallback) => void) | null,
292
+ success ?: (SaveImageToPhotosAlbumSuccessCallback) | null,
244
293
  /**
245
294
  * 接口调用失败的回调函数
246
295
  */
247
- fail ?: ((result : UniError) => void) | null,
296
+ fail ?: (SaveImageToPhotosAlbumFailCallback) | null,
248
297
  /**
249
298
  * 接口调用结束的回调函数(调用成功、失败都会执行)
250
299
  */
251
- complete ?: ((result : any) => void) | null
300
+ complete ?: (SaveImageToPhotosAlbumCompleteCallback) | null
252
301
  };
253
302
  export type CompressImage = (options : CompressImageOptions) => void;
254
- export type CompressImageSuccessCallback = {
303
+ export type CompressImageSuccess = {
255
304
  /**
256
305
  * 压缩后图片的临时文件路径
257
306
  */
258
307
  tempFilePath : string
259
308
  };
309
+
310
+ export type CompressImageFail = IMediaError;
311
+ export type CompressImageSuccessCallback = (callback : CompressImageSuccess) => void
312
+ export type CompressImageFailCallback = (callback : CompressImageFail) => void
313
+ export type CompressImageCompleteCallback = ChooseImageCompleteCallback
314
+
260
315
  export type CompressImageOptions = {
261
316
  /**
262
317
  * 图片路径,图片的路径,可以是相对路径、临时文件路径、存储文件路径
@@ -289,18 +344,18 @@ export type CompressImageOptions = {
289
344
  /**
290
345
  * 接口调用成功的回调函数
291
346
  */
292
- success ?: ((result : CompressImageSuccessCallback) => void) | null,
347
+ success ?: (CompressImageSuccessCallback) | null,
293
348
  /**
294
349
  * 接口调用失败的回调函数
295
350
  */
296
- fail ?: ((result : UniError) => void) | null,
351
+ fail ?: (CompressImageFailCallback) | null,
297
352
  /**
298
353
  * 接口调用结束的回调函数(调用成功、失败都会执行)
299
354
  */
300
- complete ?: ((result : any) => void) | null
355
+ complete ?: (CompressImageCompleteCallback) | null
301
356
  };
302
357
 
303
- export type ChooseVideoSuccessCallback = {
358
+ export type ChooseVideoSuccess = {
304
359
  /**
305
360
  * 选定视频的临时文件路径
306
361
  */
@@ -331,6 +386,11 @@ export type ChooseVideoSuccessCallback = {
331
386
  // name: string | null
332
387
  };
333
388
 
389
+ export type ChooseVideoFail = IMediaError;
390
+ export type ChooseVideoSuccessCallback = (callback : ChooseVideoSuccess) => void
391
+ export type ChooseVideoFailCallback = (callback : ChooseVideoFail) => void
392
+ export type ChooseVideoCompleteCallback = ChooseImageCompleteCallback
393
+
334
394
  export type ChooseVideoOptions = {
335
395
  /**
336
396
  * album 从相册选视频,camera 使用相机拍摄,默认为:['album', 'camera']
@@ -359,20 +419,20 @@ export type ChooseVideoOptions = {
359
419
  /**
360
420
  * 接口调用成功,返回视频文件的临时文件路径,详见返回参数说明
361
421
  */
362
- success ?: ((result : ChooseVideoSuccessCallback) => void) | null,
422
+ success ?: (ChooseVideoSuccessCallback) | null,
363
423
  /**
364
424
  * 接口调用失败的回调函数
365
425
  */
366
- fail ?: ((result : UniError) => void) | null,
426
+ fail ?: (ChooseVideoFailCallback) | null,
367
427
  /**
368
428
  * 接口调用结束的回调函数(调用成功、失败都会执行)
369
429
  */
370
- complete ?: ((result : any) => void) | null
430
+ complete ?: (ChooseVideoCompleteCallback) | null
371
431
  };
372
432
 
373
433
  export type ChooseVideo = (options : ChooseVideoOptions) => void;
374
434
 
375
- export type GetVideoInfoSuccessCallback = {
435
+ export type GetVideoInfoSuccess = {
376
436
  /**
377
437
  * 画面方向
378
438
  */
@@ -407,6 +467,11 @@ export type GetVideoInfoSuccessCallback = {
407
467
  bitrate : number | null
408
468
  };
409
469
 
470
+ export type GetVideoInfoFail = IMediaError;
471
+ export type GetVideoInfoSuccessCallback = (callback : GetVideoInfoSuccess) => void
472
+ export type GetVideoInfoFailCallback = (callback : GetVideoInfoFail) => void
473
+ export type GetVideoInfoCompleteCallback = ChooseImageCompleteCallback
474
+
410
475
  export type GetVideoInfoOptions = {
411
476
  /**
412
477
  * 视频文件路径,可以是临时文件路径也可以是永久文件路径
@@ -415,20 +480,25 @@ export type GetVideoInfoOptions = {
415
480
  /**
416
481
  * 接口调用成功的回调函数
417
482
  */
418
- success ?: ((result : GetVideoInfoSuccessCallback) => void) | null,
483
+ success ?: (GetVideoInfoSuccessCallback) | null,
419
484
  /**
420
485
  * 接口调用失败的回调函数
421
486
  */
422
- fail ?: ((result : UniError) => void) | null,
487
+ fail ?: (GetVideoInfoFailCallback) | null,
423
488
  /**
424
489
  * 接口调用结束的回调函数(调用成功、失败都会执行)
425
490
  */
426
- complete ?: ((result : any) => void) | null
491
+ complete ?: (GetVideoInfoCompleteCallback) | null
427
492
  };
428
493
 
429
494
  export type GetVideoInfo = (options : GetVideoInfoOptions) => void;
430
495
 
431
- export type SaveVideoToPhotosAlbumSuccessCallback = {};
496
+ export type SaveVideoToPhotosAlbumSuccess = {};
497
+
498
+ export type SaveVideoToPhotosAlbumFail = IMediaError;
499
+ export type SaveVideoToPhotosAlbumSuccessCallback = (callback : SaveVideoToPhotosAlbumSuccess) => void
500
+ export type SaveVideoToPhotosAlbumFailCallback = (callback : SaveVideoToPhotosAlbumFail) => void
501
+ export type SaveVideoToPhotosAlbumCompleteCallback = ChooseImageCompleteCallback
432
502
 
433
503
  export type SaveVideoToPhotosAlbumOptions = {
434
504
  /**
@@ -438,20 +508,20 @@ export type SaveVideoToPhotosAlbumOptions = {
438
508
  /**
439
509
  * 接口调用成功的回调函数
440
510
  */
441
- success ?: ((result : SaveVideoToPhotosAlbumSuccessCallback) => void) | null,
511
+ success ?: (SaveVideoToPhotosAlbumSuccessCallback) | null,
442
512
  /**
443
513
  * 接口调用失败的回调函数
444
514
  */
445
- fail ?: ((result : UniError) => void) | null,
515
+ fail ?: (SaveVideoToPhotosAlbumFailCallback) | null,
446
516
  /**
447
517
  * 接口调用结束的回调函数(调用成功、失败都会执行)
448
518
  */
449
- complete ?: ((result : any) => void) | null
519
+ complete ?: (SaveVideoToPhotosAlbumCompleteCallback) | null
450
520
  };
451
521
 
452
522
  export type SaveVideoToPhotosAlbum = (options : SaveVideoToPhotosAlbumOptions) => void;
453
523
 
454
- export type CompressVideoSuccessCallback = {
524
+ export type CompressVideoSuccess = {
455
525
  /**
456
526
  * 压缩后的临时文件地址
457
527
  */
@@ -462,6 +532,11 @@ export type CompressVideoSuccessCallback = {
462
532
  size : number
463
533
  };
464
534
 
535
+ export type CompressVideoFail = IMediaError;
536
+ export type CompressVideoSuccessCallback = (callback : CompressVideoSuccess) => void
537
+ export type CompressVideoFailCallback = (callback : CompressVideoFail) => void
538
+ export type CompressVideoCompleteCallback = ChooseImageCompleteCallback
539
+
465
540
  export type CompressVideoOptions = {
466
541
  /**
467
542
  * 视频文件路径,可以是临时文件路径也可以是永久文件路径
@@ -490,15 +565,15 @@ export type CompressVideoOptions = {
490
565
  /**
491
566
  * 接口调用成功的回调函数
492
567
  */
493
- success ?: ((result : CompressVideoSuccessCallback) => void) | null,
568
+ success ?: (CompressVideoSuccessCallback) | null,
494
569
  /**
495
570
  * 接口调用失败的回调函数
496
571
  */
497
- fail ?: ((result : UniError) => void) | null,
572
+ fail ?: (CompressVideoFailCallback) | null,
498
573
  /**
499
574
  * 接口调用结束的回调函数(调用成功、失败都会执行)
500
575
  */
501
- complete ?: ((result : any) => void) | null
576
+ complete ?: (CompressVideoCompleteCallback) | null
502
577
  };
503
578
 
504
579
  export type CompressVideo = (options : CompressVideoOptions) => void;
@@ -180,12 +180,14 @@ export class VideoTimeUpdateEvent extends CustomEvent<VideoTimeUpdateEventDetail
180
180
  }
181
181
  }
182
182
 
183
- /**
184
- * @param currentTime 当前进度
185
- * @param duration 总进度
186
- */
187
183
  export type VideoTimeUpdateEventDetail = {
184
+ /**
185
+ * 当前进度
186
+ */
188
187
  currentTime : number,
188
+ /**
189
+ * 总进度
190
+ */
189
191
  duration : number
190
192
  }
191
193
 
@@ -199,12 +201,14 @@ export class VideoFullScreenChangeEvent extends CustomEvent<VideoFullScreenChang
199
201
  }
200
202
  }
201
203
 
202
- /**
203
- * @param fullScreen 是否全屏
204
- * @param direction 横竖屏,取值 vertical 或 horizontal
205
- */
206
204
  export type VideoFullScreenChangeEventDetail = {
205
+ /**
206
+ * 是否全屏
207
+ */
207
208
  fullScreen : boolean,
209
+ /**
210
+ * 横竖屏,取值 vertical 或 horizontal
211
+ */
208
212
  direction : string
209
213
  }
210
214
 
@@ -228,10 +232,10 @@ export class VideoProgressChangeEvent extends CustomEvent<VideoProgressChangeEve
228
232
  }
229
233
  }
230
234
 
231
- /**
232
- * @param buffered 加载进度百分比
233
- */
234
235
  export type VideoProgressChangeEventDetail = {
236
+ /**
237
+ * 加载进度百分比
238
+ */
235
239
  buffered : number
236
240
  }
237
241
 
@@ -245,16 +249,22 @@ export class VideoFullScreenClickEvent extends CustomEvent<VideoFullScreenClickE
245
249
  }
246
250
  }
247
251
 
248
- /**
249
- * @param screenX 点击点相对于屏幕左侧边缘的 X 轴坐标
250
- * @param screenY 点击点相对于屏幕顶部边缘的 Y 轴坐标
251
- * @param screenWidth 屏幕总宽度
252
- * @param screenHeight 屏幕总高度
253
- */
254
252
  export type VideoFullScreenClickEventDetail = {
253
+ /**
254
+ * 点击点相对于屏幕左侧边缘的 X 轴坐标
255
+ */
255
256
  screenX : number,
257
+ /**
258
+ * 点击点相对于屏幕顶部边缘的 Y 轴坐标
259
+ */
256
260
  screenY : number,
261
+ /**
262
+ * 屏幕总宽度
263
+ */
257
264
  screenWidth : number,
265
+ /**
266
+ * 屏幕总高度
267
+ */
258
268
  screenHeight : number
259
269
  }
260
270
 
@@ -268,20 +278,20 @@ export class VideoControlsToggleEvent extends CustomEvent<VideoControlsToggleEve
268
278
  }
269
279
  }
270
280
 
271
- /**
272
- * @param show 是否显示
273
- */
274
281
  export type VideoControlsToggleEventDetail = {
282
+ /**
283
+ * 是否显示
284
+ */
275
285
  show : boolean
276
286
  }
277
287
 
278
288
  /**
279
- * 错误主题
289
+ * 统一错误主题(模块)名称
280
290
  */
281
291
  export const UniErrorSubject = 'uni-video';
282
292
 
283
293
  /**
284
- * 错误码
294
+ * 统一错误码
285
295
  * 100001 网络错误
286
296
  * 200001 内部错误
287
297
  * 300001 SDK错误
@@ -289,17 +299,14 @@ export const UniErrorSubject = 'uni-video';
289
299
  export type VideoErrorCode = 100001 | 200001 | 300001
290
300
 
291
301
  /**
292
- * 错误信息
302
+ * 统一错误描述信息
293
303
  */
294
304
  export const UniErrors : Map<VideoErrorCode, string> = new Map([
295
- [100001, 'video:network error'],
296
- [200001, 'video:internal error'],
297
- [300001, 'video:sdk error']
305
+ [100001, 'network error'],
306
+ [200001, 'internal error'],
307
+ [300001, 'sdk error']
298
308
  ]);
299
309
 
300
- /**
301
- * 错误实现
302
- */
303
310
  export class VideoError extends UniError {
304
311
  constructor(errCode : VideoErrorCode, cause : SourceError | null = null) {
305
312
  super();