Skip to content

docs: missing simple feed_audio example in README #30

Description

@Muhammad-Awab

Package

@attenlabs/saa-js

Version

0.6.0

What happened?

Description

The main README.md shows how to use the SDK with a microphone, but there is no simple example for using feed_audio() with generated or pre-recorded audio.

Current State

Currently, the README shows:

client = AttentionClient(token=os.environ["SAA_API_KEY"])
client.start()
# This captures from microphone

But there's no example for:

client = AttentionClient(token=os.environ["SAA_API_KEY"], enable_audio=False)
client.start()
client.feed_audio(audio_bytes)  # Manual audio feed

Why This Matters
Developers testing without hardware

CI/CD pipelines

Integration with Twilio Media Streams

Integration with ElevenLabs

Suggested Fix
Add a "Feed Audio Mode" section to the README with a simple example:

from saa import AttentionClient

client = AttentionClient(
    token="YOUR_API_KEY",
    enable_audio=False,  # No microphone
    enable_video=False,  # No camera
)

client.start()
client.feed_audio(audio_bytes)  # PCM16 @ 16kHz mono

Steps to reproduce

  1. Open the SAA SDK README: https://github.com/attenlabs/saa-sdk
  2. Look for a simple example of using feed_audio() with manual audio
  3. Notice there is no standalone example in the README
  4. Check examples/python/README.md - also only shows microphone capture

Environment

No response

Logs / errors

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions