ComfyUI Node: alert when finished

alert when finished:

The alert_when_finished node is designed to notify you with a sound alert when a specific process or task is completed. This node is particularly useful for AI artists who often run long processes and need an audible notification to know when their task is done without constantly monitoring their screen. By integrating this node into your workflow, you can ensure that you are promptly alerted upon the completion of your tasks, allowing you to focus on other activities in the meantime. The node leverages the playsound function to play a sound file specified by you, making it a versatile and customizable alert system.

alert when finished Input Parameters:

images

This parameter accepts an input of type IMAGE. It represents the images that are being processed or generated. While the images themselves are not directly used by the alert function, this parameter is required to ensure the node is integrated correctly within the workflow. There are no specific minimum, maximum, or default values for this parameter as it depends on the images being processed in your task.

sound_path

This parameter accepts an input of type STRING and specifies the path to the sound file that will be played when the task is completed. The sound_path should be a valid file path to an audio file on your system. The default value for this parameter is "sound_path", but you should provide the actual path to your desired sound file. The sound file can be in any format supported by the playsound library, such as .mp3 or .wav.

alert when finished Output Parameters:

None

This node does not produce any output parameters. Its primary function is to play a sound alert, and it does not generate any data or results that need to be passed to subsequent nodes.

alert when finished Usage Tips:

• Ensure that the sound_path parameter points to a valid audio file on your system to avoid errors.
• Use this node at the end of your workflow to get notified when all preceding tasks are completed.
• Customize the sound file to something that is easily recognizable and distinct to ensure you notice the alert.

alert when finished Common Errors and Solutions:

PlaysoundException

• Explanation: This error occurs if there is an issue with playing the sound file, such as an invalid file path or unsupported file format.
• Solution: Verify that the sound_path parameter is correct and points to a valid audio file. Ensure the file format is supported by the playsound library.

FileNotFoundError

• Explanation: This error occurs if the specified sound file cannot be found at the given path.
• Solution: Double-check the file path provided in the sound_path parameter to ensure it is correct and that the file exists at that location.

UnsupportedAudioFileError

• Explanation: This error occurs if the audio file format is not supported by the playsound library.
• Solution: Convert the audio file to a supported format such as .mp3 or .wav and update the sound_path parameter accordingly.