ComfyUI Node: PlaySound 🐍

PlaySound 🐍| PlaySound 🐍:

The PlaySound| PlaySound 🐍 node is designed to play a sound file based on specific conditions, providing an auditory notification system within your workflow. This node is particularly useful for alerting you when certain events occur, such as the completion of a task or when the queue is empty. By integrating this node, you can enhance your workflow with audio cues, ensuring you are promptly informed of important events without needing to constantly monitor your system visually. The node offers flexibility in terms of when the sound is played, the volume level, and the specific sound file used, making it a versatile tool for various notification needs.

PlaySound 🐍| PlaySound 🐍 Input Parameters:

any

This parameter acts as a wildcard string that is always equal in not equal comparisons. It is used internally by the node and does not require any specific input from you.

mode

This parameter determines the condition under which the sound will be played. It has two options: always and on empty queue. Selecting always will play the sound every time the node is executed, while on empty queue will play the sound only when the queue is empty. This allows you to customize the notification behavior based on your specific needs.

volume

This parameter controls the volume level of the sound playback. It accepts a floating-point value between 0 and 1, with a default value of 0.5. The minimum value is 0, which represents mute, and the maximum value is 1, which represents full volume. Adjusting this parameter allows you to set the sound to a comfortable listening level.

file

This parameter specifies the sound file to be played. It accepts a string representing the file name, with a default value of notify.mp3. You can change this to any valid sound file name that is accessible within your system. This flexibility allows you to choose a sound that best suits your notification preferences.

PlaySound 🐍| PlaySound 🐍 Output Parameters:

any

The output parameter any is a wildcard string that is returned by the node. It serves as a placeholder and is used internally to maintain the node's functionality within the workflow. This output does not require any specific interpretation or action from you.

PlaySound 🐍| PlaySound 🐍 Usage Tips:

• To ensure you are notified when a task is completed, set the mode parameter to always.
• If you only want to be notified when the queue is empty, set the mode parameter to on empty queue.
• Adjust the volume parameter to a level that is audible but not disruptive to your environment.
• Customize the file parameter with a sound file that you find pleasant or attention-grabbing.

PlaySound 🐍| PlaySound 🐍 Common Errors and Solutions:

File not found: <file_name>

• Explanation: The specified sound file could not be located in the system.
• Solution: Ensure that the file name is correct and that the file is located in a directory accessible by the node. Verify the file path if necessary.

Invalid volume value

• Explanation: The volume parameter is set to a value outside the acceptable range (0 to 1).
• Solution: Adjust the volume parameter to a value between 0 and 1. The default value is 0.5.

Unsupported mode value

• Explanation: The mode parameter is set to a value other than always or on empty queue.
• Solution: Ensure that the mode parameter is set to either always or on empty queue. These are the only supported values.