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 sound notification #3270

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

niboshi
Copy link
Contributor

@niboshi niboshi commented Mar 29, 2025

This PR adds a feature to play sound file on prompt completion.

2 new setting entries are added to configure audio files that are played on the following events:

  • When execution of one prompt is completed
  • When execution of all prompts are completed

I'm aware there are some custom nodes for sound notification, but

  • I feel this is so essential that I would like to have it as a core feature for better usability.
  • it would be better to make workflows agnostic to this feature.

@niboshi niboshi force-pushed the sound-notification branch from 84dc6d6 to 0419081 Compare March 29, 2025 05:53
Copy link
Member

@huchenlei huchenlei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you attach steps with screenshots how this feature should be used?

@niboshi
Copy link
Contributor Author

niboshi commented Mar 29, 2025

Sure. It's very simple though.

  1. Open settings and select audio file(s)
    scree1

  2. Run workflow(s)

screen2

@huchenlei
Copy link
Member

How do I enable/disable the sound notification? User probably don't want to re-upload an audio file to re-enable it. We should also provide a default sound effect.

@niboshi
Copy link
Contributor Author

niboshi commented Mar 30, 2025

As for enable/disable, how about adding a mute setting (and perhaps volume setting) to each of the two?

I thought this feature could be opt-in, so a default sound would not be needed.
What should it be if we need it?

@huchenlei
Copy link
Member

As for enable/disable, how about adding a mute setting (and perhaps volume setting) to each of the two?

I thought this feature could be opt-in, so a default sound would not be needed. What should it be if we need it?

I think if no custom sound is provided, we can use the classic linux beep sound. This is to simplify setup for anyone who wants to enable this feature. Removing the finding a sound file online, download it, upload it to ComfyUI steps.

@niboshi
Copy link
Contributor Author

niboshi commented Mar 30, 2025

OK. As we can't play the system beep sound from frontend, I'll try to find some license-free sound file online that we can add to the repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants