{"id":32477031,"url":"https://github.com/cap-go/capacitor-volume-buttons","last_synced_at":"2026-02-20T05:09:11.861Z","repository":{"id":318717966,"uuid":"1073114028","full_name":"Cap-go/capacitor-volume-buttons","owner":"Cap-go","description":"Capacitor plugin to listen to volume button presses","archived":false,"fork":false,"pushed_at":"2026-02-06T05:19:58.000Z","size":1041,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-06T13:41:05.029Z","etag":null,"topics":["capacitor","capacitor-plugin"],"latest_commit_sha":null,"homepage":"https://capgo.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2025-10-09T16:29:54.000Z","updated_at":"2026-02-06T05:20:01.000Z","dependencies_parsed_at":"2025-10-23T07:06:20.372Z","dependency_job_id":null,"html_url":"https://github.com/Cap-go/capacitor-volume-buttons","commit_stats":null,"previous_names":["cap-go/capacitor-volume-buttons"],"tags_count":29,"template":false,"template_full_name":null,"purl":"pkg:github/Cap-go/capacitor-volume-buttons","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-volume-buttons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-volume-buttons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-volume-buttons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-volume-buttons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-volume-buttons/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-volume-buttons/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29641995,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T03:21:14.183Z","status":"ssl_error","status_checked_at":"2026-02-20T03:18:24.455Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["capacitor","capacitor-plugin"],"created_at":"2025-10-26T22:49:19.153Z","updated_at":"2026-02-20T05:09:11.856Z","avatar_url":"https://github.com/Cap-go.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":[],"sub_categories":[],"readme":"# @capgo/capacitor-volume-buttons\n \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_volume_buttons\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_volume_buttons\"\u003e Missing a feature? We’ll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\nListen to volume button presses in Capacitor apps\n\n## Documentation\n\nThe most complete doc is available here: https://capgo.app/docs/plugins/volume-buttons/\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ---------- |\n| v8.\\*.\\*       | v8.\\*.\\*                | ✅          |\n| v7.\\*.\\*       | v7.\\*.\\*                | On demand   |\n| v6.\\*.\\*       | v6.\\*.\\*                | ❌          |\n| v5.\\*.\\*       | v5.\\*.\\*                | ❌          |\n\n\u003e **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-volume-buttons\nnpx cap sync\n```\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`addListener('volumeButtonPressed', ...)`](#addlistenervolumebuttonpressed-)\n* [`removeAllListeners()`](#removealllisteners)\n* [`getPluginVersion()`](#getpluginversion)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\nCapacitor Volume Buttons Plugin for detecting hardware volume button presses.\n\n### addListener('volumeButtonPressed', ...)\n\n```typescript\naddListener(eventName: 'volumeButtonPressed', listenerFunc: VolumeButtonListener) =\u003e Promise\u003cPluginListenerHandle\u003e \u0026 PluginListenerHandle\n```\n\nListen for presses on the hardware volume buttons.\n\n| Param              | Type                                                                  | Description                                            |\n| ------------------ | --------------------------------------------------------------------- | ------------------------------------------------------ |\n| **`eventName`**    | \u003ccode\u003e'volumeButtonPressed'\u003c/code\u003e                                    | - The event name (must be 'volumeButtonPressed')       |\n| **`listenerFunc`** | \u003ccode\u003e\u003ca href=\"#volumebuttonlistener\"\u003eVolumeButtonListener\u003c/a\u003e\u003c/code\u003e | - The function to call when a volume button is pressed |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt; \u0026 \u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() =\u003e Promise\u003cvoid\u003e\n```\n\nRemoves all listeners for this plugin.\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003c{ version: string; }\u003e\n```\n\nGet the native Capacitor plugin version.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ version: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | \u003ccode\u003e() =\u0026gt; Promise\u0026lt;void\u0026gt;\u003c/code\u003e |\n\n\n#### VolumeButtonPressed\n\nEvent data for volume button press.\n\n| Prop            | Type                                                                    | Description                   |\n| --------------- | ----------------------------------------------------------------------- | ----------------------------- |\n| **`direction`** | \u003ccode\u003e\u003ca href=\"#volumebuttondirection\"\u003eVolumeButtonDirection\u003c/a\u003e\u003c/code\u003e | Direction of the button press |\n\n\n### Type Aliases\n\n\n#### VolumeButtonListener\n\nListener function for volume button events.\n\n\u003ccode\u003e(event: \u003ca href=\"#volumebuttonpressed\"\u003eVolumeButtonPressed\u003c/a\u003e): void\u003c/code\u003e\n\n\n#### VolumeButtonDirection\n\nDirection of volume button press.\n\n\u003ccode\u003e'up' | 'down'\u003c/code\u003e\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-volume-buttons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-go%2Fcapacitor-volume-buttons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-volume-buttons/lists"}