{"id":17441196,"url":"https://github.com/tmigone/pulseaudio","last_synced_at":"2025-05-07T01:42:19.660Z","repository":{"id":42779922,"uuid":"271568470","full_name":"tmigone/pulseaudio","owner":"tmigone","description":"A TypeScript based client library for PulseAudio","archived":false,"fork":false,"pushed_at":"2023-10-15T20:29:33.000Z","size":908,"stargazers_count":17,"open_issues_count":12,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T03:40:05.623Z","etag":null,"topics":["audio","client","paclient","palib","pulse","pulseaudio"],"latest_commit_sha":null,"homepage":"http://pulseaudio.tmigone.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tmigone.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"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}},"created_at":"2020-06-11T14:31:04.000Z","updated_at":"2024-06-30T12:46:48.000Z","dependencies_parsed_at":"2024-06-19T01:36:44.897Z","dependency_job_id":"c8a5ca95-540e-4a0d-80a5-c77d40af8b7b","html_url":"https://github.com/tmigone/pulseaudio","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmigone%2Fpulseaudio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmigone%2Fpulseaudio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmigone%2Fpulseaudio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmigone%2Fpulseaudio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmigone","download_url":"https://codeload.github.com/tmigone/pulseaudio/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252798305,"owners_count":21805867,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["audio","client","paclient","palib","pulse","pulseaudio"],"created_at":"2024-10-17T15:10:39.844Z","updated_at":"2025-05-07T01:42:19.634Z","avatar_url":"https://github.com/tmigone.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎶 @tmigone/pulseaudio 🎶\n ![NPM](https://img.shields.io/npm/v/@tmigone/pulseaudio.svg?logo=npm\u0026logoColor=fff\u0026label=NPM+package\u0026color=limegreen\u0026link=https://www.npmjs.com/package/@tmigone/pulseaudio) ![CI](https://github.com/tmigone/pulseaudio/workflows/ci/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/tmigone/pulseaudio/badge.svg?branch=refactor)](https://coveralls.io/github/tmigone/pulseaudio?branch=refactor)\n\n`@tmigone/pulseaudio` is a TypeScript based client library for [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/), the most popular sound server for Linux. This library allows you to easily build clients or applications that interact with a PulseAudio server over it's native protocol, for example media players/recorders, volume control applications, etc.\n\n\n### Features\n- Zero dependency fully typed TypeScript implementation of the PulseAudio client protocol\n- Extensive testing suite\n- Protocol features: \n  - authentication - provide authentication data for the server\n  - transport - connect over UNIX domain sockets or TCP sockets\n  - introspection - query, modify and operate on PulseAudio objects like modules, sinks, sources, etc.\n  - events - subscribe to server-side object events like a sink starting playback, etc.\n  - (To be implemented) streams - manage audio playback and recording using Node.js streams\n\n## Installation\n\nInstall the library using [npm](https://www.npmjs.com/):\n```bash\nnpm install @tmigone/pulseaudio\n```\n\n## Usage\n\n```ts\nimport PulseAudio, { Sink } from '@tmigone/pulseaudio'\n\n(async () =\u003e {\n  // Connect using tcp or unix socket\n  // const client: PulseAudio = new PulseAudio('unix:/run/pulse/pulseaudio.socket')\n  const client: PulseAudio = new PulseAudio('tcp:192.168.1.10:4317')\n  await client.connect()\n\n  // Set volume of all sinks to 50%\n  const sinks: Sink[] = await client.getSinkList()\n  for (const sink of sinks) {\n    await client.setSinkVolume(sink.index, 50)\n  }\n\n  // Close connection\n  client.disconnect()\n})()\n```\n\n## Documentation\n\nVisit the [docs site](http://pulseaudio.tmigone.com) for in depth documentation on the library API's.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmigone%2Fpulseaudio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmigone%2Fpulseaudio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmigone%2Fpulseaudio/lists"}