kanzi::connect::StreamingComponent Class Reference

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

#include <streaming_component.hpp>

Inheritance diagram for kanzi::connect::StreamingComponent:

Public Member Functions
const string &	getRegisteredId () const
	Returns the ID of the StreamingComponent that it was registered with. More...

Static Public Member Functions
static StreamingComponentSharedPtr	create (Domain *domain, string_view name)
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static PropertyType< bool >	IsInputLinearProperty
	Indicates whether the input of the RGB to YUV shader is linear. More...
static PropertyType< string >	StreamIdProperty
	User defined ID for the stream that the StreamingComponent will produce. More...
static PropertyType< string >	StreamTypeProperty
	User defined type for the stream that the StreamingComponent will produce. More...

Protected Member Functions
void	attachOverride () final
	kanzi::NodeComponent::attachOverride() implementation. More...
void	detachOverride () final
	kanzi::NodeComponent::detachOverride() implementation. More...
void	onPropertyChanged (kanzi::AbstractPropertyType propertyType, kanzi::PropertyNotificationReason reason) override
	kanzi::NodeComponent::onPropertyChanged() implementation. More...
	StreamingComponent (Domain *domain, string_view name)

Detailed Description

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.

Constructor & Destructor Documentation

StreamingComponent()

kanzi::connect::StreamingComponent::StreamingComponent ( Domain *  domain, string_view  name  )

explicitprotected

Member Function Documentation

attachOverride()

void kanzi::connect::StreamingComponent::attachOverride ( )

finalprotected

kanzi::NodeComponent::attachOverride() implementation.

create()

static StreamingComponentSharedPtr kanzi::connect::StreamingComponent::create ( Domain *  domain, string_view  name  )

static

detachOverride()

void kanzi::connect::StreamingComponent::detachOverride ( )

finalprotected

kanzi::NodeComponent::detachOverride() implementation.

getRegisteredId()

const string& kanzi::connect::StreamingComponent::getRegisteredId

(

)

const

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

Returns

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

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::connect::StreamingComponent::makeEditorInfo ( )

static

onPropertyChanged()

void kanzi::connect::StreamingComponent::onPropertyChanged ( kanzi::AbstractPropertyType  propertyType, kanzi::PropertyNotificationReason  reason  )

overrideprotected

kanzi::NodeComponent::onPropertyChanged() implementation.

Member Data Documentation

IsInputLinearProperty

PropertyType<bool> kanzi::connect::StreamingComponent::IsInputLinearProperty

static

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

This property is only used with the StreamingComponent materials.

StreamIdProperty

PropertyType<string> kanzi::connect::StreamingComponent::StreamIdProperty

static

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

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

StreamTypeProperty

PropertyType<string> kanzi::connect::StreamingComponent::StreamTypeProperty

static

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

"zstd" will be used when user defined type is empty.

---

The documentation for this class was generated from the following file:

• connect/kanzi_adaptation/viewport/streaming_component.hpp