{"id":29567142,"url":"https://github.com/sparticleinc/mac-audio-capture","last_synced_at":"2025-12-31T14:20:11.912Z","repository":{"id":304619153,"uuid":"1019336634","full_name":"sparticleinc/mac-audio-capture","owner":"sparticleinc","description":"Node.js module for capturing Mac system audio using Swift and CoreAudio","archived":false,"fork":false,"pushed_at":"2025-07-14T07:24:22.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-14T09:59:28.156Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","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/sparticleinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null}},"created_at":"2025-07-14T07:10:20.000Z","updated_at":"2025-07-14T07:24:25.000Z","dependencies_parsed_at":"2025-07-14T09:59:33.147Z","dependency_job_id":"db3ccb5a-898f-4987-82f9-d6fd89a317a5","html_url":"https://github.com/sparticleinc/mac-audio-capture","commit_stats":null,"previous_names":["sparticleinc/mac-audio-capture"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/sparticleinc/mac-audio-capture","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparticleinc%2Fmac-audio-capture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparticleinc%2Fmac-audio-capture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparticleinc%2Fmac-audio-capture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparticleinc%2Fmac-audio-capture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sparticleinc","download_url":"https://codeload.github.com/sparticleinc/mac-audio-capture/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparticleinc%2Fmac-audio-capture/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265849312,"owners_count":23838249,"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":[],"created_at":"2025-07-18T23:10:18.406Z","updated_at":"2025-12-31T14:20:11.900Z","avatar_url":"https://github.com/sparticleinc.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎵 Audio Capture\n\n[![Node.js](https://img.shields.io/badge/Node.js-16+-green.svg)](https://nodejs.org/)\n[![macOS](https://img.shields.io/badge/macOS-14.4+-blue.svg)](https://www.apple.com/macos/)\n[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n[![Swift](https://img.shields.io/badge/Swift-5.3+-orange.svg)](https://swift.org/)\n\nA Node.js module based on Swift and CoreAudio for capturing Mac system audio streams. Solves the technical challenge of Node.js being unable to directly access macOS system speaker audio streams.\n\n[中文版本](README_zh.md) | English Version\n\n## ✨ Features\n\n- 🎯 **System-level Capture**: Uses CoreAudio Process Tap technology to capture audio output from all applications\n- ⚡ **High Performance**: Swift native code provides near-C language performance\n- 🔧 **Easy API**: Provides clean JavaScript interface with Promise and event-driven support\n- 🎵 **Real-time Processing**: Supports real-time audio data processing and format conversion\n- 📁 **Multi-format Output**: Supports WAV format audio file output\n- 🛡️ **Error Handling**: Comprehensive error handling and state management\n- 📊 **Detailed Logging**: Provides detailed debugging and status logs\n\n## 🚀 Quick Start\n\n### Installation\n\n```bash\n# Install from GitHub\nnpm install git+https://github.com/sparticleinc/mac-audio-capture.git\n\n# Or clone repository and install locally\ngit clone https://github.com/sparticleinc/mac-audio-capture.git\ncd mac-audio-capture\nnpm install\n```\n\n### Basic Usage\n\n```javascript\nconst AudioCapture = require('./lib');\n\nasync function captureAudio() {\n    // Create audio capture instance\n    const capture = new AudioCapture({\n        sampleRate: 48000,\n        channelCount: 2\n    });\n    \n    // Listen to events\n    capture.on('started', () =\u003e console.log('🎙️ Started capturing'));\n    capture.on('stopped', () =\u003e console.log('🛑 Stopped capturing'));\n    capture.on('error', (error) =\u003e console.error('❌ Error:', error.message));\n    \n    try {\n        // Record 5 seconds of audio\n        const filePath = await capture.record(5000, 'output.wav');\n        console.log('✅ Recording completed:', filePath);\n    } catch (error) {\n        console.error('Recording failed:', error.message);\n    }\n}\n\ncaptureAudio();\n```\n\n### Advanced Usage\n\n```javascript\nconst AudioCapture = require('./lib');\n\nasync function advancedCapture() {\n    const capture = new AudioCapture();\n    \n    // Configure audio capture\n    await capture.configure({\n        sampleRate: 44100,\n        channelCount: 1,\n        logPath: './logs/audio.log'\n    });\n    \n    // Start capture\n    await capture.startCapture({ interval: 100 });\n    \n    // Real-time audio data processing\n    capture.on('data', (audioData) =\u003e {\n        console.log(`📊 Received ${audioData.length} audio segments`);\n        // Process audio data here\n    });\n    \n    // Record for 3 seconds\n    await new Promise(resolve =\u003e setTimeout(resolve, 3000));\n    \n    // Stop capture\n    await capture.stopCapture();\n    \n    // Save as WAV file\n    const filePath = await capture.saveToWav('advanced-output.wav');\n    console.log('File saved:', filePath);\n}\n```\n\n## 📖 API Documentation\n\n### AudioCapture Class\n\n#### Constructor\n\n```javascript\nnew AudioCapture(options?: AudioCaptureConfig)\n```\n\n**Parameters:**\n- `options` (optional): Configuration options\n  - `sampleRate`: Sample rate (default: 48000)\n  - `channelCount`: Number of channels (default: 2)\n  - `logPath`: Log file path\n\n#### Methods\n\n##### configure(options)\nConfigure audio capture\n\n```javascript\nawait capture.configure({\n    sampleRate: 44100,\n    channelCount: 1,\n    logPath: './audio.log'\n});\n```\n\n##### startCapture(options)\nStart audio capture\n\n```javascript\nawait capture.startCapture({ interval: 100 });\n```\n\n##### stopCapture()\nStop audio capture\n\n```javascript\nawait capture.stopCapture();\n```\n\n##### record(durationMs, outputPath)\nRecord audio for specified duration\n\n```javascript\nconst filePath = await capture.record(5000, 'output.wav');\n```\n\n##### saveToWav(outputPath, audioData)\nSave audio data as WAV file\n\n```javascript\nconst filePath = await capture.saveToWav('output.wav');\n```\n\n##### getAudioData()\nGet current audio data\n\n```javascript\nconst audioData = capture.getAudioData();\n```\n\n##### clearBuffer()\nClear audio buffer\n\n```javascript\ncapture.clearBuffer();\n```\n\n#### Events\n\n- `configured`: Triggered when configuration is complete\n- `started`: Triggered when capture starts\n- `stopped`: Triggered when capture stops\n- `data`: Triggered when audio data is received\n- `saved`: Triggered when file save is complete\n- `error`: Triggered when an error occurs\n\n## 🛠️ Development\n\n### Requirements\n\n- Node.js 16+\n- macOS 14.4+\n- Swift 5.3+\n- Xcode Command Line Tools\n\n### Install Dependencies\n\n```bash\nnpm install\n```\n\n### Build\n\n```bash\n# Development build\nnpm run dev\n\n# Production build\nnpm run build\n```\n\n### Test\n\n```bash\nnpm test\n```\n\n### Run Examples\n\n```bash\nnpm run example\n```\n\n### Code Formatting\n\n```bash\nnpm run format\nnpm run lint\n```\n\n## 🏗️ Technical Architecture\n\n```\n┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐\n│   Node.js App   │    │   NAPI Binding  │    │  Swift Module   │\n│                 │◄──►│                 │◄──►│                 │\n│  JavaScript API │    │  C++ Interface  │    │  CoreAudio API  │\n└─────────────────┘    └─────────────────┘    └─────────────────┘\n                                │                        │\n                                ▼                        ▼\n                       ┌─────────────────┐    ┌─────────────────┐\n                       │  Audio Buffer   │    │  Process Tap    │\n                       │                 │    │                 │\n                       │  Base64 Data    │    │  System Audio   │\n                       └─────────────────┘    └─────────────────┘\n```\n\n### Core Technologies\n\n1. **CoreAudio Process Tap**: System-level audio capture\n2. **Aggregate Device**: Virtual audio device management\n3. **NAPI (Node-API)**: Cross-language binding\n4. **Event-Driven Architecture**: Event-driven architecture\n5. **Real-time Audio Processing**: Real-time audio processing\n\n## 📝 License\n\nMIT License - see [LICENSE](LICENSE) file for details\n\n## 🤝 Contributing\n\nIssues and Pull Requests are welcome!\n\n### Contributing Guidelines\n\n1. Fork this repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📞 Support\n\nIf you encounter issues or have suggestions, please:\n\n1. Check the [Issues](https://github.com/sparticleinc/mac-audio-capture/issues) page\n2. Create a new Issue\n3. Contact the maintainer\n\n## ⚠️ Important Usage Notice\n\n### System Audio Recording Permission Required\n\n**Before using this module, you must manually enable system audio recording permission for your application:**\n\n1. **Open System Preferences** \u003e **Privacy \u0026 Security** \u003e **Screen Recording \u0026 System Audio Recording**\n2. **Find your application** in the list\n3. **Enable \"System Audio Recording Only\"** for your app\n4. **Restart your application** after granting permission\n\n**Note**: This module requires system audio recording permission to capture system audio streams. Without proper permission, the module may run but will not capture actual system audio data.\n\n### Permission Setup Steps:\n\n1. **Navigate to System Preferences**:\n   - Open System Preferences (or System Settings on newer macOS versions)\n   - Go to Privacy \u0026 Security\n   - Find \"Screen Recording \u0026 System Audio Recording\"\n\n2. **Enable Permission for Your App**:\n   - Locate your application in the list\n   - Check the box for \"System Audio Recording Only\"\n   - If your app is not listed, click the \"+\" button to add it\n\n3. **Restart Your Application**:\n   - Close your application completely\n   - Reopen your application\n   - Test audio capture functionality\n\n### Troubleshooting Permission Issues\n\nIf you encounter issues with audio capture:\n\n1. **Verify Permission Settings**:\n   - Ensure your app has \"System Audio Recording Only\" permission\n   - Check that no other apps are using system audio recording\n   - Restart your application after permission changes\n\n2. **Common Issues**:\n   - If no audio is captured, check permission settings\n   - If permission option is not visible, update macOS to latest version\n   - If app is not in permission list, manually add it using the \"+\" button\n\n3. **Alternative Permission Locations**:\n   - On some macOS versions: System Preferences \u003e Security \u0026 Privacy \u003e Privacy \u003e Microphone\n   - Look for \"System Audio\" option in microphone settings\n\n### Build Issues\nIf build fails, make sure:\n- Xcode Command Line Tools installed: `xcode-select --install`\n- Swift version \u003e= 5.3: `swift --version`\n- Node.js version \u003e= 16: `node --version`\n\n## 📋 TODO List\n\n### High Priority\n- [ ] **Implement accurate permission checking** - Add proper system audio recording permission validation\n- [ ] **Add permission status detection** - Real-time permission status monitoring\n- [ ] **Improve error handling** - Better error messages for permission-related issues\n\n### Medium Priority\n- [ ] **Add audio format validation** - Validate audio format compatibility\n- [ ] **Implement audio quality settings** - Configurable audio quality options\n- [ ] **Add audio device selection** - Allow users to select specific audio devices\n- [ ] **Implement audio effects** - Basic audio processing features\n- [ ] **Add streaming support** - Real-time audio streaming capabilities\n\n## 🙏 Acknowledgments\n\n- [CoreAudio](https://developer.apple.com/documentation/coreaudio) - Apple's audio framework\n- [NAPI](https://nodejs.org/api/n-api.html) - Node.js native API\n- [Swift NAPI Bindings](https://github.com/LinusU/swift-napi-bindings) - Swift and NAPI binding library\n\n## 🎯 Project Support\n\nThis project is supported by [Felo Subtitles](https://subtitles.felo.me/?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=mac-audio) - an AI-powered real-time translation and multilingual subtitle tool that easily enables cross-language communication.\n\n**Why Felo Subtitles?**\n- 🎯 **Smart Speaker Recognition**: Advanced context analysis and speaker identification technology that accurately distinguishes meeting participants and automatically labels each speech segment with clear identity\n- 📊 **Intelligent Summary Templates**: Automatically extracts key information and generates structured summaries\n- 🏥 **Industry Professional Vocabulary**: Customizable speech recognition dictionaries and translation terminology databases help improve recognition and translation accuracy for industry terms, brand names, and personal names\n- 🌐 **Real-time Subtitle Sharing**: Through a single sharing link, Felo Subtitles allows anyone to view subtitle content in real-time, improving cross-regional collaboration efficiency\n\n[Try Felo Subtitles Now →](https://subtitles.felo.me/?utm_source=github\u0026utm_medium=referral\u0026utm_campaign=mac-audio)\n\n---\n\n**Note**: This module only supports macOS systems and requires appropriate audio permissions. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparticleinc%2Fmac-audio-capture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsparticleinc%2Fmac-audio-capture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparticleinc%2Fmac-audio-capture/lists"}