mix-public 1.2.0 → 1.2.2

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

@@ -0,0 +1,134 @@
+---
+date: 2026-03-06
+permalink: /pages/api-start-audio-recording/
+categories: 
+  - API
+  - 媒体录制
+tags: []
+author: { name: AI Assistant }
+---
+
+# StartAudioRecording - 开始音频录制
+
+## 功能描述
+
+开始音频录制。用于启动设备的麦克风进行音频录制。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+StartAudioRecording(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 开始音频录制
+mixPublicLib.StartAudioRecording();
+
+// 在录音按钮点击时开始录制
+document.getElementById('recordBtn').addEventListener('click', () => {
+  mixPublicLib.StartAudioRecording();
+  console.log("开始录音");
+  // 更新UI状态
+  updateRecordingUI(true);
+});
+
+// 结合停止录音使用
+function startAndStopRecording() {
+  mixPublicLib.StartAudioRecording();
+  // 5秒后自动停止
+  setTimeout(() => {
+    mixPublicLib.StopAudioRecording();
+  }, 5000);
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 开始音频录制
+mixPublicLib.StartAudioRecording();
+
+// 带错误处理的录音开始
+try {
+  mixPublicLib.StartAudioRecording();
+  console.log("录音开始成功");
+} catch (error) {
+  console.error("录音开始失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 启动设备麦克风进行音频录制
+- 通常需要配合 `StopAudioRecording` 使用
+- 录制的音频文件通常保存在临时目录
+
+### 平台差异
+
+- **APP端**: 调用原生音频录制API
+- **Web端**: 使用Web Audio API或MediaRecorder API
+- **小程序**: 使用小程序的录音API
+
+### 音频格式
+
+- **格式**: 通常为WAV、MP3或AAC格式
+- **采样率**: 根据平台和设置而定
+- **比特率**: 通常为高质量设置
+
+### 使用场景
+
+- 语音消息录制
+- 语音备忘录
+- 语音搜索
+- 音频内容创作
+- 语音识别输入
+
+## 注意事项
+
+- **权限要求**: 
+  - 需要麦克风权限
+  - iOS需要在Info.plist中配置麦克风权限描述
+  - Android需要在Manifest中声明录音权限
+- **用户体验**: 
+  - 提供清晰的录音状态提示
+  - 显示录音音量指示器
+  - 处理录音过程中的中断（如来电）
+- **最佳实践**: 
+  - 在开始录音前检查麦克风权限
+  - 提供录音质量设置选项
+  - 处理录音失败的情况
+  - 测试不同设备上的录音效果
+- **兼容性**: 
+  - 不同平台的录音API实现可能不同
+  - 某些浏览器可能不支持MediaRecorder API
+  - 老版本系统可能有兼容性问题
+- **性能考虑**: 
+  - 长时间录音会消耗存储空间
+  - 高质量录音会消耗更多电量
+  - 避免同时进行多个录音操作
+
+## 相关 API
+
+- [`StopAudioRecording`](./112-StopAudioRecording.md) - 停止音频录制
+- [`UploadPhoto`](./025-UploadPhoto.md) - 选择图片
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息

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

@@ -0,0 +1,132 @@
+---
+date: 2026-03-06
+permalink: /pages/api-stop-audio-recording/
+categories: 
+  - API
+  - 媒体录制
+tags: []
+author: { name: AI Assistant }
+---
+
+# StopAudioRecording - 停止音频录制
+
+## 功能描述
+
+停止音频录制。用于结束当前的音频录制会话并保存录制的音频文件。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+StopAudioRecording(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 停止音频录制
+mixPublicLib.StopAudioRecording();
+
+// 在停止按钮点击时停止录制
+document.getElementById('stopBtn').addEventListener('click', () => {
+  mixPublicLib.StopAudioRecording();
+  console.log("录音已停止");
+  // 更新UI状态
+  updateRecordingUI(false);
+});
+
+// 配合开始录音使用
+mixPublicLib.StartAudioRecording();
+// ... 录音进行中 ...
+setTimeout(() => {
+  mixPublicLib.StopAudioRecording(); // 10秒后自动停止
+}, 10000);
+```
+
+### TypeScript 示例
+
+```typescript
+// 停止音频录制
+mixPublicLib.StopAudioRecording();
+
+// 带错误处理的录音停止
+try {
+  mixPublicLib.StopAudioRecording();
+  console.log("录音停止成功");
+} catch (error) {
+  console.error("录音停止失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 停止通过 `StartAudioRecording` 开始的音频录制
+- 保存录制的音频文件到指定位置
+- 释放麦克风和相关系统资源
+
+### 平台差异
+
+- **APP端**: 调用原生音频录制停止方法
+- **Web端**: 停止MediaRecorder或Web Audio API
+- **小程序**: 停止小程序的录音API
+
+### 文件保存
+
+- **保存位置**: 通常保存到应用的临时目录或文档目录
+- **文件格式**: 与开始录制时的设置一致（WAV、MP3等）
+- **文件访问**: 可以通过文件路径访问录制的音频文件
+
+### 使用场景
+
+- 语音消息录制完成
+- 语音备忘录保存
+- 音频内容创作结束
+- 录音时间限制到达
+- 用户手动停止录制
+
+## 注意事项
+
+- **配对使用**: 
+  - 应该与 `StartAudioRecording` 配对使用
+  - 即使没有开始录音，调用此方法也不会报错
+  - 建议在适当的时机调用停止方法
+- **用户体验**: 
+  - 提供明确的录音停止反馈
+  - 显示录制完成的音频文件信息
+  - 处理录音文件的后续操作（播放、上传等）
+- **最佳实践**: 
+  - 在用户操作或时间限制到达时停止录音
+  - 使用try-catch确保停止操作的安全性
+  - 测试不同场景下的录音停止效果
+  - 考虑录音文件的存储和管理
+- **兼容性**: 
+  - 所有支持音频录制的平台都支持停止功能
+  - 某些平台可能自动管理录音资源
+  - 老版本系统可能有不同的实现方式
+- **性能考虑**: 
+  - 停止录音是轻量级操作
+  - 不会影响应用的整体性能
+  - 可以安全地在任何时机调用
+
+## 相关 API
+
+- [`StartAudioRecording`](./111-StartAudioRecording.md) - 开始音频录制
+- [`UploadPhoto`](./025-UploadPhoto.md) - 选择图片
+- [`PlayVideo`](./109-PlayVideo.md) - 播放视频

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/058-GetDeviceInfo.md

@@ -0,0 +1,134 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-device-info/
+categories: 
+  - API
+  - 设备信息
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetDeviceInfo - 获取设备信息
+
+## 功能描述
+
+获取设备的详细信息。返回包含设备型号、系统版本、屏幕尺寸等信息的对象。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GetDeviceInfo(): DeviceInfoType
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+#### DeviceInfoType 接口定义
+
+```typescript
+interface DeviceInfoType {
+  model: string;
+  platform: string;
+  pixelRatio: number;
+  windowWidth: number;
+  windowHeight: number;
+  language: string;
+  version: string;
+  screenWidth: number;
+  screenHeight: number;
+  statusBarHeight: number;
+  [key: string]: any;
+}
+```
+
+### 返回值说明
+
+DeviceInfoType - 返回设备信息对象，包含以下字段：
+- model: 设备型号
+- platform: 客户端平台（ios/android）
+- pixelRatio: 设备像素比
+- windowWidth: 可使用窗口宽度
+- windowHeight: 可使用窗口高度
+- language: 微信设置的语言
+- version: mixPublicLib 版本号
+- screenWidth: 屏幕宽度
+- screenHeight: 屏幕高度
+- statusBarHeight: 状态栏高度
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取设备信息
+const deviceInfo = mixPublicLib.GetDeviceInfo();
+console.log("设备信息:", deviceInfo);
+console.log("设备型号:", deviceInfo.model);
+console.log("屏幕尺寸:", deviceInfo.screenWidth + "x" + deviceInfo.screenHeight);
+
+// 根据平台执行不同逻辑
+if (deviceInfo.platform === 'ios') {
+  console.log("iOS设备");
+} else if (deviceInfo.platform === 'android') {
+  console.log("Android设备");
+}
+```
+
+### TypeScript 示例
+
+```
+import type { DeviceInfoType } from './paramsTypes';
+
+const deviceInfo: DeviceInfoType = mixPublicLib.GetDeviceInfo();
+console.log("设备信息:", deviceInfo);
+
+// 类型安全的属性访问
+console.log(`设备型号: ${deviceInfo.model}`);
+console.log(`平台: ${deviceInfo.platform}`);
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 返回浏览器和设备的基本信息
+- **APP端**: 返回详细的原生设备信息
+- **小程序**: 返回小程序容器提供的设备信息
+
+### 信息用途
+
+- **设备适配**: 根据屏幕尺寸和像素比进行UI适配
+- **平台判断**: 针对不同平台实现特定功能
+- **版本控制**: 根据系统版本提供兼容性处理
+- **语言设置**: 根据用户语言偏好显示内容
+- **性能优化**: 根据设备性能调整功能复杂度
+
+### 常见字段值
+
+- **platform**: "ios", "android", "web"
+- **model**: "iPhone12,1", "SM-G975F", "Windows PC" 等
+
+## 注意事项
+
+- 不同平台返回的字段可能略有差异
+- 某些字段在特定平台上可能为空或默认值
+- 设备型号信息可能因隐私策略而受限
+- 建议对关键字段进行存在性检查
+- 屏幕尺寸单位通常为px（像素）
+- pixelRatio用于计算物理像素和CSS像素的对应关系
+- statusBarHeight在不同设备上差异较大
+- 某些信息可能需要用户授权才能获取
+
+## 相关 API
+
+- [`GetStatusBarHeight`](./070-GetStatusBarHeight.md) - 获取状态栏高度
+- [`GetAppVersion`](./069-GetAppVersion.md) - 获取应用版本
+- [`GetBrightness`](./059-GetBrightness.md) - 获取屏幕亮度
+- [`GetVolume`](./060-GetVolume.md) - 获取音量

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/059-GetBrightness.md

@@ -0,0 +1,104 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-brightness/
+categories: 
+  - API
+  - 设备信息
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetBrightness - 获取屏幕亮度
+
+## 功能描述
+
+获取当前设备的屏幕亮度值。返回0-1之间的数值表示亮度级别。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GetBrightness(): number
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+number - 返回屏幕亮度值，范围0-1（0表示最暗，1表示最亮）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取当前屏幕亮度
+const brightness = mixPublicLib.GetBrightness();
+console.log("当前屏幕亮度:", brightness);
+
+// 根据亮度调整应用主题
+if (brightness < 0.3) {
+  console.log("低亮度环境，启用深色主题");
+} else if (brightness > 0.7) {
+  console.log("高亮度环境，启用浅色主题");
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取当前屏幕亮度
+const brightness: number = mixPublicLib.GetBrightness();
+console.log(`当前屏幕亮度: ${brightness}`);
+
+// 类型安全的亮度处理
+if (typeof brightness === 'number' && brightness >= 0 && brightness <= 1) {
+  console.log("亮度值有效");
+}
+```
+
+## 使用说明
+
+### 亮度值说明
+
+- **范围**: 0.0 - 1.0
+- **0.0**: 最暗（屏幕几乎关闭）
+- **1.0**: 最亮（屏幕最大亮度）
+- **典型值**: 大多数设备的默认亮度在0.5-0.7之间
+
+### 平台差异
+
+- **APP端**: 调用原生API获取真实的屏幕亮度值
+- **Web端**: 可能返回模拟值或固定值（如0.5），因为浏览器通常无法访问系统亮度设置
+- **iOS/Android**: 原生实现，返回准确的亮度值
+
+### 使用场景
+
+- 自动调整应用主题（深色/浅色模式）
+- 根据环境光线优化用户体验
+- 实现自适应亮度功能
+- 节能模式判断
+
+## 注意事项
+
+- Web端可能无法获取真实的屏幕亮度值
+- 某些设备可能对亮度API有权限限制
+- 亮度值可能会动态变化（如自动亮度调节开启时）
+- 建议定期轮询获取最新亮度值（如果需要实时监控）
+- 返回值应该在0-1范围内，但建议进行边界检查
+- 某些Android设备可能返回异常值
+- 亮度获取不需要特殊权限，但设置亮度可能需要
+- 在自动亮度模式下，获取的值反映当前实际亮度而非用户设置值
+
+## 相关 API
+
+- [`Brightness`](./065-Brightness.md) - 设置屏幕亮度
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`GetVolume`](./060-GetVolume.md) - 获取音量

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/060-GetVolume.md

@@ -0,0 +1,105 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-volume/
+categories: 
+  - API
+  - 设备信息
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetVolume - 获取音量
+
+## 功能描述
+
+获取当前设备的音量值。返回0-1之间的数值表示音量级别。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GetVolume(): number
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+number - 返回音量值，范围0-1（0表示静音，1表示最大音量）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取当前音量
+const volume = mixPublicLib.GetVolume();
+console.log("当前音量:", volume);
+
+// 根据音量状态调整应用行为
+if (volume === 0) {
+  console.log("设备处于静音状态");
+} else if (volume > 0.8) {
+  console.log("高音量状态");
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取当前音量
+const volume: number = mixPublicLib.GetVolume();
+console.log(`当前音量: ${volume}`);
+
+// 类型安全的音量处理
+if (typeof volume === 'number' && volume >= 0 && volume <= 1) {
+  console.log("音量值有效");
+}
+```
+
+## 使用说明
+
+### 音量值说明
+
+- **范围**: 0.0 - 1.0
+- **0.0**: 静音（无声音输出）
+- **1.0**: 最大音量（设备支持的最大音量）
+- **典型值**: 大多数设备的默认音量在0.5-0.7之间
+
+### 平台差异
+
+- **APP端**: 调用原生API获取真实的系统音量值
+- **Web端**: 可能返回模拟值或固定值（如0.5），因为浏览器通常无法访问系统音量设置
+- **iOS/Android**: 原生实现，返回准确的音量值
+
+### 使用场景
+
+- 检测设备是否处于静音状态
+- 根据当前音量调整媒体播放行为
+- 实现音量相关的用户提示
+- 音频应用的音量状态管理
+
+## 注意事项
+
+- Web端可能无法获取真实的系统音量值
+- 某些设备可能对音量API有权限限制
+- 音量值可能会动态变化（如用户调整音量时）
+- 不同音频流（媒体、通话、通知）可能有不同的音量设置
+- 此方法通常返回媒体音量或主音量
+- 返回值应该在0-1范围内，但建议进行边界检查
+- 某些Android设备可能返回异常值
+- 音量获取不需要特殊权限，但设置音量可能需要
+- 在某些情况下，系统可能限制音量读取（如隐私保护）
+
+## 相关 API
+
+- [`VolumeControl`](./066-VolumeControl.md) - 音量控制
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`GetBrightness`](./059-GetBrightness.md) - 获取屏幕亮度