ComfyDeployWebsocketImageOutput Node Documentation

Overview

The ComfyDeployWebsocketImageOutput node is a component of the ComfyDeploy platform, designed to facilitate the output of generated images through a websocket connection. This node is used to transmit images that have been processed or generated within a ComfyUI workflow to a specified client in real time, allowing for dynamic interaction with output results.

Functionality

The primary function of the ComfyDeployWebsocketImageOutput node is to serve as a conduit through which images are sent from a ComfyUI workflow to a designated recipient via websocket. This node enables seamless integration with client applications or interfaces that require the real-time display or processing of images generated by ComfyUI workflows.

Inputs

The ComfyDeployWebsocketImageOutput node requires the following inputs for proper operation:

Required Inputs

1. output_id

   • Type: String
   • Description: A unique identifier for the image output session. This ID ensures that the image can be correctly matched with the client expecting the result.

2. images

   • Type: Image
   • Description: The image or set of images to be sent. The images are expected to be in a format compatible with the processing framework.

3. file_type

   • Type: String (Options: "WEBP", "PNG", "JPEG")
   • Description: Specifies the file type in which the images should be transmitted. The choice of format affects image quality, compression, and performance.

4. quality

   • Type: Integer
   • Description: Determines the quality of the output image, with a default value of 80. The quality can be adjusted within a range of 1 to 100.

Optional Inputs

1. client_id
   • Type: String
   • Description: An optional identifier for the client that is intended to receive the images. Useful in scenarios where multiple clients may be connected and listening for image outputs.

Outputs

The ComfyDeployWebsocketImageOutput node does not produce direct outputs that are consumed by subsequent nodes in a ComfyUI workflow. Instead, its primary role is the external transmission of images through the websocket, facilitating external processes or displays.

Usage in ComfyUI Workflows

In a ComfyUI workflow, the ComfyDeployWebsocketImageOutput node is typically employed at the end of an image processing pipeline. After the image has been generated or transformed by preceding nodes, this node sends the completed image to an external client. Example use cases include:

• Displaying generated images in a web-based interface in real-time.
• Sending processed images to a remote server for further analysis.
• Enabling real-time updates and dynamic content generation in interactive applications.

Special Features and Considerations

• Real-Time Image Transmission: The websocket-based communication enables immediate image transfer, ideal for applications requiring instant feedback or updates.
• Flexible Image Format Support: The ability to output in multiple popular file formats (WEBP, PNG, JPEG) caters to diverse needs for image quality and size.
• Input Validation: The node includes validation checks to ensure that the output_id is ASCII-encoded and does not exceed a predefined length, ensuring robust communication and identification.

Conclusion

The ComfyDeployWebsocketImageOutput node is an essential tool for deploying image outputs from ComfyUI workflows to external clients. By offering real-time image transmission over websocket, it supports dynamic and interactive applications, contributing to the versatility of the ComfyDeploy platform.