StreamingComponent

class kanzi::connect::StreamingComponent : public NodeComponent

StreamingComponent streams content from a 2D node that it is attached to.

StreamingComponents can only be attached to 2D nodes, and attaching a StreamingComponent will override the nodes Node2D::RenderTargetProperty.

StreamingComponent can only be accessed from the signaling thread unless otherwise noted.

Public Functions

const string &getRegisteredId() const

Returns the ID of the StreamingComponent that it was registered with.

Return

The id of the StreamingComponent was registered with, or empty string if the StreamingComponent has not been registered.

Public Static Functions

StreamingComponentSharedPtr create(Domain *domain, string_view name)
PropertyTypeEditorInfoSharedPtr makeEditorInfo()

Public Static Attributes

PropertyType<bool> IsInputLinearProperty

Indicates whether the input of the RGB to YUV shader is linear.

This property is only used with the StreamingComponent materials.

PropertyType<string> StreamIdProperty

User defined ID for the stream that the StreamingComponent will produce.

A system chosen ID will be used when user defined ID is empty.

PropertyType<string> StreamTypeProperty

User defined type for the stream that the StreamingComponent will produce.

“zstd” will be used when user defined type is empty.