Port Enhancements from EA

[davidvonthenen]

Proposed changes

This ports enhancements from the Agent EA work that is happening. Since that work will probably take some time to get to GA, backporting the things I can.

Changes:

• Addresses Issue https://github.com/deepgram/deepgram-python-sdk/issues/457
• Adds a is_muted call on the Microphone
• Adds a wait_for_complete_with_mute call on the Speaker
• Enables a mode where the Speaker has the capability to automatically mute the Microphone when needed
• Rearranging some code

Types of changes

What types of changes does your code introduce to the community Python SDK? Put an x in the boxes that apply

• [ ] Bugfix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• [x] I have read the CONTRIBUTING doc
• [x] I have lint'ed all of my code using repo standards
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] I have added necessary documentation (if appropriate)

Further comments

NA

Summary by CodeRabbit

• New Features

  • Enhanced microphone control in the application, allowing users to mute and manage audio input effectively.
  • Added support for microphone functionality in the AsyncSpeakWSClient and SpeakWSClient classes.
  • Introduced a new speech-to-text functionality in the example application.
  • Simplified audio data handling in example applications for improved user experience.

• Bug Fixes

  • Improved logging mechanisms to prevent potential errors related to thread handling and HTTP responses.

• Documentation

  • Updated example scripts to reflect changes in audio handling and configuration options.

[coderabbitai[bot]]

Walkthrough

The pull request introduces enhancements across multiple classes related to audio processing. The Microphone class now supports improved audio stream initialization and state management, including a new method for checking the muted state. The Speaker class integrates microphone control, allowing for better synchronization during audio playback. Logging mechanisms in websocket client classes are fortified to prevent errors. Additionally, example scripts for text-to-speech have been updated for better audio data handling and connection management, with some features removed for simplification.

Changes

File Path	Change Summary
deepgram/audio/microphone/microphone.py	Updated Microphone class to improve audio stream initialization and state management. Added is_muted method and logging enhancements.
deepgram/audio/speaker/speaker.py	Enhanced Speaker class to support microphone control. Added _microphone attribute and wait_for_complete_with_mute method.
deepgram/clients/common/v1/abstract_async_websocket.py	Modified finish method to enhance logging by checking thread object before accessing its name.
deepgram/clients/common/v1/abstract_sync_websocket.py	Updated finish method for improved logging robustness with checks for thread before accessing its name.
deepgram/clients/speak/v1/websocket/async_client.py	Added support for microphone in AsyncSpeakWSClient with a new optional parameter and improved initialization logic.
deepgram/clients/speak/v1/websocket/client.py	Updated SpeakWSClient to support microphone input with new optional parameter and improved cleanup in the finish method.
examples/text-to-speech/websocket/output_to_wav/main.py	Modified to include wave module and AUDIO_FILE constant. Simplified audio data handling and event management.
examples/text-to-speech/websocket/simple/main.py	Removed wave module and file handling. Updated DeepgramClient configuration and added new event handlers for websocket management.
deepgram/clients/common/v1/abstract_async_rest.py	Added error handling in _handle_request method to check for None responses and raise DeepgramError.
deepgram/clients/common/v1/abstract_sync_rest.py	Introduced error handling in _handle_request method to ensure response validity and raise DeepgramError if conditions are not met.
deepgram/clients/listen/v1/helpers.py	Deleted file containing utility functions for URL manipulation: append_query_params and convert_to_websocket_url.
deepgram/clients/speak/v1/websocket/helpers.py	Deleted file containing utility functions for URL manipulation: append_query_params and convert_to_websocket_url.
examples/speech-to-text/websocket/replay/main.py	Added new file implementing speech-to-text functionality using Deepgram SDK, with websocket connection and transcription processing.

Possibly related PRs

• #471: The wait_for_complete method in the Speaker class is directly related to the changes in the Microphone class, as both involve managing audio playback and state.

Suggested reviewers

• lukeocodes
• SandraRodgers
• jpvajda
• naomi-lgbt

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.