音量按钮插件
@capacitor-community/volume-buttons
听取硬件音量按钮的电容社区插件
目录
维护者
| 维护者 | GitHub 图像 | 活动 |
|---|---|---|
| 尼亚a | 尼亚a | 对 |
关于
此插件允许在用户按下设备的硬件音量上下键时监听所引发的事件. 仅包含一个属性的对象被转到回调 - 见 音量按钮。 。 。 . 此插件包含源自或启发的代码 https://github.com/CipherBitCorp/VolumeButtonHandler 互联网档案馆的存檔,存档日期2013-12-21 财务报告和审定财务报表 https://github.com/thiagobrez/ 电容-容量-按钮 插件 .
特征 :
- 支持最大音量或分( 确保使用) 时接收事件
disableSystemVolumeHandleriOS 平台 - 见 音量按钮选项(中文(简体) ) - 继续接收发送到应用程序后的事件,并从背景返回
- 支持 Android 和 iOS 平台
页:1:插件版本8.x与Capacitor 8兼容
插件版本
| 电容版本 | 插件版本 |
|---|---|
| 8.x 电话 | 8.x 电话 |
| 7.x 电话 | 7.x 电话 |
| 6.x (单位:千美元) | 6.x (单位:千美元) |
| 5.x 电话 | 1.x 运算 |
支持的平台
- iOS系统
- 机器人
安装
npm install @capacitor-community/volume-buttons
npx cap sync
API 密码
正在观察 ()
isWatching() => Promise<GetIsWatchingResult>
获取音量按钮的监视状态 .
回返情况: Promise<GetIsWatchingResult>
自: 1.0.1 (中文(简体) )
监视卷(...)
watchVolume(options: VolumeButtonsOptions, callback: VolumeButtonsCallback) => Promise<CallbackID>
为他设置手表 硬件音量按钮更改
| 参数 | 类型 |
|---|---|
options | VolumeButtonsOptions |
callback | VolumeButtonsCallback |
回返情况: Promise<string>
自: 1.0.0 (单位:千美元)
清除监视( C)
clearWatch() => Promise<void>
清除已有的表
自: 1.0.0 (单位:千美元)
接口
获取监视结果
| Prop | 类型 | 说明 | 自兹 |
|---|---|---|---|
value | boolean | 如果音量按钮被监视. | 1.0.1 (中文(简体) ) |
音量按钮选项
| Prop | 类型 | 说明 | 自兹 |
|---|---|---|---|
disableSystemVolumeHandler | boolean | 此参数可用于禁用系统音量处理器(仅iOS). 如果这是真的,当调取上下音量按钮时,系统音量将总是被重置到初始音量(启动音量按钮跟踪/上传时的音量),如果初始音量较小,则重置到0.05;如果初始音量较大,则重置到0.95. | 1.0.0 (单位:千美元) |
suppressVolumeIndicator | boolean | 此参数可用于压制/隐藏系统体积指标(仅Android,它从未在iOS上显示过). 如果这是真的,当调用上下音量按钮时,系统音量指示器将不会显示. 默认值是虚假的 . | 1.0.2 联合国 |
音量按钮
| Prop | 类型 | 说明 | 自兹 |
|---|---|---|---|
direction | 'up' | 'down' | 这表明按下了音量上下键. | 1.0.0 (单位:千美元) |
类型异名
调回音量按钮
(result: VolumeButtonsResult, err?: any): void
调用回话ID
string
使用量
请参看 示例应用程序 一个完整的例子.
在应用程序中添加音量按钮监听器
import { VolumeButtons } from '@capacitor-community/volume-buttons';
const options: VolumeButtonsOptions = {};
const callback: VolumeButtonsCallback = (result: VolumeButtonsResult, err?: any) => {
console.log('result', result);
};
if (this.platform.is('ios')) {
options.disableSystemVolumeHandler = true;
} else if (this.platform.is('android')) {
options.suppressVolumeIndicator = true;
}
await VolumeButtons.watchVolume(options, callback);
删除应用程序中的音量按钮监听器
import { VolumeButtons } from '@capacitor-community/volume-buttons';
await VolumeButtons.clearWatch();