mix-public 1.2.0 → 1.2.2

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

@@ -0,0 +1,134 @@
+---
+date: 2026-03-06
+permalink: /pages/api-brightness/
+categories: 
+  - API
+  - 设备控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# Brightness - 设置屏幕亮度
+
+## 功能描述
+
+设置设备屏幕亮度。用于调整屏幕的亮度级别。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+Brightness(option: { 
+  Value: number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Value | number | 是 | 亮度值（0-1之间） | 0.8 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 设置屏幕亮度为最大值
+mixPublicLib.Brightness({ 
+  Value: 1 
+});
+
+// 设置屏幕亮度为50%
+mixPublicLib.Brightness({ 
+  Value: 0.5 
+});
+
+// 设置屏幕亮度为最小值
+mixPublicLib.Brightness({ 
+  Value: 0 
+});
+
+// 根据环境光线动态调整亮度
+const ambientLightLevel = 0.8; // 假设的环境光强度
+mixPublicLib.Brightness({ 
+  Value: Math.min(ambientLightLevel, 1) 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { BrightnessType } from './paramsTypes';
+
+// 设置高亮度
+const highBrightness: BrightnessType = {
+  Value: 1
+};
+mixPublicLib.Brightness(highBrightness);
+
+// 设置中等亮度
+const mediumBrightness: BrightnessType = {
+  Value: 0.5
+};
+mixPublicLib.Brightness(mediumBrightness);
+```
+
+## 使用说明
+
+### 亮度值说明
+
+- **范围**: 0.0 - 1.0
+- **0.0**: 最暗（屏幕几乎关闭）
+- **1.0**: 最亮（屏幕最大亮度）
+- **典型值**: 0.5 表示50%亮度
+
+### 平台差异
+
+- **APP端**: 调用原生API设置系统屏幕亮度
+- **Web端**: 可能无法设置系统亮度，但可以调整页面元素的显示亮度
+- **iOS/Android**: 原生实现，可以直接控制系统亮度
+
+### 使用场景
+
+- 阅读模式的亮度调节
+- 夜间模式的自动亮度调整
+- 视频播放时的亮度优化
+- 节能模式的亮度降低
+- 用户自定义亮度设置
+
+## 注意事项
+
+- **权限要求**: 
+  - APP端通常需要特殊权限才能修改系统亮度
+  - Web端通常无法修改系统亮度设置
+  - 某些Android版本可能限制第三方应用修改亮度
+- **用户体验**: 
+  - 突然的亮度变化可能影响用户体验
+  - 建议提供平滑的亮度过渡效果
+  - 在用户明确操作后调整亮度（如点击按钮）
+- **系统限制**: 
+  - 某些设备可能忽略亮度设置请求
+  - 自动亮度调节开启时可能覆盖手动设置
+  - 系统可能有最低亮度限制
+- **最佳实践**: 
+  - 提供亮度调节的UI控件
+  - 记住用户的亮度偏好设置
+  - 在适当的时候恢复默认亮度
+  - 考虑电池消耗的影响
+- **兼容性**: 
+  - 老版本操作系统可能不支持此功能
+  - 某些设备厂商可能有自定义的亮度控制机制
+
+## 相关 API
+
+- [`GetBrightness`](./059-GetBrightness.md) - 获取屏幕亮度
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`VolumeControl`](./066-VolumeControl.md) - 音量控制

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

@@ -0,0 +1,142 @@
+---
+date: 2026-03-06
+permalink: /pages/api-volume-control/
+categories: 
+  - API
+  - 设备控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# VolumeControl - 音量控制
+
+## 功能描述
+
+设置设备音量。用于调整系统音量级别。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+VolumeControl(option: { 
+  Value: number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Value | number | 是 | 音量值（0-1之间） | 0.8 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 设置音量为最大值
+mixPublicLib.VolumeControl({ 
+  Value: 1 
+});
+
+// 设置音量为50%
+mixPublicLib.VolumeControl({ 
+  Value: 0.5 
+});
+
+// 设置音量为静音
+mixPublicLib.VolumeControl({ 
+  Value: 0 
+});
+
+// 根据用户偏好动态调整音量
+const userVolumePreference = 0.8;
+mixPublicLib.VolumeControl({ 
+  Value: userVolumePreference 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { VolumeControlType } from './paramsTypes';
+
+// 设置高音量
+const highVolume: VolumeControlType = {
+  Value: 1
+};
+mixPublicLib.VolumeControl(highVolume);
+
+// 设置中等音量
+const mediumVolume: VolumeControlType = {
+  Value: 0.5
+};
+mixPublicLib.VolumeControl(mediumVolume);
+```
+
+## 使用说明
+
+### 音量值说明
+
+- **范围**: 0.0 - 1.0
+- **0.0**: 静音（无声音输出）
+- **1.0**: 最大音量（设备支持的最大音量）
+- **典型值**: 0.5 表示50%音量
+
+### 平台差异
+
+- **APP端**: 调用原生API设置系统音量
+- **Web端**: 可能无法设置系统音量，但可以调整页面内媒体元素的音量
+- **iOS/Android**: 原生实现，可以直接控制系统音量
+
+### 音频流类型
+
+- **媒体音量**: 视频、音乐等媒体播放的音量
+- **通话音量**: 电话通话的音量
+- **通知音量**: 系统通知和提示音的音量
+- **此方法通常控制媒体音量**
+
+### 使用场景
+
+- 媒体播放器的音量调节
+- 视频播放时的音量优化
+- 用户自定义音量设置
+- 静音模式的快速切换
+- 音频应用的音量控制
+
+## 注意事项
+
+- **权限要求**: 
+  - APP端可能需要特殊权限才能修改系统音量
+  - Web端通常无法修改系统音量设置
+  - 某些Android版本可能限制第三方应用修改音量
+- **用户体验**: 
+  - 突然的音量变化可能影响用户体验
+  - 建议提供平滑的音量过渡效果
+  - 在用户明确操作后调整音量（如点击按钮）
+- **系统限制**: 
+  - 某些设备可能忽略音量设置请求
+  - 系统可能有最低音量限制
+  - 静音模式下可能无法调整音量
+- **最佳实践**: 
+  - 提供音量调节的UI控件（如滑块）
+  - 记住用户的音量偏好设置
+  - 在适当的时候恢复默认音量
+  - 考虑不同音频流的独立控制需求
+- **兼容性**: 
+  - 老版本操作系统可能不支持此功能
+  - 某些设备厂商可能有自定义的音量控制机制
+  - iOS对音量控制有更严格的限制
+
+## 相关 API
+
+- [`GetVolume`](./060-GetVolume.md) - 获取音量
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`Brightness`](./065-Brightness.md) - 设置屏幕亮度

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

@@ -0,0 +1,118 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-app-version/
+categories: 
+  - API
+  - 应用信息
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetAppVersion - 获取应用版本
+
+## 功能描述
+
+获取当前应用的版本信息。返回应用的版本号字符串。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GetAppVersion(): string
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+string - 返回应用版本号字符串（格式如：1.0.0）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取应用版本
+const appVersion = mixPublicLib.GetAppVersion();
+console.log("应用版本:", appVersion);
+
+// 根据版本号执行不同逻辑
+if (appVersion === "1.0.0") {
+  console.log("这是初始版本");
+} else if (appVersion.startsWith("2.")) {
+  console.log("这是2.x版本");
+}
+
+// 显示版本信息给用户
+document.getElementById('versionInfo').textContent = `当前版本: ${appVersion}`;
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取应用版本
+const appVersion: string = mixPublicLib.GetAppVersion();
+console.log(`应用版本: ${appVersion}`);
+
+// 类型安全的版本处理
+if (typeof appVersion === 'string' && appVersion.length > 0) {
+  console.log("版本信息有效");
+}
+```
+
+## 使用说明
+
+### 版本格式
+
+- **标准格式**: `主版本.次版本.修订版本`（如：1.2.3）
+- **可能包含**: 构建号、alpha/beta标识等（如：1.2.3-beta.1）
+- **Web端**: 可能返回网页版本或构建时间戳
+
+### 平台差异
+
+- **APP端**: 返回原生应用的版本号（从应用配置中读取）
+- **Web端**: 返回网页应用的版本信息或构建标识
+- **小程序**: 返回小程序的版本号
+
+### 使用场景
+
+- 应用关于页面显示版本信息
+- 版本兼容性检查
+- Bug报告中的版本标识
+- 自动更新检测
+- A/B测试的版本分组
+
+## 注意事项
+
+- **版本来源**: 
+  - APP端从AndroidManifest.xml或Info.plist读取
+  - Web端从构建配置或meta标签读取
+  - 版本格式可能因平台而异
+- **一致性**: 
+  - 不同平台的版本号可能不一致
+  - 建议统一版本管理策略
+- **解析处理**: 
+  - 版本字符串需要手动解析比较
+  - 建议使用专门的版本比较库进行复杂比较
+  - 简单的字符串比较可能不准确（如"1.10.0" < "1.2.0"）
+- **最佳实践**: 
+  - 在应用启动时缓存版本信息
+  - 提供版本信息的用户展示界面
+  - 结合版本信息提供针对性的功能
+  - 在错误报告中包含版本信息
+- **兼容性**: 
+  - 老版本应用可能返回不同的格式
+  - 某些构建环境下版本信息可能为空
+
+## 相关 API
+
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`GetStatusBarHeight`](./070-GetStatusBarHeight.md) - 获取状态栏高度
+- [`OnlineService`](./104-OnlineService.md) - 在线客服

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

@@ -0,0 +1,121 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-status-bar-height/
+categories: 
+  - API
+  - 设备信息
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetStatusBarHeight - 获取状态栏高度
+
+## 功能描述
+
+获取设备状态栏的高度。用于适配不同设备的状态栏尺寸。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GetStatusBarHeight(): number
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+number - 返回状态栏高度（单位：px）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取状态栏高度
+const statusBarHeight = mixPublicLib.GetStatusBarHeight();
+console.log("状态栏高度:", statusBarHeight + "px");
+
+// 根据状态栏高度调整页面布局
+const headerElement = document.getElementById('header');
+if (headerElement) {
+  headerElement.style.paddingTop = statusBarHeight + 'px';
+}
+
+// 适配全面屏设备
+if (statusBarHeight > 40) {
+  console.log("可能是全面屏或刘海屏设备");
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取状态栏高度
+const statusBarHeight: number = mixPublicLib.GetStatusBarHeight();
+console.log(`状态栏高度: ${statusBarHeight}px`);
+
+// 类型安全的高度处理
+if (typeof statusBarHeight === 'number' && statusBarHeight > 0) {
+  console.log("状态栏高度有效");
+}
+```
+
+## 使用说明
+
+### 高度单位
+
+- **单位**: 像素（px）
+- **典型值**: 
+  - iPhone X及以后: 44px
+  - Android标准: 24px-28px
+  - 全面屏设备: 可能高达50px以上
+
+### 平台差异
+
+- **iOS**: 返回准确的状态栏高度，包括刘海屏的额外高度
+- **Android**: 返回状态栏高度，可能因厂商定制而异
+- **Web端**: 可能返回模拟值或通过CSS计算得出
+
+### 使用场景
+
+- 页面顶部布局适配
+- 全面屏设备的UI适配
+- 状态栏与应用内容的间距调整
+- 自定义导航栏的高度计算
+- 沉浸式设计的实现
+
+## 注意事项
+
+- **设备差异**: 
+  - 不同设备的状态栏高度差异很大
+  - 刘海屏、挖孔屏等特殊屏幕有额外的高度
+  - 横屏模式下状态栏高度可能不同
+- **动态变化**: 
+  - 某些设备在特定模式下状态栏高度会变化
+  - 通话状态、热点开启等可能影响状态栏高度
+- **最佳实践**: 
+  - 在页面加载时获取状态栏高度
+  - 使用CSS变量或JavaScript动态设置样式
+  - 考虑横竖屏切换时的适配
+  - 提供合理的默认值作为后备方案
+- **兼容性**: 
+  - 老设备可能返回不准确的值
+  - 某些Android定制ROM可能有特殊的状态栏实现
+  - Web端的准确性有限，主要用于APP端
+- **性能考虑**: 
+  - 状态栏高度通常不会频繁变化
+  - 建议缓存获取的值避免重复调用
+
+## 相关 API
+
+- [`SetStatusBarBgColor`](./052-SetStatusBarBgColor.md) - 设置状态栏背景色
+- [`SetStatusBarStyle`](./053-SetStatusBarStyle.md) - 设置状态栏样式
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息

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

@@ -0,0 +1,130 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-app-icons-path/
+categories: 
+  - API
+  - 应用信息
+tags: []
+author: { name: AI Assistant }
+---
+
+# GetAppIconsPath - 获取应用图标路径
+
+## 功能描述
+
+获取应用图标的本地存储路径。用于访问或操作应用图标文件。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GetAppIconsPath(): Array<string>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+Array<string> - 返回应用图标的本地文件路径数组
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取应用图标路径
+const iconPath = mixPublicLib.GetAppIconsPath();
+console.log("应用图标路径:", iconPath);
+
+// 使用图标路径显示应用图标
+const imgElement = document.getElementById('appIcon');
+if (imgElement) {
+  imgElement.src = iconPath;
+}
+
+// 检查图标文件是否存在
+if (iconPath && iconPath.length > 0) {
+  console.log("图标路径有效");
+} else {
+  console.log("无法获取图标路径");
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取应用图标路径
+const iconPath: string = mixPublicLib.GetAppIconsPath();
+console.log(`应用图标路径: ${iconPath}`);
+
+// 类型安全的路径处理
+if (typeof iconPath === 'string' && iconPath.trim().length > 0) {
+  console.log("图标路径有效");
+}
+```
+
+## 使用说明
+
+### 路径格式
+
+- **APP端**: 返回本地文件系统路径（如：`/data/app/com.example.app/icon.png`）
+- **Web端**: 可能返回相对路径或绝对URL（如：`/assets/icon.png`）
+- **小程序**: 返回小程序资源路径
+
+### 文件格式
+
+- 通常为PNG格式
+- 可能包含多个尺寸的图标文件
+- 路径指向默认的应用图标
+
+### 平台差异
+
+- **iOS**: 返回应用Bundle中的图标路径
+- **Android**: 返回APK中的图标资源路径
+- **Web端**: 返回网页favicon或manifest中定义的图标路径
+- **小程序**: 返回小程序配置中的图标路径
+
+### 使用场景
+
+- 显示应用图标在设置页面
+- 分享应用时使用应用图标
+- 应用信息展示
+- 自定义通知图标
+- 应用快捷方式创建
+
+## 注意事项
+
+- **路径有效性**: 
+  - 返回的路径可能因平台而异
+  - 某些平台可能返回空字符串或null
+  - 路径可能指向只读资源
+- **权限要求**: 
+  - APP端通常不需要特殊权限
+  - Web端受同源策略限制
+  - 某些Android版本可能限制文件系统访问
+- **兼容性**: 
+  - 不同平台的路径格式差异很大
+  - 老版本系统可能不支持此功能
+  - 某些设备可能有自定义的图标管理机制
+- **最佳实践**: 
+  - 在使用前验证路径的有效性
+  - 提供默认图标作为后备方案
+  - 考虑不同平台的路径处理差异
+  - 测试不同设备上的图标显示效果
+- **安全性**: 
+  - 不要直接暴露文件系统路径给用户
+  - 避免将路径用于敏感操作
+  - 考虑路径注入的安全风险
+
+## 相关 API
+
+- [`GetAppVersion`](./069-GetAppVersion.md) - 获取应用版本
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`ReplaceAppIcon`](./076-ReplaceAppIcon.md) - 替换应用图标