Kanzi Connect  1.1.10
Kanzi Connect C++ API
kanzi::connect::StreamEncodeUtil Class Referenceabstract

#include <stream_controller.hpp>

Inheritance diagram for kanzi::connect::StreamEncodeUtil:
kanzi::connect::ConnectStreamEncodeUtil kanzi::connect::StreamEncodeUtil_zlib

Public Member Functions

virtual void encodeFramebuffer (FramebufferSharedPtr framebuffer)=0
 Encode new framebuffer and send data. More...
 
virtual bool initialize (Domain &domain, StreamEncodeParameters &parameters)=0
 Prepare new encoder. More...
 
virtual void uninitialize (bool softUninitialize=false)=0
 Release encoder. More...
 
virtual ~StreamEncodeUtil ()
 Destructor. More...
 

Constructor & Destructor Documentation

◆ ~StreamEncodeUtil()

virtual kanzi::connect::StreamEncodeUtil::~StreamEncodeUtil ( )
virtual

Destructor.

Member Function Documentation

◆ encodeFramebuffer()

virtual void kanzi::connect::StreamEncodeUtil::encodeFramebuffer ( FramebufferSharedPtr  framebuffer)
pure virtual

Encode new framebuffer and send data.

Parameters
framebufferFramebuffer which is to be encoded and sent.

Implemented in kanzi::connect::ConnectStreamEncodeUtil.

◆ initialize()

virtual bool kanzi::connect::StreamEncodeUtil::initialize ( Domain &  domain,
StreamEncodeParameters parameters 
)
pure virtual

Prepare new encoder.

Parameters
domainInstance of kanzi::Domain. Used for obtaining connection parameters and connect services.
parametersStream encoder parameters.
Returns
If both encoder and connections setup succeeded, true, otherwise false.

Implemented in kanzi::connect::ConnectStreamEncodeUtil.

◆ uninitialize()

virtual void kanzi::connect::StreamEncodeUtil::uninitialize ( bool  softUninitialize = false)
pure virtual

Release encoder.

Parameters
softUninitializeIf false, closes the connection.

Implemented in kanzi::connect::ConnectStreamEncodeUtil.


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