Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MediaPlayerSupportedFormat #925

Conversation

synesthesiam
Copy link
Contributor

@synesthesiam synesthesiam commented Aug 15, 2024

Extends the media player info with a list of supported audio formats. This is used in Home Assistant to swap out media URLs going to the ESPHome device with proxy URLs that contain the converted audio.

Depends on the following PRs:

Copy link
Contributor

coderabbitai bot commented Aug 15, 2024

Walkthrough

The recent changes introduce enhancements to the media player functionality in the aioesphomeapi module. A new MediaPlayerFormatPurpose enumeration and a MediaPlayerSupportedFormat message structure have been added to improve how media formats are categorized and communicated. Additionally, existing response structures have been modified to include lists of supported formats, and the code generation for protocol buffers has been automated to enhance maintainability.

Changes

File Path Summary of Changes
aioesphomeapi/api.proto Introduced MediaPlayerFormatPurpose enum and MediaPlayerSupportedFormat message; modified ListEntitiesMediaPlayerResponse to include supported_formats.
aioesphomeapi/api_options_pb2.py Transitioned to automated generation of enums and messages using the _builder module, removing manual definitions for several fields.
aioesphomeapi/model.py Added MediaPlayerFormatPurpose enum and MediaPlayerSupportedFormat class; updated MediaPlayerInfo to include a list of supported formats.

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@synesthesiam
Copy link
Contributor Author

@jesserockz Did I do something wrong to cause this test to fail?

@jesserockz
Copy link
Member

@synesthesiam I think you generated the files with a different proto version. Ill try fix

aioesphomeapi/model.py Outdated Show resolved Hide resolved
@esphome esphome bot marked this pull request as draft August 26, 2024 01:51
@esphome
Copy link

esphome bot commented Aug 26, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@synesthesiam
Copy link
Contributor Author

@synesthesiam I think you generated the files with a different proto version. Ill try fix

Ok, if not I'll try to upgrade and regenerate the files tomorrow.

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
@synesthesiam
Copy link
Contributor Author

synesthesiam commented Aug 26, 2024

@jesserockz I have libprotoc version 3.21.12. Looks like this is too new, since the script expects 3.6.1

@synesthesiam synesthesiam marked this pull request as ready for review August 26, 2024 14:14
@esphome esphome bot requested a review from jesserockz August 26, 2024 14:14
@jesserockz
Copy link
Member

You can use docker to generate too

docker run -v "$PWD":/aioesphomeapi ghcr.io/esphome/aioesphomeapi-proto-builder:latest

@synesthesiam
Copy link
Contributor Author

Do I need to add a version bump too?

@jesserockz jesserockz merged commit 2ba7774 into esphome:main Aug 27, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants