文件下载模块

数据结构

`ESDownloadInfo`

下载信息

参数	描述	类型	非空
id	下载的id	`number`	是
fileName	文件名	`string`	是
fileMD5	文件MD5值	`string`	否
fileUrl	文件下载地址	`string`	是
fileType	文件类型	`string`	否
fileLength	文件长度	`number`	否
downloadLength	文件下载的长度	`number`	否
params	下载文件的参数	`ESDownloadParams`	否
filePath	文件存储目录	`string`	否

`ESDownloadParams`

下载请求参数

参数	描述	类型	非空
header	下载请求header参数	`number`	否

`ESDownloadStatus`

下载状态

参数	描述	类型	非空
state	下载状态	`ESDownloadState`	是
download	下载信息	`ESDownloadInfo`	是
code	下载状态码	`number`	否
message	下载信息	`string`	否
downloadSize	下载文件长度	`number`	否
totalSize	下载文件总长度	`number`	否

`ESDownloadState`

下载状态值

参数	描述	类型	非空
ES_DOWNLOAD_STATE_INIT	下载初始化状态	`number`	是
ES_DOWNLOAD_STATE_START	下载开始状态	`number`	是
ES_DOWNLOAD_STATE_PROGRESS	下载进度状态	`number`	否
ES_DOWNLOAD_STATE_STOP	下载停止状态	`number`	否
ES_DOWNLOAD_STATE_CANCEL	下载取消状态	`number`	否
ES_DOWNLOAD_STATE_SUCCESS	下载成功状态	`number`	否
ES_DOWNLOAD_STATE_ERROR	下载错误状态	`number`	否

接口

`initDownload`

该方法初始化默认下载设置。

完整方法声明：function initDownload(): void

参数：

无

返回值：

属性	描述	类型	默认值
无	无	`void`

`initDownloadPath`

该方法初始化下载设置。

完整方法声明：function initDownloadPath(downloadCacheDir: string, interpolator: number): void

参数：

参数	描述	类型	非空
downloadCacheDir	下载文件缓存的目录	`string`	是
interpolator	下载进度回调频率	`number`	是

返回值：

属性	描述	类型	默认值
无	无	`void`

`download`

该方法用于下载。

完整方法声明：function download(download: ESDownloadInfo): void

参数：

参数	描述	类型	非空
download	下载信息	`ESDownloadInfo`	是

返回值：

属性	描述	类型	默认值
无	无	`void`

`start`

该方法用于开始下载。

完整方法声明：function start(download: ESDownloadInfo): void

参数：

参数	描述	类型	非空
download	下载信息	`ESDownloadInfo`	是

返回值：

属性	描述	类型	默认值
无	无	`void`

`stop`

该方法用于停止下载。

完整方法声明：function stop(download: ESDownloadInfo): void

参数：

参数	描述	类型	非空
download	下载信息	`ESDownloadInfo`	是

返回值：

属性	描述	类型	默认值
无	无	`void`

`cancel`

该方法用于取消下载。

完整方法声明：function cancel(download: ESDownloadInfo): void

参数：

参数	描述	类型	非空
download	下载信息	`ESDownloadInfo`	是

返回值：

属性	描述	类型	默认值
无	无	`void`

`release`

该方法用于回收资源。

完整方法声明：function release(): void

参数：

无

返回值：

属性	描述	类型	默认值
无	无	`void`

`addListener`

该方法用于添加监听。

完整方法声明：function addListener(download: ESDownloadInfo, listener: ESDownloadListener): void

参数：

参数	描述	类型	非空
download	下载信息	`ESDownloadInfo`	是
listener	下载监听	`ESDownloadListener`	是

返回值：

属性	描述	类型	默认值
无	无	`void`

`removeListener`

该方法用于删除监听。

完整方法声明：function removeListener(listener: ESDownloadListener): void

参数：

参数	描述	类型	非空
listener	下载监听	`ESDownloadListener`	是

返回值：

属性	描述	类型	默认值
无	无	`void`

基础用法

代码示例：

点击查看源码

TypeScript

vue

<template>
	<div class='es-sdk-root-css'>
		<s-title-view class='es-sdk-content-title-css' :text='this.$options.name' />
		<div class='es-sdk-content-divider-css' />
		<div class='es-sdk-content-column-css'>
			<div class='es-sdk-content-row-css'>
				<s-text-view text='下载状态:' />
				<s-text-view :text='downloadStatus' />
				<s-text-view text='|' />
				<s-text-view text='文件总长度:' />
				<s-text-view :text="totalSizeRef + ''" />
				<s-text-view text='|' />
				<s-text-view text='下载文件长度:' />
				<s-text-view :text="downloadSizeRef + '' " />
			</div>
			<div class='es-sdk-content-column-css'>
				<div class='es-sdk-content-row-css'>
					<s-text-button text='初始化下载' @onButtonClicked='initDownloadModule' />
					<s-text-button text='下载' @onButtonClicked='downloadFile' />
					<s-text-button text='开始' @onButtonClicked='startDownload' />
					<s-text-button text='停止' @onButtonClicked='stopDownload' />
					<s-text-button text='取消' @onButtonClicked='cancelDownload' />
				</div>
			</div>
			<div class='es-sdk-content-column-css'>
				<div class='es-sdk-content-row-css'>
					<s-text-button text='初始化自定义路径' @onButtonClicked='initDownloadPath' />
					<s-text-button text='下载' @onButtonClicked='downloadFile2' />
					<s-text-button text='开始' @onButtonClicked='startDownload2' />
					<s-text-button text='停止' @onButtonClicked='stopDownload2' />
					<s-text-button text='取消' @onButtonClicked='cancelDownload2' />
				</div>
			</div>
		</div>
	</div>
</template>

<script lang='ts'>

import {defineComponent} from '@vue/runtime-core';
import {ref} from 'vue';
import {
	ESDownload,
	ESDownloadInfo,
	ESDownloadListener,
	useESDownload,
} from '@extscreen/es3-core';

export default defineComponent({
	name: '下载模块',
	setup() {

		const download: ESDownload = useESDownload();
		const downloadStatus = ref('');
		const totalSizeRef = ref(0);
		const downloadSizeRef = ref(0);

		const listener: ESDownloadListener = {

			onDownloadInit(download: ESDownloadInfo) {
				console.log('------onDownloadInit----->>>', download);
				downloadStatus.value = '下载初始化';
			},

			onDownloadStart(download: ESDownloadInfo) {
				console.log('------onDownloadStart----->>>', download);
				downloadStatus.value = '下载开始';
			},

			onDownloadStop(download: ESDownloadInfo) {
				console.log('------onDownloadStop----->>>', download);
				downloadStatus.value = '下载停止';
			},

			onDownloadCancel(download: ESDownloadInfo) {
				console.log('------onDownloadCancel----->>>', download);
				downloadStatus.value = '下载取消';
			},

			onDownloadSuccess(download: ESDownloadInfo) {
				console.log('------onDownloadSuccess----->>>', download);
				downloadStatus.value = '下载成功';
			},

			onDownloadError(download: ESDownloadInfo) {
				console.log('------onDownloadError----->>>', download);
				downloadStatus.value = '下载失败';
			},

			onDownloadProgress(download: ESDownloadInfo, downloadSize: number, totalSize: number) {
				console.log('------onDownloadProgress----->>>', download);
				downloadStatus.value = '正在下载';
				totalSizeRef.value = totalSize;
				downloadSizeRef.value = downloadSize;
			},
		};

		const d1: ESDownloadInfo = {
			id: 1,
			fileUrl: 'http://qcloudcdn.a311.ottcn.com/data_center/videos/SHORT/DEFAULT/2023/08/25/7d3623ae-c002-4929-b5a2-fe10bca06bfc.mp4',
			fileMD5: '5e236d028a40cc8e1ec24697dee869a3',
			fileName: 'aaaa.mp4',
		};

		const d2: ESDownloadInfo = {
			id: 2,
			fileUrl: 'http://qcloudcdn.a311.ottcn.com/data_center/videos/SHORT/DEFAULT/2023/09/07/a2d3da6d-469e-4f99-a2d0-c001741003f8.mp4',
			fileMD5: '8d7b49d28365bad9728ba0490b0d5014',
			fileName: 'bbbbbb.mp4',
		};

		function onESCreate(params) {
			download.addListener(d2, listener);
		}

		function onESDestroy() {
			download.removeListener(listener);
		}

		function initDownloadModule() {
			console.log('------initDownloadModule----->>>');
			download.initDownload();
		}

		function downloadFile() {
			console.log('------downloadFile----->>>');
			download.download(d2);
		}

		function startDownload() {
			console.log('------startDownload----->>>');
			download.start(d2);
		}

		function stopDownload() {
			console.log('------stopDownload----->>>');
			download.stop(d2);
		}

		function cancelDownload() {
			console.log('------cancelDownload----->>>');
			download.cancel(d2);
		}

		//-------------------------------------------------
		function initDownloadPath() {
			console.log('------initDownloadModulePath----->>>');
			download.init('/vvvvideo/cache', 1000);
		}

		function downloadFile2() {
			console.log('------downloadFile----->>>');
			download.download(d2);
		}

		function startDownload2() {
			console.log('------startDownload----->>>');
			download.start(d2);
		}

		function stopDownload2() {
			console.log('------stopDownload----->>>');
			download.stop(d2);
		}

		function cancelDownload2() {
			console.log('------cancelDownload----->>>');
			download.cancel(d2);
		}

		return {
			downloadStatus,
			totalSizeRef,
			downloadSizeRef,
			initDownloadModule,
			downloadFile,
			startDownload,
			stopDownload,
			cancelDownload,
			initDownloadPath,
			downloadFile2,
			startDownload2,
			stopDownload2,
			cancelDownload2,
			onESCreate,
			onESDestroy,
		};
	},
});

</script>
<style>
</style>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193

文件下载模块 ​

数据结构 ​

ESDownloadInfo ​

ESDownloadParams ​

ESDownloadStatus ​

ESDownloadState ​

接口 ​

initDownload ​

initDownloadPath ​

download ​

start ​

stop ​

cancel ​

release ​

addListener ​

removeListener ​

基础用法 ​