@recappi/sdk 1.0.0 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # `@recappi/sdk`
 
-![https://github.com/Recappi/sdk/actions/workflows/CI.yml](https://github.com/recappi/sdk/workflows/CI/badge.svg)
+[![CI](https://github.com/Recappi/sdk/actions/workflows/CI.yml/badge.svg)](https://github.com/Recappi/sdk/actions/workflows/CI.yml)
 
 ## Usage
 
@@ -8,60 +8,94 @@
 
 Both input and output devices are recording, mixed into a single audio stream.
 
-```ts
-import { writeFile } from "node:fs/promises";
-import { setTimeout } from "node:timers/promises";
+```typescript
+import { writeFile } from 'node:fs/promises'
+import { setTimeout } from 'node:timers/promises'
 
-import { ShareableContent } from "@recappi/sdk";
-import { createWavBuffer } from "@recappi/sdk/encode-wav";
+import { ShareableContent } from '@recappi/sdk'
+import { createWavBuffer } from '@recappi/sdk/encode-wav'
 
-const WavBuffers = [];
+const WavBuffers = []
 
-let totalLength = 0;
+let totalLength = 0
 
 const session = ShareableContent.tapGlobalAudio([], (err, samples) => {
   if (err) {
-    console.error("Error capturing audio:", err);
-    return;
+    console.error('Error capturing audio:', err)
+    return
   }
-  WavBuffers.push(samples);
-  totalLength += samples.length;
-});
+  WavBuffers.push(samples)
+  totalLength += samples.length
+})
 
-console.info("Recording audio for 5 seconds...");
+console.info('Recording audio for 5 seconds...')
 
-await setTimeout(5000); // Record for 5 seconds
+await setTimeout(5000) // Record for 5 seconds
 
-session.stop();
+session.stop()
 
-console.info(
-  `Recording stopped. Writing ${totalLength} samples to output.wav...`,
-);
+console.info(`Recording stopped. Writing ${totalLength} samples to output.wav...`)
 
 const { buf: contactedBuffer } = WavBuffers.reduce(
   ({ buf, offset }, cur) => {
-    buf.set(cur, offset);
+    buf.set(cur, offset)
     return {
       buf,
       offset: offset + cur.length,
-    };
+    }
   },
   {
     buf: new Float32Array(totalLength),
     offset: 0,
   },
-);
+)
 
-console.log(`Creating WAV buffer ...`);
+console.log(`Creating WAV buffer ...`)
 
 const wavBuffer = Buffer.from(
   createWavBuffer(contactedBuffer, {
     sampleRate: session.sampleRate,
     numChannels: session.channels,
   }),
-);
+)
 
-await writeFile("output.wav", wavBuffer);
+await writeFile('output.wav', wavBuffer)
+```
+
+### Listing running applications
+
+```typescript
+import { ShareableContent } from '@recappi/sdk'
+
+const apps = ShareableContent.applications()
+
+for (const app of apps) {
+  console.log(`Name: ${app.name}, PID: ${app.processId}`)
+}
+```
+
+### Recording specific application
+
+```typescript
+import { ShareableContent } from '@recappi/sdk'
+
+const apps = ShareableContent.applications()
+const musicApp = apps.find((app) => app.name === 'Music')
+
+if (musicApp) {
+  const session = ShareableContent.tapAudio(musicApp.processId, (err, samples) => {
+    if (err) {
+      console.error('Error capturing audio:', err)
+      return
+    }
+    // Process samples...
+  })
+
+  // Stop recording after 5 seconds
+  setTimeout(() => {
+    session.stop()
+  }, 5000)
+}
 ```
 
 ## Playground