ComfyUI Node: STREAM WRITER (JOV) 🎞️

STREAM WRITER (JOV) 🎞️:

The Stream Writer node is designed to send frames to a specified route, making it ideal for live streaming or recording purposes. This node accepts tensors representing images and allows you to configure various parameters such as the route, resolution, scaling mode, interpolation method, and matte color. By continuously streaming frames to the specified route, it enables real-time visualization or recording of processed video data, making it a powerful tool for AI artists who need to broadcast or save their creative work in real-time.

STREAM WRITER (JOV) 🎞️ Input Parameters:

PIXEL

This parameter accepts tensors representing images. It is the primary input for the node, where you provide the image data that you want to stream. The format and type of the tensor should be compatible with the node's processing capabilities.

ROUTE

This is a string parameter that specifies the route to which the frames will be sent. The default value is "/stream". This route is typically a URL or a path where the streaming server is listening for incoming frames. Configuring this correctly ensures that your frames are sent to the right destination for live streaming or recording.

MODE

This parameter defines the scaling mode to be used when processing the frames. It accepts values from the EnumScaleMode enumeration, with the default being NONE. The scaling mode determines how the image is resized, which can affect the quality and performance of the streaming.

WH

This parameter is a vector (VEC2) that specifies the resolution of the output frames. The default value is (512, 512), with a minimum value defined by MIN_IMAGE_SIZE. You can adjust the width (W) and height (H) to match the desired resolution for your stream. Proper configuration of this parameter ensures that the output frames have the correct dimensions.

SAMPLE

This parameter defines the interpolation method to be used when scaling the frames. It accepts values from the EnumInterpolation enumeration, with the default being LANCZOS4. The interpolation method affects the quality of the resized images, with different methods providing various balances between speed and quality.

MATTE

This parameter is a vector (VEC4) that specifies the matte color to be used for the frames. The default value is (0, 0, 0, 0), representing a transparent color. The vector components represent the red (R), green (G), blue (B), and alpha (A) channels. Configuring this parameter allows you to set a background color for the frames, which can be useful for compositing or visual effects.

STREAM WRITER (JOV) 🎞️ Output Parameters:

This node does not have explicit output parameters as it is designed to stream frames to a specified route rather than returning data to the workflow. The primary function is to send the processed frames to the configured destination for real-time visualization or recording.

STREAM WRITER (JOV) 🎞️ Usage Tips:

• Ensure that the ROUTE parameter is correctly configured to match the destination where you want to stream the frames. This could be a URL or a local path.
• Adjust the WH parameter to set the resolution that best fits your streaming needs. Higher resolutions may require more processing power and bandwidth.
• Choose an appropriate MODE and SAMPLE to balance between performance and image quality. For example, LANCZOS4 provides high-quality interpolation but may be slower than other methods.
• Use the MATTE parameter to set a background color if your frames require a specific backdrop, especially when dealing with transparent images.

STREAM WRITER (JOV) 🎞️ Common Errors and Solutions:

"Invalid route specified"

• Explanation: The ROUTE parameter is not correctly configured, or the destination server is not reachable.
• Solution: Verify that the route is correct and that the destination server is running and accessible.

"Unsupported tensor format"

• Explanation: The input tensor format is not compatible with the node's processing capabilities.
• Solution: Ensure that the input tensor is in a supported format. Refer to the node's documentation for compatible tensor types.

"Resolution out of bounds"

• Explanation: The WH parameter values are outside the acceptable range.
• Solution: Adjust the width and height values to be within the minimum and maximum limits specified by the node.

"Interpolation method not recognized"

• Explanation: The SAMPLE parameter value is not a valid interpolation method.
• Solution: Choose a valid interpolation method from the EnumInterpolation enumeration.