mix-public 1.2.0 → 1.2.2

package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/100-StopHttpServer.md

@@ -0,0 +1,137 @@
+---
+date: 2026-03-06
+permalink: /pages/api-stop-http-server/
+categories: 
+  - API
+  - 网络服务
+tags: []
+author: { name: AI Assistant }
+---
+
+# StopHttpServer - 停止HTTP服务器
+
+## 功能描述
+
+停止本地HTTP服务器。用于关闭之前启动的本地Web服务。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+StopHttpServer(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 停止HTTP服务器
+mixPublicLib.StopHttpServer();
+
+// 在应用退出时停止服务器
+window.addEventListener('beforeunload', () => {
+  mixPublicLib.StopHttpServer();
+  console.log("HTTP服务器已停止");
+});
+
+// 配合StartHttpServer使用
+mixPublicLib.StartHttpServer({ port: 8080 });
+// ... 服务器运行期间 ...
+setTimeout(() => {
+  mixPublicLib.StopHttpServer(); // 5分钟后自动停止
+}, 5 * 60 * 1000);
+
+// 处理服务器停止后的清理工作
+function cleanupAfterServerStop() {
+  mixPublicLib.StopHttpServer();
+  // 清理相关资源
+  clearServerResources();
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 停止HTTP服务器
+mixPublicLib.StopHttpServer();
+
+// 带错误处理的服务器停止
+try {
+  mixPublicLib.StopHttpServer();
+  console.log("HTTP服务器停止成功");
+} catch (error) {
+  console.error("HTTP服务器停止失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 停止通过 `StartHttpServer` 启动的本地HTTP服务器
+- 释放服务器占用的端口和系统资源
+- 关闭所有活跃的HTTP连接
+
+### 平台差异
+
+- **APP端**: 调用原生HTTP服务器停止方法
+- **Web端**: 可能不支持或提供模拟功能
+- **桌面应用**: 调用后端服务器停止逻辑
+
+### 资源管理
+
+- **端口释放**: 释放被服务器占用的端口号
+- **内存清理**: 释放服务器相关的内存资源
+- **连接关闭**: 关闭所有活跃的客户端连接
+
+### 使用场景
+
+- 应用退出时的服务器清理
+- 临时服务器的按需停止
+- 服务器重启前的停止操作
+- 资源优化时的服务器关闭
+- 错误恢复时的服务器重置
+
+## 注意事项
+
+- **配对使用**: 
+  - 应该与 `StartHttpServer` 配对使用
+  - 即使没有启动服务器，调用此方法也不会报错
+  - 建议在应用生命周期结束时调用
+- **用户体验**: 
+  - 停止服务器通常是后台操作
+  - 活跃的客户端连接会被强制断开
+  - 提供服务器停止状态的反馈
+- **最佳实践**: 
+  - 在应用退出或页面卸载时停止服务器
+  - 使用try-catch确保停止操作的安全性
+  - 测试不同场景下的服务器停止效果
+  - 考虑服务器停止后的资源清理
+- **兼容性**: 
+  - 所有支持HTTP服务器的平台都支持停止功能
+  - 某些平台可能自动管理服务器资源
+  - 老版本系统可能有不同的实现方式
+- **性能考虑**: 
+  - 停止服务器是轻量级操作
+  - 不会影响应用的整体性能
+  - 可以安全地在任何时机调用
+
+## 相关 API
+
+- [`StartHttpServer`](./099-StartHttpServer.md) - 启动HTTP服务器
+- [`IsNet`](./062-IsNet.md) - 检测网络状态
+- [`ExitApp`](./074-ExitApp.md) - 退出应用

package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/103-CacheSize.md

@@ -0,0 +1,131 @@
+---
+date: 2026-03-06
+permalink: /pages/api-cache-size/
+categories: 
+  - API
+  - 应用信息
+tags: []
+author: { name: AI Assistant }
+---
+
+# CacheSize - 获取缓存大小
+
+## 功能描述
+
+获取应用当前的缓存占用大小。用于显示存储空间使用情况。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+``typescript
+CacheSize(): string
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+string - 返回缓存大小字符串（格式如："1.23MB"、"456KB"、"0B"）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取缓存大小
+const cacheSize = mixPublicLib.CacheSize();
+console.log("当前缓存大小:", cacheSize);
+
+// 在设置页面显示缓存信息
+document.getElementById('cacheInfo').textContent = `缓存大小: ${cacheSize}`;
+
+// 根据缓存大小提供清理建议
+if (cacheSize.endsWith('MB') || cacheSize.endsWith('GB')) {
+  const sizeValue = parseFloat(cacheSize);
+  if (sizeValue > 100) {
+    console.log("缓存较大，建议清理");
+    showClearCacheButton();
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取缓存大小
+const cacheSize: string = mixPublicLib.CacheSize();
+console.log(`当前缓存大小: ${cacheSize}`);
+
+// 类型安全的缓存大小处理
+if (typeof cacheSize === 'string' && cacheSize.length > 0) {
+  console.log("缓存大小信息有效");
+}
+```
+
+## 使用说明
+
+### 返回格式
+
+- **字节**: "0B"（当缓存为0时）
+- **千字节**: "456KB"（小于1MB时）
+- **兆字节**: "1.23MB"（大于等于1MB时）
+- **吉字节**: "2.5GB"（大于等于1GB时）
+
+### 平台差异
+
+- **APP端**: 返回原生应用的实际缓存大小
+- **Web端**: 返回浏览器存储（localStorage、sessionStorage、Cache API等）的估算大小
+- **小程序**: 返回小程序存储的缓存大小
+
+### 缓存包含内容
+
+- **网络缓存**: HTTP请求的响应缓存
+- **图片缓存**: 下载的图片文件
+- **数据缓存**: 本地存储的用户数据
+- **临时文件**: 应用生成的临时文件
+- **数据库缓存**: SQLite或其他本地数据库的数据
+
+### 使用场景
+
+- 应用设置页面的存储信息显示
+- 缓存清理功能的触发条件
+- 存储空间使用情况监控
+- 用户存储管理界面
+- 性能优化的参考指标
+
+## 注意事项
+
+- **精度限制**: 
+  - Web端的缓存大小可能是估算值
+  - 某些缓存类型可能无法精确计算
+  - 返回值为字符串格式，需要解析才能进行数值比较
+- **平台差异**: 
+  - 不同平台的缓存计算方式可能不同
+  - Web端受浏览器存储限制影响
+  - 某些系统可能不支持精确的缓存大小获取
+- **用户体验**: 
+  - 提供清晰的缓存大小显示
+  - 结合缓存清理功能使用
+  - 考虑用户的存储空间管理需求
+- **最佳实践**: 
+  - 定期更新缓存大小显示
+  - 提供缓存清理的快捷入口
+  - 测试不同设备上的缓存计算准确性
+  - 考虑缓存大小对应用性能的影响
+- **兼容性**: 
+  - 老版本系统可能返回不准确的值
+  - 某些设备可能有特殊的缓存管理机制
+  - Web端的兼容性取决于浏览器支持
+
+## 相关 API
+
+- [`ClearAppCache`](./073-ClearAppCache.md) - 清理APP缓存
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`DownloadFileDelete`](./041-DownloadFileDelete.md) - 删除已完成下载

package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/106-UploadVideo.md

@@ -0,0 +1,132 @@
+---
+date: 2026-03-06
+permalink: /pages/api-upload-video/
+categories: 
+  - API
+  - 媒体处理
+tags: []
+author: { name: AI Assistant }
+---
+
+# UploadVideo - 视频上传
+
+## 功能描述
+
+选择并上传视频文件。支持从相册选择或直接拍摄视频。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+UploadVideo(option: { 
+  isCut: boolean; 
+  Quality: number; 
+}): Promise<object>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| isCut | boolean | 是 | 是否裁剪 | false |
+| Quality | number | 是 | 质量（0-1） | 1 |
+
+### 返回值说明
+
+Promise<object> - 返回选择的视频文件对象
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 上传视频（不裁剪，最高质量）
+mixPublicLib.UploadVideo({ 
+  isCut: false, 
+  Quality: 1 
+})
+.then(file => {
+  console.log("选择的视频文件:", file);
+  // 处理视频文件上传
+  uploadFileToServer(file);
+})
+.catch(error => {
+  console.error("选择视频失败:", error);
+});
+
+// 上传视频（裁剪，中等质量）
+mixPublicLib.UploadVideo({ 
+  isCut: true, 
+  Quality: 0.7 
+})
+.then(file => {
+  console.log("裁剪后的视频文件:", file);
+})
+.catch(error => {
+  console.error("选择视频失败:", error);
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SelectPhotoType } from './paramsTypes';
+
+const options: SelectPhotoType = {
+  isCut: false,
+  Quality: 1
+};
+
+mixPublicLib.UploadVideo(options)
+  .then((file: object) => {
+    console.log("选择的视频文件:", file);
+    // 处理视频文件
+  })
+  .catch((error: any) => {
+    console.error("选择视频失败:", error);
+  });
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 调用文件选择器，仅能从本地文件系统选择视频
+- **APP端**: 唤起系统相册或相机，可以从设备相册中选择或拍摄视频
+
+### 参数说明
+
+- **isCut**: 
+  - `true`: 启用视频裁剪功能
+  - `false`: 不进行裁剪，直接返回原视频
+- **Quality**: 
+  - 取值范围：0-1
+  - 1表示最高质量，0表示最低质量
+  - 质量值会影响最终视频的文件大小和清晰度
+
+### 返回值处理
+
+- 返回的Promise解析后得到视频文件对象
+- 文件对象可以用于上传、播放或其他处理
+- Web端返回的是File对象，APP端返回的是经过格式化处理的文件对象
+
+## 注意事项
+
+- 需要用户授权相册和相机权限（APP端）
+- Web端受浏览器安全策略限制，只能选择本地文件
+- 裁剪功能在不同平台的实现可能略有差异
+- 高质量视频可能导致文件过大，影响上传性能
+- 建议根据实际需求调整Quality参数以平衡质量和性能
+- 错误处理很重要，用户可能取消选择操作
+- 视频文件大小可能受到平台限制
+- 某些格式的视频可能不被支持
+
+## 相关 API
+
+- [`UploadPhoto`](./025-UploadPhoto.md) - 选择图片（相机或相册）
+- [`LibraryPhoto`](./026-LibraryPhoto.md) - 相册选择图片
+- [`CameraPhoto`](./027-CameraPhoto.md) - 相机拍摄图片
+- [`PlayVideo`](./109-PlayVideo.md) - 播放视频

package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/109-PlayVideo.md

@@ -0,0 +1,137 @@
+---
+date: 2026-03-06
+permalink: /pages/api-play-video/
+categories: 
+  - API
+  - 媒体播放
+tags: []
+author: { name: AI Assistant }
+---
+
+# PlayVideo - 播放视频
+
+## 功能描述
+
+播放指定的视频文件。支持本地视频文件和网络视频URL的播放。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+PlayVideo(option: { 
+  videoPath: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| videoPath | string | 是 | 视频文件路径或URL | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 播放本地视频文件
+mixPublicLib.PlayVideo({ 
+  videoPath: "/path/to/local/video.mp4" 
+});
+
+// 播放网络视频
+mixPublicLib.PlayVideo({ 
+  videoPath: "https://example.com/video.mp4" 
+});
+
+// 播放下载的视频
+const downloadedVideo = getDownloadedVideoPath();
+if (downloadedVideo) {
+  mixPublicLib.PlayVideo({ videoPath: downloadedVideo });
+}
+
+// 在用户点击后播放视频
+document.getElementById('playBtn').addEventListener('click', () => {
+  mixPublicLib.PlayVideo({ 
+    videoPath: "https://cdn.example.com/tutorial.mp4" 
+  });
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { PlayVideoType } from './paramsTypes';
+
+// 播放视频
+const videoOptions: PlayVideoType = {
+  videoPath: "https://example.com/video.mp4"
+};
+mixPublicLib.PlayVideo(videoOptions);
+```
+
+## 使用说明
+
+### 支持的视频格式
+
+- **MP4**: H.264编码，AAC音频
+- **MOV**: QuickTime格式
+- **AVI**: Audio Video Interleave
+- **MKV**: Matroska格式（取决于平台支持）
+- **WebM**: Web媒体格式（Web端）
+
+### 视频源类型
+
+- **本地文件**: 设备存储中的视频文件
+- **网络URL**: HTTP/HTTPS协议的视频链接
+- **相对路径**: 应用资源目录中的视频文件
+
+### 平台差异
+
+- **APP端**: 调用原生视频播放器
+- **Web端**: 使用HTML5 video标签或全屏播放器
+- **小程序**: 使用小程序的video组件
+
+### 播放控制
+
+- **自动播放**: 视频加载后自动开始播放
+- **全屏模式**: 通常以全屏模式播放
+- **用户控制**: 提供播放、暂停、进度条等控制
+
+## 注意事项
+
+- **网络要求**: 
+  - 网络视频需要有效的网络连接
+  - 大视频文件可能需要较长时间缓冲
+  - 建议提供加载状态提示
+- **格式兼容性**: 
+  - 不同平台支持的视频格式可能不同
+  - 建议使用MP4格式以获得最佳兼容性
+  - 某些编码格式可能不被支持
+- **用户体验**: 
+  - 提供清晰的播放入口
+  - 考虑移动设备的数据流量消耗
+  - 处理视频加载失败的情况
+- **最佳实践**: 
+  - 验证视频路径的有效性
+  - 提供视频播放的替代方案
+  - 测试不同网络条件下的播放效果
+  - 考虑视频的版权和授权问题
+- **性能考虑**: 
+  - 大视频文件可能消耗较多内存
+  - 避免同时播放多个视频
+  - 考虑电池消耗的影响
+
+## 相关 API
+
+- [`UploadVideo`](./106-UploadVideo.md) - 视频上传
+- [`VideoDownload`](./110-VideoDownload.md) - 视频下载
+- [`FilesPreview`](./042-FilesPreview.md) - 文件预览
+- [`GoToVideo`](./012-GoToVideo.md) - 打开视频

package/docs/api//346/226/207/344/273/266/346/223/215/344/275/234/110-VideoDownload.md

@@ -0,0 +1,137 @@
+---
+date: 2026-03-06
+permalink: /pages/api-video-download/
+categories: 
+  - API
+  - 媒体处理
+tags: []
+author: { name: AI Assistant }
+---
+
+# VideoDownload - 视频下载
+
+## 功能描述
+
+下载视频文件到本地存储。用于将网络视频保存到设备中供离线播放。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+VideoDownload(option: { 
+  videoUrl: string; 
+  fileName: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| videoUrl | string | 是 | 视频下载地址 | "" |
+| fileName | string | 是 | 保存的文件名 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 下载视频文件
+mixPublicLib.VideoDownload({ 
+  videoUrl: "https://example.com/video.mp4",
+  fileName: "tutorial_video.mp4"
+});
+
+// 动态生成文件名
+const timestamp = new Date().getTime();
+mixPublicLib.VideoDownload({ 
+  videoUrl: "https://cdn.example.com/lecture.mp4",
+  fileName: `lecture_${timestamp}.mp4`
+});
+
+// 在用户确认后下载视频
+if (confirm("确定要下载这个视频吗？")) {
+  mixPublicLib.VideoDownload({ 
+    videoUrl: getCurrentVideoUrl(),
+    fileName: getVideoFileName()
+  });
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { VideoDownloadType } from './paramsTypes';
+
+// 下载视频
+const downloadOptions: VideoDownloadType = {
+  videoUrl: "https://example.com/video.mp4",
+  fileName: "tutorial_video.mp4"
+};
+mixPublicLib.VideoDownload(downloadOptions);
+```
+
+## 使用说明
+
+### 文件命名
+
+- **文件扩展名**: 建议包含正确的视频文件扩展名（.mp4, .mov等）
+- **文件名格式**: 支持中文、英文、数字和常见符号
+- **重复文件**: 可能会覆盖同名文件或自动重命名
+
+### 支持的视频格式
+
+- **MP4**: 最广泛支持的格式
+- **MOV**: QuickTime格式
+- **AVI**: Audio Video Interleave
+- **其他格式**: 取决于平台支持情况
+
+### 平台差异
+
+- **APP端**: 调用原生下载管理器，保存到应用沙盒或相册
+- **Web端**: 触发浏览器下载对话框
+- **小程序**: 可能保存到临时目录或提供下载链接
+
+### 下载管理
+
+- **进度监控**: 可能通过其他API获取下载进度
+- **存储位置**: 通常保存到应用的文档目录
+- **文件访问**: 下载后的文件可以通过文件路径访问
+
+## 注意事项
+
+- **网络要求**: 
+  - 需要有效的网络连接
+  - 大视频文件可能需要较长时间下载
+  - 建议提供下载进度提示
+- **存储空间**: 
+  - 需要足够的设备存储空间
+  - 大视频文件可能占用大量空间
+  - 建议在下载前检查可用空间
+- **权限要求**: 
+  - APP端需要存储写入权限
+  - Web端受浏览器安全策略限制
+  - 某些平台可能需要用户确认下载
+- **最佳实践**: 
+  - 验证视频URL的有效性
+  - 提供下载完成的通知
+  - 处理下载失败的情况
+  - 测试不同网络条件下的下载效果
+- **兼容性**: 
+  - 不同平台的下载行为可能不同
+  - 某些视频源可能有防盗链限制
+  - 老版本系统可能有兼容性问题
+
+## 相关 API
+
+- [`DownloadFiles`](./038-DownloadFiles.md) - 文件下载
+- [`getDownloadFileProgress`](./040-getDownloadFileProgress.md) - 获取下载进度
+- [`DownloadFileDelete`](./041-DownloadFileDelete.md) - 删除已完成下载
+- [`PlayVideo`](./109-PlayVideo.md) - 播放视频