Kanzi Connect  3.9.9
Kanzi Connect C++ API
kanzi::connect::ReceiverNode2D Class Reference

ReceiverNode2D provides the implementation to render a video stream. More...

#include <receiver_node2d.hpp>

Inheritance diagram for kanzi::connect::ReceiverNode2D:
kanzi::connect::ReceiverNodeConceptImpl< Node2D, ReceiverNode2D > kanzi::connect::ReceiverNodeConcept

Static Public Member Functions

static ReceiverNode2DSharedPtr create (Domain *domain, string_view name)
 Creates a ReceiverNode2D node. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::connect::ReceiverNodeConceptImpl< Node2D, ReceiverNode2D >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::connect::ReceiverNodeConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

optional< Vector2 > calculateNormalizedTouchPoint (InputManipulator::InputMessageArguments &args)
 Calculates the touch point in normalized stream coordinates, where (0, 0) is top left of the stream and (1, 1) is bottom right. More...
 
Vector2 measureOverride (Vector2 availableSize) override
 Node2D::measureOverride() implementation. More...
 
 ReceiverNode2D (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::connect::ReceiverNodeConceptImpl< Node2D, ReceiverNode2D >
void onAttached () override
 kanzi::Node::onAttached() implementation. More...
 
void onDetached () override
 kanzi::Node::onDetached() implementation. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 kanzi::Node::onPropertyChanged implementation. More...
 
 ReceiverNodeConceptImpl (Domain *domain, string_view name)
 Constructor. More...
 
void updateTexturesTask (PixelFrameWeakPtr frame)
 Handler for kanzi::PanManipulator::StartedMessage. More...
 

Protected Attributes

friend ConceptClass
 
- Protected Attributes inherited from kanzi::connect::ReceiverNodeConceptImpl< Node2D, ReceiverNode2D >
MaterialBrushSharedPtr m_brush
 The brush to render the material. More...
 
MaterialSharedPtr m_material
 Disable these to favor connect input service Default value for kanzi::Node::HitTestableProperty. More...
 
TextureSharedPtr m_uTexture
 The texture that contains the u-channel of the frame. More...
 
TextureSharedPtr m_vTexture
 The texture that contains the v-channel of the frame. More...
 
TextureSharedPtr m_yTexture
 The texture that contains the y-channel of the frame. More...
 

Additional Inherited Members

- Public Member Functions inherited from kanzi::connect::ReceiverNodeConceptImpl< Node2D, ReceiverNode2D >
string getStreamId () const
 Returns the value of the StreamIdProperty. More...
 
void initialize ()
 ReceiverNodeConceptImpl specific initialization. More...
 
void initializeStreamManager (size_t delay)
 
void onFrame (PixelFrameSharedPtr frame)
 Processes frames that are received through a PeerConnection. More...
 
void setStreamId (const string &streamId)
 Sets the value of the StreamIdProperty. More...
 
- Static Public Attributes inherited from kanzi::connect::ReceiverNodeConcept
static PropertyType< bool > IsOutputLinearProperty
 Indicates whether the output of the YUV to RGB shader is linear. More...
 
static PropertyType< string > StreamIdProperty
 Contains the stream ID that the ReceiverNode is configured to receive. More...
 
static PropertyType< string > StreamTypeProperty
 User defined type for the stream that the StreamingComponent will produce. More...
 
static PropertyType< ResourceSharedPtruTextureProperty
 Contains the U component texture for the ReceiverNode material. More...
 
static PropertyType< ResourceSharedPtrvTextureProperty
 Contains the V component texture for the ReceiverNode material. More...
 
static PropertyType< ResourceSharedPtryTextureProperty
 Contains the Y component texture for the ReceiverNode material. More...
 
- Protected Types inherited from kanzi::connect::ReceiverNodeConceptImpl< Node2D, ReceiverNode2D >
enum  OutputTextureIndex
 

Detailed Description

ReceiverNode2D provides the implementation to render a video stream.

ReceiverNode2D can only be accessed from the Kanzi thread unless otherwise noted.

See also
For 3D receiver, see ReceiverNode3D.

Constructor & Destructor Documentation

◆ ReceiverNode2D()

kanzi::connect::ReceiverNode2D::ReceiverNode2D ( Domain *  domain,
string_view  name 
)
explicitprotected

Constructor.

Member Function Documentation

◆ calculateNormalizedTouchPoint()

optional<Vector2> kanzi::connect::ReceiverNode2D::calculateNormalizedTouchPoint ( InputManipulator::InputMessageArguments &  args)
protected

Calculates the touch point in normalized stream coordinates, where (0, 0) is top left of the stream and (1, 1) is bottom right.

Parameters
argsArguments of an input message.
Returns
Normalized touch point if it was successfully calculated, nullopt otherwise.

◆ create()

static ReceiverNode2DSharedPtr kanzi::connect::ReceiverNode2D::create ( Domain *  domain,
string_view  name 
)
static

Creates a ReceiverNode2D node.

Parameters
domainThe UI domain to which the node belongs.
nameThe name of the node.
Returns
The created node.

◆ makeEditorInfo()

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

◆ measureOverride()

Vector2 kanzi::connect::ReceiverNode2D::measureOverride ( Vector2  availableSize)
overrideprotected

Node2D::measureOverride() implementation.

Member Data Documentation

◆ ConceptClass


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