Namespace for the ADTF Streaming SDK. More...

Namespaces
namespace	ant
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.0.

namespace	catwo
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.2.

namespace	elasto
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.4.

namespace	flash
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.5.

namespace	hollow
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.7.

namespace	kiwi
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.10.

namespace	lucky
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.11.

namespace	penguin
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.15.

namespace	quiet
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.16.

namespace	spider
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.18.

namespace	stream_image_format
	Container namespace to predefine some common imageformats within ADTF.

namespace	testing
	Namespace for all testing functionality provided within the ADTF Streaming SDK.

namespace	thor
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.19.

namespace	vision
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.21.

namespace	wolverine
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.22.

namespace	zebra
	Namespace for all functionality of the ADTF Streaming SDK provided since v3.25.

Classes
class	binding_proxy
	bring latest ant::binding_proxy to default scope More...

class	binding_type
	bring latest ant::binding_type to users scope More...

class	cActiveRunner

class	cBindingClient

class	cBindingProxyInPort
	bring latest ant::cBindingProxyInPort to users scope More...

class	cBindingProxyOutPort
	bring latest ant::cBindingProxy to users scope More...

class	cBindingServer

class	cBindingType
	bring latest ant::cBindingType to users scope More...

class	cCamelionStreamType

class	cConfigurableInPin

class	cConfigurableOutPin

class	cDefaultBindingProxy
	bring latest ant::cDefaultBindingProxy to default scope More...

class	cDynamicSampleReaderQueue
	Implementation of a adtf::streaming::ant::ISampleReaderQueue with dynamic growing sample queue. More...

class	cExternalQueueSampleReader

class	cExternelQueueSampleReader
	Sample reader which allows the registration of external queue. More...

class	cFilterBase
	The cFilterBase class implements a basic filter that supports the ant::IFilter interfaces. More...

class	cFilterGraph

class	cFilterGraphClientPort
	bring latest ant::cFilterGraphClientPort to users scope More...

class	cFilterGraphDataInPort
	bring latest ant::cFilterGraphDataInPort to users scope More...

class	cFilterGraphDataOutPort
	bring latest ant::cFilterGraphDataOutPort to users scope More...

class	cFilterGraphRunnerPort
	bring latest ant::cFilterGraphRunnerPort to users scope More...

class	cFilterGraphServerPort
	bring latest ant::cFilterGraphServerPort to users scope More...

class	cGraph
	bring the latest ant::cFilterGraph to users scope More...

class	cInPin

class	cLastSamplesCollector

class	cNamedGraphObject

class	cNullReader

class	cOutPin

class	cReferenceSample

class	cRequestForwardingWriter

class	cRunner

class	cSample

class	cSampleLogEntry
	brings latest ant::cSampleLogEntry to users scope More...

class	cSampleLogEntryTransmitReceiveStateBuffer
	brings latest ant::cSampleLogEntryTransmitReceiveStateBuffer to users scope More...

class	cSampleReader
	The default Sample Reader will read the incomung Stream of a IInPin. This sample reader has no internal queue! Make sure if you use this sample reader with ISampleStreamAccess::PushRead to register a external queue or to override the adtf::streaming::ant::cSampleReader::ReadNextSample and adtf::streaming::ant::cSampleReader::Push methods. More...

class	cSampleSetCollector

class	cSampleStream
	bring latest ant::cSampleStream to users scope More...

class	cSampleStreamingSink

class	cSampleStreamingSource

class	cSampleStreamInPort
	bring latest quiet::cSampleStreamInPort to users scope More...

class	cSampleStreamOutPort
	bring latest quiet::cSampleStream to users scope More...

class	cSampleWriter

class	cStreamingGraph

class	cStreamItem

class	cStreamMetaType
	brings latest ant::cStreamMetaType to the users scope More...

class	cStreamType
	brings latest ant::cStreamType to the users scope More...

class	cTimeBasedSampleSetCollector

class	cWeakBindingServer

class	graph

class	graph_connection

class	IActiveRunner
	Alias moving ant::IActiveRunner into scope. More...

class	IBindingClient

class	IBindingObject
	brings latest ant::IBindingObject to users scope More...

class	IBindingProxy

class	IBindingProxyInPort

class	IBindingProxyOutPort

class	IBindingServer

class	IBindingType
	brings latest ant::IBindingType to users scope More...

class	IBlockableSampleStream

class	IDataBinding
	brings the latest ant::IDataBinding to users scope. More...

class	IDynamicDataBinding

class	IDynamicInterfaceBinding

class	IFilter

class	IFilterGraph
	keeping ant::IFilterGraph for compatibility More...

class	IFilterGraphConnection
	brings the ant::IFilterGraphConnection to users scope More...

class	IFilterGraphDataInPort
	brings latest ant::IFilterGraphDataInPort to the users scope More...

class	IFilterGraphDataOutPort
	brings latest ant::IFilterGraphDataOutPort to the users scope More...

class	IFilterGraphDataPort
	brings latest ant::IFilterGraphDataPort to the users scope More...

class	IFilterGraphInterfaceClientPort
	brings latest ant::IFilterGraphInterfaceClientPort to the users scope More...

class	IFilterGraphInterfacePort
	brings latest ant::IFilterGraphInterfacePort to the users scope More...

class	IFilterGraphInterfaceServerPort
	brings latest ant::IFilterGraphInterfaceServerPort to the users scope More...

class	IFilterGraphPort
	brings latest ant::IFilterGraphPort to the users scope More...

class	IFilterGraphRunnerPort
	brings latest ant::IFilterGraphRunnerPort to the users scope More...

class	IGraph

class	IGraphConnection

class	IInPin
	brings latest ant::IInPin to the users scope More...

class	IInterfaceBinding

class	IInternalBindingProxy

class	INamedGraphObject
	bring latest ant::INamedGraphObject to users scope More...

class	interface_binding
	bring latest ant::interface_binding to users scope More...

class	IOutPin
	brings latest ant::IOutPin to the users scope More...

class	IPin
	brings latest ant::IInPin to the users scope More...

class	IRunner
	Alias always bringing the latest version of ant::IRunner into scope. More...

class	IRuntimeBehaviour
	brings the latest ant::IRuntimeBehaviour to users scope More...

class	is_stream_meta_type

class	ISample

class	ISampleBuffer
	bring latest ant::ISampleBuffer to users scope More...

class	ISampleBufferFactory
	bring latest ant::ISampleBufferFactory to users scope More...

class	ISampleInfo
	brings latest ant::ISampleInfo to users scope More...

class	ISampleInStream
	brings latest ant::ISampleInStream to the users scope More...

class	ISampleOutStream
	brings latest ant::ISampleOutStream to the users scope More...

class	ISampleReader
	brings the latest ant::ISampleReader in users scope More...

class	ISampleReaderQueue
	Interface to create a sample reader buffer. More...

class	ISampleSerialization

class	ISampleStream
	bring latest ant::ISampleStream to users scope More...

class	ISampleStreamAccess
	bring the latest ant::ISampleStreamAccess into user scope. More...

class	ISampleStreamer
	brings the latest ant::ISampleStreamer in users scope More...

class	ISampleStreamingSink

class	ISampleStreamingSource

class	ISampleStreamInPort

class	ISampleStreamOutPort

class	ISampleStreamStatistics
	Samplestream statistics Interface. This interface describes statistical information of an ISampleStream. More...

class	ISampleWriter
	brings the latest ant::ISampleWriter in users scope More...

class	IStreamingGraph
	bring lates to user scope More...

class	IStreamingInPort
	bring lates to user scope More...

class	IStreamingOutPort
	bring lates to user scope More...

class	IStreamingPort
	bring lates to user scope More...

class	IStreamingRequest

class	IStreamingRequests

class	IStreamingService

class	IStreamingSink

class	IStreamingSource

class	IStreamItem
	brings latest ant::IStreamItem to users scope More...

class	IStreamMetaType
	Defines access methods for a Stream Meta Type. More...

class	IStreamType
	Defines access methods for the interface of a Stream Type. More...

class	IStreamTypeHandler

class	ITriggerPipe
	bring latest ant::ITriggerPipe to users scope More...

class	ITriggerPipeHierachy
	bring latest quiet::ITriggerPipeHierachy to users scope More...

class	ITriggerPipeItem
	bring latest ant::ITriggerPipeItem to users scope More...

class	ITriggerPipeSource
	bring latest ant::ITriggerPipeSource to users scope More...

class	named_graph_object
	brings latest ant::named_graph_object to the users scope More...

class	output_sample_data

class	request_forwarding_reader

class	requestable_writer

class	runtime_behaviour
	brings latest ant::runtime_behaviour to the users scope More...

class	sample_data

class	sample_reader
	Reads and stores Samples within the given queue implementation `INTERNAL_QUEUE`. More...

class	sample_stream

class	sample_writer

class	size_limited_sample_reader_queue

class	stream_meta_type
	brings latest ant::stream_meta_type to the users scope More...

struct	stream_meta_type_anonymous
	Use this Stream Meta Type only if no property should be set and you do not share and record these data. Anonymous can be any kind of data. More...

struct	stream_meta_type_audio
	Use this Stream Meta Type for describing a audio stream with samples and sample rate. More...

struct	stream_meta_type_image
	Use this Stream Meta Type for describing a video stream with single frames and there format and set the values with set_stream_type_image_format. More...

struct	stream_meta_type_plain
	Use this Stream Meta Type if your sample data will be any of this type: bool, uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float, double or plain array T[], std::array, std::vector of them. More...

struct	stream_meta_type_string
	Use this Stream Meta Type if your sample data will be any of this type: std::string, std::u16string. More...

struct	stream_meta_type_substreams
	Use cSubStreamTypes to create a Stream Type instance for this Stream Meta Type. More...

class	stream_type
	brings latest flash::stream_type to the users scope More...

class	stream_type_anonymous
	Generator template to create an instance of a ant::IStreamType class for ant::stream_meta_type_anonymous ("adtf/anonymous"). More...

class	stream_type_audio
	Generator template to create an instance of a ant::IStreamType class for ant::stream_meta_type_audio ("adtf/audio"). More...

class	stream_type_image
	Generator template to create an instance of a ant::IStreamType class for lucky::stream_meta_type_image ("adtf/image"). More...

class	stream_type_plain
	Generator template to create an instance of a ant::IStreamType class for penguin::stream_meta_type_plain ("adtf/plaintype"). More...

class	stream_type_string
	Generator template to create an instance of a ant::IStreamType class for penguin::stream_meta_type_string ("adtf/string"). More...

class	time_limited_sample_reader_queue

class	trigger_pipe_item

class	trigger_pipe_source

struct	tStreamAudioFormat

struct	tStreamImageFormat

Typedefs
template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>
using	time_limited_sample_reader

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>
using	size_limited_sample_reader

using	cSingleSampleReader
	The cSingleSampleReader will create a sample reader which will create a internal sample queue with only one sample which holds the last received sample always.

using	cDynamicSampleReader
	The cDynamicSampleReader will create a sample reader which will create a internal sample queue with unlimited size.

typedef adtf_util::string_base< cStreamFormatStorageType >	tStreamImageFormatName
	formatname type as stack string (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)

Functions
tResult	add_piped_connections (IFilterGraph &oGraph, adtf_util::cStringList lstObjectNames, bool bSync=true)

tResult	add_paired_connections (IFilterGraph &oGraph, adtf_util::cStringList lstObjectNames, bool bSync=true)

tResult	get_filter_graph_object (const IFilterGraph &oGraph, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObject)

tResult	get_filter_graph_objects (const IFilterGraph &oGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &lstObjects)

tResult	create_trigger_pipe (const char *strNameOfPipe, adtf::ucom::ant::iobject_ptr< ITriggerPipe > &pTriggerPipe, adtf::ucom::ant::object_list< ITriggerPipeItem > lstNextItems)

tResult	check_loop_call_in_trigger_pipe (const adtf::streaming::ant::ITriggerPipeSource &pItem)

template<typename DATABINDING_BEHAVIOUR_CLASS>
tResult	create_inner_pipe (DATABINDING_BEHAVIOUR_CLASS &oComponent, adtf_util::cStringList lstItems)

template<typename Interface, typename InterfaceBinding>
tResult	create_server (InterfaceBinding &oInterfaceBinding, const char *strServerName, const adtf::ucom::iobject_ptr< Interface > &pServerInterface)

template<typename Interface, typename InterfaceBinding>
tResult	create_client (InterfaceBinding &oInterfaceBinding, const char *strClientName)

tResult	create_runner (cFilterBase &oFilter, const char *strNameOfRunner, adtf::base::ant::IRunnable &oRunnable)

tResult	get_named_graph_object_from_graph (IGraph &oGraph, const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObjectFound)

adtf_util::cString	get_named_graph_object_full_name (const INamedGraphObject &oGraphObject)

void	set_description (base::ant::IConfiguration &oConfig, const char *strDescription)

void	set_editor (base::ant::IConfiguration &oConfig, const char strName, const char strUrl)

void	set_editors (base::ant::IConfiguration &oConfig, const std::vector< std::pair< std::string, std::string > > &oEditors)

void	set_help_link (base::ant::IConfiguration &oConfig, const char *strUrl)

void	set_description (base::ant::IConfiguration &oConfig, const char strItem, const char strDescription)

std::string	get_help_link (base::ant::IConfiguration &oConfig)

tResult	add_graph_object (ant::cGraph &oGraph, const util::cString &strCID, const util::cString &strName, const std::map< util::cString, util::cString > &oProperties, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pObject)
	Convenience functionality to create and add add graph object to a existing graph.

tResult	add_binding_proxy (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pBindingProxy)
	adds a Binding Proxy to a graph and return the created proxy.

tResult	add_data_in_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds an In Port to a graph and return the created port.

tResult	add_data_out_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds an Out Port to a graph and return the created port.

tResult	add_sample_stream (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pSampleStream)

tResult	add_sample_stream_in_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds a Stream In Port to a graph and return the created port.

tResult	add_sample_stream_out_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
	adds a Stream Out Port to a graph and return the created port.

void	get_child_objects (ant::INamedGraphObject &oObject, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all child objects of the given `oObject`.

void	get_graph_objects (ant::IGraph *pGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all graph objects out of the `pGraph`.

void	get_runner_objects (ant::IRuntimeBehaviour *pRuntimeBehaviour, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all runner objects object out of `pRuntimeBehaviour`.

void	get_data_binding_objects (ant::IDataBinding *pDataBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &oObjects)
	Get all the data binding objects out of `pDataBinding`.

void	get_interface_binding_objects (ant::IInterfaceBinding *pInterfaceBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &oObjects)
	Get all the interface binding objects out of `pInterfaceBinding`.

template<typename Interface, typename InterfaceBinding>
tResult	create_weak_binding_server (InterfaceBinding &oInterfaceBinding, const char *strName, const ucom::ant::iobject_ptr< Interface > &pObject)

template<typename DATA_BINDING_IMPL_TYPE, typename READER_OR_WRITER, typename PIN_INTERFACE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, READER_OR_WRITER &oStreamer, ucom::ant::iobject_ptr< PIN_INTERFACE > &pCreatedPin)

tResult	alloc_sample (ucom::ant::iobject_ptr< ucom::ant::IObject > &pSample)

base::flash::tNanoSeconds	get_sample_time (const ucom::ant::iobject_ptr< const ant::ISample > &pSample)

base::flash::tNanoSeconds	get_sample_time (const ant::ISample &oSample)

void	set_sample_time (const ucom::ant::iobject_ptr< ant::ISample > &pSample, base::flash::tNanoSeconds tmTimeStamp)

void	set_sample_substream_id (ant::ISample &oSample, uint32_t nSubStreamId)

uint32_t	get_sample_substream_id (const ant::ISample &oSample)

template<typename T>
tResult	read_from_sample (const ISample &oSample, T &oValue)

template<typename T>
tResult	write_to_sample (ISample &oSample, const T &oValue)

tResult	get_default_buffer_factory (adtf::ucom::iobject_ptr< ISampleBufferFactory > &pFactory)

tResult	get_reference_buffer_factory (adtf::ucom::iobject_ptr< ISampleBufferFactory > &pFactory)

adtf::util::cVariant	get_sample_info (const ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oDefault)

tResult	set_sample_info (ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oValue)

ISampleInfo::tHashKey	create_sample_info_hash_key (const char *strToHash)

tResult	make_sample_reader (ISampleReader &oReader, const char *strNameOfReader, const ucom::iobject_ptr< const IStreamType > &pStreamType)

tResult	make_sample_writer (ISampleWriter &oWriter, const char *strNameOfWriter, const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)

bool	stream_image_format_is_generic_rgb (const tStreamImageFormat &strFormat)

bool	stream_image_format_is_generic (const tStreamImageFormat &strFormat)

unsigned int	stream_image_format_get_generic_pixel_size (const tStreamImageFormat &strFormat)

uint32_t	stream_image_format_get_generic_mask (const char *strChannel, const tStreamImageFormat &strFormat)

template<typename WRITER_TYPE>
WRITER_TYPE &	flush (WRITER_TYPE &oWriter)

template<typename WRITER_TYPE>
WRITER_TYPE &	trigger (WRITER_TYPE &oWriter)

tResult	get_streaming_graph_object (const IStreamingGraph &oGraph, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObject)

tResult	get_streaming_graph_objects (const IStreamingGraph &oGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &lstObjects)

tResult	set_stream_type_audio_format (IStreamType &oType, const tStreamAudioFormat &sFormat)

tResult	get_stream_type_audio_format (tStreamAudioFormat &sFormat, const IStreamType &oType)

ucom::ant::object_ptr< ant::IStreamType >	create_adtf_audio_stream_type ()

tResult	set_stream_type_image_format (IStreamType &oType, const tStreamImageFormat &oFormat)

tResult	get_stream_type_image_format (tStreamImageFormat &oFormat, const IStreamType &oType)

ucom::ant::object_ptr< ant::IStreamType >	create_adtf_image_stream_type ()

template<typename T>
ucom::ant::object_ptr< ant::IStreamType >	create_adtf_plain_stream_type ()
	brings latest penguin::create_adtf_plain_stream_type to the users scope

template<typename VALUETYPE>
VALUETYPE	get_property (const IStreamType &oStreamType, const char *strNameOfValue, VALUETYPE oDefaultValue)

template<typename VALUETYPE>
tResult	set_property (IStreamType &oStreamType, const char *strNameOfValue, VALUETYPE oValue)

tResult	is_compatible (const ant::IStreamType &oCheckedType, const ant::IStreamType &oExpectedType)

tResult	is_equal (const ant::IStreamType &oLeftType, const ant::IStreamType &oRightType)

template<typename ObjectType>
bool	has_trigger_parent (const ObjectType *pChild)
	bring latest riddler::has_parent to users scope

Detailed Description

Namespace for the ADTF Streaming SDK.

Within this namespace all interfaces, classes and functions always refer to their last revised implementation (version namespace). When using types defined within this namespace it is guaranteed to always use the latest version of the types.

The ADTF Streaming SDK defines the ADTF Streaming Architecture.

The main focus of this package is to define a valid user application with the help of a filter graph. The processing of the filter graph is configurable by data pipes and trigger pipes to control the data streaming and the runtime behaviour.

Typedef Documentation

◆ cDynamicSampleReader

using adtf::streaming::flash::cDynamicSampleReader

The cDynamicSampleReader will create a sample reader which will create a internal sample queue with unlimited size.

Remarks: Make sure a a sample receive callback will read until the queue is empty !

This implementation uses the cDynamicSampleReaderQueue as dynamic sample queue implementation.

◆ cSingleSampleReader

using adtf::streaming::flash::cSingleSampleReader

The cSingleSampleReader will create a sample reader which will create a internal sample queue with only one sample which holds the last received sample always.

◆ size_limited_sample_reader

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>

using adtf::streaming::flash::size_limited_sample_reader

The size_limited_sample_reader will create a sample reader which will create a internal sample queue that is sample count item limited by the given TimeRange.

Template Parameters

MAX_SIZE	The count in amount of samples (has to be set while compile time!).
STORELASTSAMPLE	Option if the last sample received will be hold. true - last sample is stored false - last sample is droped if after Read call

◆ time_limited_sample_reader

template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>

using adtf::streaming::flash::time_limited_sample_reader

The time_limited_sample_reader will create a sample reader which will create a internal sample queue that is time limited by the given TimeRange.

Template Parameters

TIME_RANGE	The timerange in micro seconds (has to be set while compile time!).
STORELASTSAMPLE	Option if the last sample received will be hold. true - last sample is stored false - last sample is droped if after Read call

Function Documentation

◆ add_binding_proxy()

tResult adtf::streaming::devil::add_binding_proxy	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pBindingProxy )

inline

adds a Binding Proxy to a graph and return the created proxy.

Parameters

oGraph	The graph where to add the Binding Proxy to.
strName	Name of the Binding Proxy within the graph
nOrderNumber	The order numer of the new Binding Proxy.
pBindingProxy	Return value for the instance of the Binding Proxy created.

Returns: tResult

◆ add_data_in_port()

tResult adtf::streaming::devil::add_data_in_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds an In Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the In Port to.
strName	Name of the In Port within the graph
nOrderNumber	The order numer of the new In Port.
pPort	Return value for the instance of the port created.

Returns: tResult

◆ add_data_out_port()

tResult adtf::streaming::devil::add_data_out_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds an Out Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the Out Port to.
strName	Name of the Out Port within the graph.
nOrderNumber	The order numer of the new Out Port.
pPort	Return value for the instance of the port created.

Returns: tResult

◆ add_graph_object()

tResult adtf::streaming::devil::add_graph_object	(	ant::cGraph &	oGraph,
		const util::cString &	strCID,
		const util::cString &	strName,
		const std::map< util::cString, util::cString > &	oProperties,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pObject )

inline

Convenience functionality to create and add add graph object to a existing graph.

Parameters

oGraph	The Graph where to add the object.
strCID	The class interface name of class to create the object.
strName	The name of the object within the graph.
oProperties	The properties to set.
nOrderNumber	the order number of the object
pObject	Return value for the instance of the object created.

Returns: tResult

◆ add_paired_connections()

tResult adtf::streaming::add_paired_connections	(	IFilterGraph &	oGraph,
		adtf_util::cStringList	lstObjectNames,
		bool	bSync = true )

This is a helper function to create paired connections on the given FilterGraph instance oGraph. For each item[N] of lstObjectNames a cFilterGraph::AddConnection call is created with the source item[N] and the destination item[N+1]. N is a multiple of 2.

The names within lstObjectNames must be named graph objects of the FilterGraph oGraph.

Parameters

[in]	oGraph	Graph instance where to add the connections to.
[in]	lstObjectNames	The names of the named graph objects to connect.
[in]	bSync	Determines if the connections will be synchronous or asynchronous.

Returns: Standard Result Code - depends on the cFilterGraph::AddConnection return value.

Return values

ERR_NOT_FOUND There is a name in lstObjectNames which is not a object of oGraph.

◆ add_piped_connections()

tResult adtf::streaming::add_piped_connections	(	IFilterGraph &	oGraph,
		adtf_util::cStringList	lstObjectNames,
		bool	bSync = true )

This is a helper function to create piped connections on the given FilterGraph instance oGraph. For each item[N] of lstObjectNames a cFilterGraph::AddConnection call is created with the source item[N] and the destination item[N+1]. The names within lstObjectNames must be named graph objects of the FilterGraph oGraph.

Parameters

[in]	oGraph	Graph instance where to add the connections to.
[in]	lstObjectNames	The names of the named graph objects to connect.
[in]	bSync	Determines if the connections will be synchronous or asynchronous.

Returns: Standard Result Code - depends on the cFilterGraph::AddConnection return value.

Return values

ERR_NOT_FOUND There is a name in lstObjectNames which is not a object of oGraph.

◆ add_sample_stream_in_port()

tResult adtf::streaming::devil::add_sample_stream_in_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		const util::cString &	strPortID,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds a Stream In Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the Stream In Port to.
strName	Name of the Stream In Port within the graph
strPortID	Port ID as it appears in the streaming graph
nOrderNumber	The order numer of the new Stream In Port.
pPort	Return value for the instance of the port created.

Returns: tResult

◆ add_sample_stream_out_port()

tResult adtf::streaming::devil::add_sample_stream_out_port	(	ant::cGraph &	oGraph,
		const util::cString &	strName,
		const util::cString &	strPortID,
		int32_t	nOrderNumber,
		ucom::iobject_ptr< ucom::IObject > &	pPort )

inline

adds a Stream Out Port to a graph and return the created port.

Parameters

oGraph	The graph where to add the Stream Out Port to.
strName	Name of the Stream Out Port within the graph
strPortID	Port ID As it appears in the streaming graph
nOrderNumber	The order numer of the new Stream Out Port.
pPort	Return value for the instance of the port created.

Returns: tResult

◆ alloc_sample()

tResult adtf::streaming::flash::alloc_sample ( ucom::ant::iobject_ptr< ucom::ant::IObject > & pSample )

Helper Function to get a ISample Instance through the adtf::ucom::ant::IRuntime.

Parameters

pSample [in, out] object_ptr to a ISample if succeeded. The default CID will be the get_class_id<cSample>().

Returns: Standard result code.

Note: rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

◆ check_loop_call_in_trigger_pipe()

tResult adtf::streaming::check_loop_call_in_trigger_pipe ( const adtf::streaming::ant::ITriggerPipeSource & pItem )

Checks a loop call in trigger pipe can be created with pItem and all registered subitems.

Parameters

[in] pItem beginning source item of the pipe.

Returns: Standard Result Code

Return values

ERR_NOERROR	No loop found. Everything is fine.
ERR_OUT_OF_RANGE	Endless Recursion found, there is a item which will call itself as child (also in depth 1)!

◆ create_adtf_audio_stream_type()

ucom::ant::object_ptr< ant::IStreamType > adtf::streaming::lucky::create_adtf_audio_stream_type ( )

inline

Convinience functionality to create a stream type audio.

Returns: created streamtype

See also: adtf::streaming::penguin::stream_type_audio

Deprecated: Use adtf::ucom::make_object_ptr<stream_type_audio<>>() instead.

◆ create_adtf_image_stream_type()

ucom::ant::object_ptr< ant::IStreamType > adtf::streaming::lucky::create_adtf_image_stream_type ( )

inline

Convenience functionality to create a stream type image.

Returns: the created type

See also: adtf::streaming::penguin::stream_type_image

Deprecated: Use adtf::ucom::make_object_ptr<stream_type_image<>>() instead.

◆ create_client()

template<typename Interface, typename InterfaceBinding>

tResult adtf::streaming::flash::create_client	(	InterfaceBinding &	oInterfaceBinding,
		const char *	strClientName )

Creates a binding client object for the given INTERFACE type and register it on the cFilterBase instance

Template Parameters

Interface	The IObject interface you want to register the binding client object for
InterfaceBinding	The class of the interface binding object

Parameters

[in]	oInterfaceBinding	Interfacebinding instance to register the client object to
[in]	strClientName	name of the object to register

Returns: Standard Result Code

◆ create_inner_pipe()

template<typename DATABINDING_BEHAVIOUR_CLASS>

tResult adtf::streaming::ant::create_inner_pipe	(	DATABINDING_BEHAVIOUR_CLASS &	oComponent,
		adtf_util::cStringList	lstItems )

inline

Creates a trigger pipe and registers it at the given oFilter instance.

You can use an initializer list for the lstItems as follow:

create_inner_pipe(m_oMyFilter, {"in_pin_1", "my_fancy_runner", "out_pin_1"};

adtf::streaming::create_inner_pipe

tResult create_inner_pipe(DATABINDING_BEHAVIOUR_CLASS &oComponent, adtf_util::cStringList lstItems)

Definition filterbase.h:131

This function will create a pipe where the "my_fancy_runner" will be called from "in_pin_1" if some a synchronous DataTrigger is received. "my_fanc_runner" will read data from "in_pin_1" by its Readers (or do something else) and writes data to the "out_pin_1". If the "my_fancy_runner" returns it will forward a synchronous DataTrigger to "out_pin_1".

Parameters

[in]	oComponent	databinding and runtime behavior instance where to register the trigger pipe.
[in]	lstItems	list of items of the trigger pipe. These items can be a registered Pin of the `oFilter` or a Runner of `oFilter`.

Returns: Standard Result Code of the cFilterBase::RegisterInnerPipe call.

Return values

ERR_NOT_FOUND A given name is not a Pin (InPin or OutPin) or a Runner registered on oFilter.

◆ create_runner()

tResult adtf::streaming::ant::create_runner	(	cFilterBase &	oFilter,
		const char *	strNameOfRunner,
		adtf::base::ant::IRunnable &	oRunnable )

inline

Creates a runner on the given cFilterBase and connect it to the given Runnable You only need to implement a Runnable

See also: adtf::base::runnable; adtf::base::IRunnable

Returns: Standard Result Code

◆ create_sample_info_hash_key()

ISampleInfo::tHashKey adtf::streaming::ant::create_sample_info_hash_key ( const char * strToHash )

Generation of unambigious hash key for a string. This generation is independent to process and platform.

Parameters

[in] strToHash null terminated string to generate a hash key for.

Returns: Hash key for strToHash.

◆ create_server()

template<typename Interface, typename InterfaceBinding>

tResult adtf::streaming::flash::create_server	(	InterfaceBinding &	oInterfaceBinding,
		const char *	strServerName,
		const adtf::ucom::iobject_ptr< Interface > &	pServerInterface )

Creates a binding server object for the given INTERFACE type and register it on the cFilterBase instance.

Template Parameters

Interface	The IObject interface you want to register the binding client object for
InterfaceBinding	The class of the interface binding object

Parameters

[in]	oInterfaceBinding	interfacebinding instance to register the server object to
[in]	strServerName	name of the object to register
[in]	pServerInterface	INTERFACE implementation instance. This will be the Server Object retrieved by IBindingClient::GetServerObject and IBindingProxy::GetServerObject

Returns: Standard Result Code

◆ create_trigger_pipe()

tResult adtf::streaming::create_trigger_pipe	(	const char *	strNameOfPipe,
		adtf::ucom::ant::iobject_ptr< ITriggerPipe > &	pTriggerPipe,
		adtf::ucom::ant::object_list< ITriggerPipeItem >	lstNextItems )

Creates a trigger pipe with given items in lstNextItems.

Parameters

[in]	strNameOfPipe	Name of pipe.
[out]	pTriggerPipe	reference to the pipe if created. (you need to hold the reference, otherwise the pipe is closed!)
[in]	lstNextItems	Items which will be connected to each other as pipe. Each Item[N+1] is registered as subitem of Item[N] by calling ITriggerPipeSource::RegisterSubItem.

Returns: Standard Result Code

Return values

ERR_NOERROR	No loop found. Everything is fine.
ERR_OUT_OF_RANGE	Endless Recursion found, there is a item which will call itself as child (also in depth 1)!

◆ create_weak_binding_server()

template<typename Interface, typename InterfaceBinding>

tResult adtf::streaming::elasto::create_weak_binding_server	(	InterfaceBinding &	oInterfaceBinding,
		const char *	strName,
		const ucom::ant::iobject_ptr< Interface > &	pObject )

This method creates and registers a new weak binding server (adtf::streaming::elasto::cWeakBindingServer) object.

Parameters

[in]	oInterfaceBinding	The interface binding implmentation to register the object at.
[in]	strName	The name of the server object.
[in]	pObject	The object that implements the given interface. Only a weak reference to this object will be stored.

Returns: Standard result.

◆ flush()

template<typename WRITER_TYPE>

WRITER_TYPE & adtf::streaming::ant::flush ( WRITER_TYPE & oWriter )

Global function template to flush a writer.

Template Parameters

WRITER_TYPE Type or sub class of cSampleWriter

Returns: Returns the flushed streamer

See also: cSampleWriter

◆ get_child_objects()

void adtf::streaming::hollow::get_child_objects	(	ant::INamedGraphObject &	oObject,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	oObjects )

inline

Get all child objects of the given oObject.

Parameters

oObject	the object has childrens
oObjects	all child objects

◆ get_data_binding_objects()

void adtf::streaming::hollow::get_data_binding_objects	(	ant::IDataBinding *	pDataBinding,
		ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &	oObjects )

inline

Get all the data binding objects out of pDataBinding.

Parameters

pDataBinding	The Data binding object to retrieve the binding objects from
oObjects	list of objects returned

◆ get_default_buffer_factory()

tResult adtf::streaming::ant::get_default_buffer_factory ( adtf::ucom::iobject_ptr< ISampleBufferFactory > & pFactory )

Creates and gets the default buffer factory (ISampleBufferFactory) based on new/delete. The ISampleBuffer returned by the ISampleBufferFactory::GetBuffer will use new / delete on each ISampleBufferFactory::Resize call.

Parameters

[out] pFactory The factory returned

Returns: Standard Result Code

Return values

ERR_POINTER	The factory could not be created due memory allocation error.
ERR_INVALID_INTERFACE	The given `pFactory` did not accept the adtf::ucom::iobject_ptr::Reset call.

◆ get_filter_graph_object()

tResult adtf::streaming::get_filter_graph_object	(	const IFilterGraph &	oGraph,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObject )

Retrieve the first item of the filter graph where the iobject_ptr::Reset returns ERR_NO_ERROR If pObject is used with adtf::ucom::object_ptr this method will return the first object of given INTERFACE of adtf::ucom::object_ptr<INTERFACE>. Sub Graphs are considered.

 // ...
 adtf::ucom::object_ptr<adtf::streaming::IFilterGraph> pFilterGraph;
 adtf::services::get_session_filtergraph(pFilterGraph);
 adtf::ucom::object_ptr<IFilter> pFirstFoundFilter;
 get_filter_graph_object(*pFilterGraph, pFirstFoundFilter);
// ...

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	pObject	The object reference to return the value.

Return values

ERR_NOT_FOUND	iobject_ptr::Reset never returned ERR_NOERROR
ERR_NOERRROR	iobject_ptr::Reset returned ERR_NOERROR, consider pObject

See also: adtf::services::ant::get_session_filter_graph to retrieve the current Filter Graph.

◆ get_filter_graph_objects()

tResult adtf::streaming::get_filter_graph_objects	(	const IFilterGraph &	oGraph,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	lstObjects )

Iterates the named graph objects of the filter graph and calls iobject_enum::PushObject to the lstObjects. If lstObjects is used with adtf::ucom::ant::object_list this method will return all object of given INTERFACE of adtf::ucom::ant::object_list<INTERFACE>. Sub Graphs are considered.

// ...
adtf::ucom::object_ptr<adtf::streaming::IFilterGraph> pFilterGraph;
adtf::services::get_session_filtergraph(pFilterGraph);
adtf::ucom::object_list<IFilter> lstOfFilters;
get_filter_graph_objects(*pFilterGraph, lstOfFilters);
// ...

Parameters

[in]	oGraph	Graph to retrieve the objects from.
[in,out]	lstObjects	The object list to push the values to.

Return values

ERR_NOT_FOUND	iobject_enum::Reset never returned ERR_NOERROR
ERR_NOERRROR	iobject_enum::Reset returned ERR_NOERROR, consider pObject

See also: adtf::services::ant::get_session_filter_graph to retrieve the current Filter Graph.

◆ get_graph_objects()

void adtf::streaming::hollow::get_graph_objects	(	ant::IGraph *	pGraph,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	oObjects )

inline

Get all graph objects out of the pGraph.

Parameters

pGraph	the Graph where to get the grpah objects from
oObjects	the list of graph objects to return

◆ get_help_link()

std::string adtf::streaming::spider::get_help_link ( base::ant::IConfiguration & oConfig )

Get the link to the corresponding help/documentation set by hollow::set_help_link

Parameters

[in] oConfig The configuration instance where the help link might be stored

Returns: The help link if set. Emtpy if not found.

◆ get_interface_binding_objects()

void adtf::streaming::hollow::get_interface_binding_objects	(	ant::IInterfaceBinding *	pInterfaceBinding,
		ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &	oObjects )

inline

Get all the interface binding objects out of pInterfaceBinding.

Parameters

pInterfaceBinding	The Interface binding object to retrieve the binding objects from
oObjects	list of objects returned

◆ get_named_graph_object_from_graph()

tResult adtf::streaming::ant::get_named_graph_object_from_graph	(	IGraph &	oGraph,
		const char *	strName,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObjectFound )

Helper function to retrieve a graph object from a graph with fully qualified unique name of an object.

Parameters

[in]	oGraph	The graph instance to get the object from.
[in]	strName	The fully qualified named with dots (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")
[in,out]	pObjectFound	The object to retrieve

Returns: ...

Remarks: Expensive recursive call !!

◆ get_named_graph_object_full_name()

adtf_util::cString adtf::streaming::ant::get_named_graph_object_full_name ( const INamedGraphObject & oGraphObject )

Helper function to retrieve a full qualified unique name of an object registered in IFilterGraph.

Parameters

[in] oGraphObject The object to retrieve the fullname for.

Returns: The full qualified name of the object. (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")

Remarks: Expensive recursive call !!

◆ get_property()

template<typename VALUETYPE>

VALUETYPE adtf::streaming::ant::get_property	(	const IStreamType &	oStreamType,
		const char *	strNameOfValue,
		VALUETYPE	oDefaultValue )

Gets the property of the given oStreamType.

Template Parameters

VALUETYPE Type of value returned and oDefaultValue

Parameters

[in]	oStreamType	StreamType where to get the property
[in]	strNameOfValue	name of the property
[in]	oDefaultValue	default value of property if not found.

Returns: the value of the property

◆ get_reference_buffer_factory()

tResult adtf::streaming::ant::get_reference_buffer_factory ( adtf::ucom::iobject_ptr< ISampleBufferFactory > & pFactory )

Creates and gets the a buffer factory that creates sample buffers that do not copy the data, but only keep a reference to it. Use this with EXTREME care!! Keep samples that use these buffers in a adtf::ucom::ant::weak_object_ptr in order to be able to check if they no longer exist before you manipulate the data again.

Parameters

[out] pFactory The factory returned

Returns: Standard Result Code

Return values

ERR_POINTER	The factory could not be created due memory allocation error.
ERR_INVALID_INTERFACE	The given `pFactory` did not accept the adtf::ucom::iobject_ptr::Reset call.

◆ get_runner_objects()

void adtf::streaming::hollow::get_runner_objects	(	ant::IRuntimeBehaviour *	pRuntimeBehaviour,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	oObjects )

inline

Get all runner objects object out of pRuntimeBehaviour.

Parameters

pRuntimeBehaviour	the runtime behaviour
oObjects	the list of runner objects returned

◆ get_sample_info()

adtf::util::cVariant adtf::streaming::ant::get_sample_info	(	const ISampleInfo &	oSampleInfo,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oDefault )

Retrieves a variant value for the hash key oHash out of the sample information oSampleInfo . If the value does not exists the return value is the given defaultoDefault.

Parameters

[in]	oSampleInfo	The sample information to retrieve the value from.
[in]	oHash	The hash key of the value.
[in]	oDefault	default value if value does not exist.

Returns: retrieved value as variant.

◆ get_sample_substream_id()

uint32_t adtf::streaming::hollow::get_sample_substream_id ( const ant::ISample & oSample )

Parameters

[in] oSample The sample to retrieve the substream id from.

Returns: the substream id of the given sample.

◆ get_sample_time() [1/2]

base::flash::tNanoSeconds adtf::streaming::giant::get_sample_time ( const ant::ISample & oSample )

Returns the sample timestamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the microseconds timestamp if not.

Parameters

oSample The sample.

Returns: The timestamp.

◆ get_sample_time() [2/2]

base::flash::tNanoSeconds adtf::streaming::flash::get_sample_time ( const ucom::ant::iobject_ptr< const ant::ISample > & pSample )

Returns the sample time stamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the microseconds timestamp if not.

Parameters

[in] pSample The sample.

Returns: The timestamp.

◆ get_stream_type_audio_format()

tResult adtf::streaming::lucky::get_stream_type_audio_format	(	tStreamAudioFormat &	sFormat,
		const IStreamType &	oType )

inline

retrievs the audio format from the properties of the stream type if meta type "adtf/audio" is set.

Parameters

sFormat	The Audio format
oType	The Stream Type where to retrieve the properties from

Returns: tResult

Return values

ERR_NOERROR	Everything went fine
ERR_INVALID_TYPE	the given oType is not a instance of stream meta type "adtf/audio"

◆ get_stream_type_image_format()

tResult adtf::streaming::ant::get_stream_type_image_format	(	tStreamImageFormat &	oFormat,
		const IStreamType &	oType )

Helper function to retrieve the oFormat (tStreamImageFormat) out of the of a IStreamType for a stream_meta_type_image.

Parameters

oType	Stream Type where to get the properties from
oFormat	Format to set the properties content to.

Returns: tResult

See also: stream_meta_type_image

◆ get_streaming_graph_object()

tResult adtf::streaming::ant::get_streaming_graph_object	(	const IStreamingGraph &	oGraph,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObject )

Retrieve the first item of the streaming graph where the iobject_ptr::Reset returns ERR_NOERROR If pObject is used with adtf::ucom::object_ptr this method will return the first object of given INTERFACE of adtf::ucom::object_ptr<INTERFACE>. The embedded Filter Graph is not considered.

 // ...
 adtf::ucom::object_ptr<adtf::streaming::IStreamingGraph> pStreamingGraph;
 adtf::services::get_session_streaming_graph(pStreamingGraph);
 adtf::ucom::object_ptr<ISampleStreamingSource> pFirstFoundSource;
 get_streaming_graph_object(*pFilterGraph, pFirstFoundSource);
// ...

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	pObject	The object reference to return the value.

Return values

ERR_NOT_FOUND	iobject_ptr::Reset never returned ERR_NOERROR
ERR_NOERRROR	iobject_ptr::Reset returned ERR_NOERROR, consider pObject

See also: tResult adtf::services::ant::get_session_filtergraph() to retrieve the current Filter Graph.

◆ get_streaming_graph_objects()

tResult adtf::streaming::ant::get_streaming_graph_objects	(	const IStreamingGraph &	oGraph,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	lstObjects )

Retrieve all items of the streaming graph where the iobject_ptr::Reset returns ERR_NOERROR

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	lstObjects	The object list reference to return the values to.

See also: tResult adtf::services::ant::get_session_filtergraph() to retrieve the current Filter Graph.

◆ is_compatible()

tResult adtf::streaming::flash::is_compatible	(	const ant::IStreamType &	oCheckedType,
		const ant::IStreamType &	oExpectedType )

Checks whether oCheckedType is compatible with oExpectedType

Parameters

[in]	oCheckedType	The type that should be checked for compatibility.
[in]	oExpectedType	The type that is expected.

Returns: Standard result.

◆ is_equal()

tResult adtf::streaming::spider::is_equal	(	const ant::IStreamType &	oLeftType,
		const ant::IStreamType &	oRightType )

inline

Check if two stream types are equal.

Parameters

[in]	oLeftType	The operands for the check.
[in]	oRightType	The operands for the check.

Returns: Standard result.

◆ read_from_sample()

template<typename T>

tResult adtf::streaming::ant::read_from_sample	(	const ISample &	oSample,
		T &	oValue )

Helper to read the value oValue from the sample oSample. This will Locks the Sample and copy the memory from the SampleBuffer to the memory of oSample.

Parameters

[in] oSample The Sample to read from.

Template Parameters

T	The Type of `oValue`

Parameters

[in] oValue The value to read.

Remarks: This must be a plain data type (c-style structure or basic type) or at least an standrad layout type.

Returns: Standard Error Code of ISampleBuffer::Read

◆ set_description() [1/2]

void adtf::streaming::giant::set_description	(	base::ant::IConfiguration &	oConfig,
		const char *	strDescription )

Sets description information

See also: adtf::filter::cGraphObject::SetDescription()

Parameters

[in]	oConfig	The configuration instance where the name and url will be stored
[in]	strDescription	The description.

Returns: Standard result.

◆ set_description() [2/2]

void adtf::streaming::hollow::set_description	(	base::ant::IConfiguration &	oConfig,
		const char *	strItem,
		const char *	strDescription )

Set the description for a specified item of the graph object

Parameters

[in]	oConfig	The configuration instance where the description will be stored
[in]	strItem	The item name of the object (i.e. name of Pin, Binding Proxy, Runner)
[in]	strDescription	The description for the item

◆ set_editor()

void adtf::streaming::giant::set_editor	(	base::ant::IConfiguration &	oConfig,
		const char *	strName,
		const char *	strUrl )

Sets graph element editor information

See also: adtf::filter::cGraphObject::SetEditor()

Parameters

[in]	oConfig	The configuration instance where the name and url will be stored
[in]	strName	The name of the editor.
[in]	strUrl	The url to the editor (a qml file).

Returns: Standard result.

◆ set_editors()

void adtf::streaming::giant::set_editors	(	base::ant::IConfiguration &	oConfig,
		const std::vector< std::pair< std::string, std::string > > &	oEditors )

Sets multiple graph element editors

See also: adtf::filter::cGraphObject::SetEditor()

Parameters

[in]	oConfig	The configuration instance where the names and urls will be stored
[in]	oEditors	Pairs of names and urls of the editors.

Returns: Standard result.

◆ set_help_link()

void adtf::streaming::hollow::set_help_link	(	base::ant::IConfiguration &	oConfig,
		const char *	strUrl )

Set the link to the corresponding help/documentation

Parameters

[in]	oConfig	The configuration instance where the help link will be stored
[in]	strUrl	The url to the help document (i.e. an HTML file).

◆ set_property()

template<typename VALUETYPE>

tResult adtf::streaming::ant::set_property	(	IStreamType &	oStreamType,
		const char *	strNameOfValue,
		VALUETYPE	oValue )

Sets the property of the given oStreamType to the value oValue

Template Parameters

VALUETYPE Type of oValue

Parameters

[in]	oStreamType	StreamType where to set the property
[in]	strNameOfValue	name of the property
[in]	oValue	value of property to set.

Returns: Standard Result Code

◆ set_sample_info()

tResult adtf::streaming::ant::set_sample_info	(	ISampleInfo &	oSampleInfo,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oValue )

Sets a variant value for the hash key oHash into the sample information oSampleInfo.

Parameters

[in]	oSampleInfo	The sample information to set the value to.
[in]	oHash	The hash key of the value.
[in]	oValue	value to set.

Returns: standard error code

Return values

ERR_NOERROR	value is set
ERR_INVALID_TYPE	Type is not supported. See base::ant::IHashValueMapValue::tType

◆ set_sample_substream_id()

void adtf::streaming::hollow::set_sample_substream_id	(	ant::ISample &	oSample,
		uint32_t	nSubStreamId )

Sets the substream id of a given sample.

Parameters

[in]	oSample	The sample that should be updated.
[in]	nSubStreamId	The substream id to be set.

◆ set_sample_time()

void adtf::streaming::giant::set_sample_time	(	const ucom::ant::iobject_ptr< ant::ISample > &	pSample,
		base::flash::tNanoSeconds	tmTimeStamp )

Sets the sample timestamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the timestamp to microseconds if not.

Parameters

pSample	The sample.
tmTimeStamp	The timestamp.

◆ set_stream_type_audio_format()

tResult adtf::streaming::lucky::set_stream_type_audio_format	(	IStreamType &	oType,
		const tStreamAudioFormat &	sFormat )

inline

sets the audio format properties within the stream type if meta type "adtf/audio" is set

Parameters

sFormat	The Audio format
oType	The Stream Type where to set the properties to

Returns: tResult

Return values

ERR_NOERROR	Everything went fine
ERR_INVALID_TYPE	the given oType is not a instance of stream meta type "adtf/audio"

◆ set_stream_type_image_format()

tResult adtf::streaming::ant::set_stream_type_image_format	(	IStreamType &	oType,
		const tStreamImageFormat &	oFormat )

Helper function to set the properties of a IStreamType for a stream_meta_type_image.

Parameters

oType	Stream Type where to set the properties representing the content of `sFormat` tStreamImageFormat
oFormat	Format to set the properties from.

Returns: tResult

See also: stream_meta_type_image

◆ stream_image_format_get_generic_mask()

uint32_t adtf::streaming::ant::stream_image_format_get_generic_mask	(	const char *	strChannel,
		const tStreamImageFormat &	strFormat )

Retrieves the pixelsize

Parameters

strChannel	[in] channel to look for.
strFormat	[in] a generic stream image format.

Returns: Returns the pixelsize in bits

◆ stream_image_format_get_generic_pixel_size()

unsigned int adtf::streaming::ant::stream_image_format_get_generic_pixel_size ( const tStreamImageFormat & strFormat )

Retrieves the pixelsize

Parameters

strFormat [in] a generic stream image format.

Returns: Returns the pixelsize in bits

◆ stream_image_format_is_generic()

bool adtf::streaming::ant::stream_image_format_is_generic ( const tStreamImageFormat & strFormat )

Check if all bits are well defined and at least one component is available

Parameters

strFormat [in] a generic stream image format.

Returns: Returns true when one or more component is specified and all bits are assigned

◆ stream_image_format_is_generic_rgb()

bool adtf::streaming::ant::stream_image_format_is_generic_rgb ( const tStreamImageFormat & strFormat )

Check if R, G and B components are available.

Parameters

[in] strFormat a generic stream image format.

Returns: Returns true when R, G and B component including bitsize is specified

◆ trigger()

template<typename WRITER_TYPE>

WRITER_TYPE & adtf::streaming::ant::trigger ( WRITER_TYPE & oWriter )

Global function template to trigger a writers sample stream manually.

Template Parameters

WRITER_TYPE Type or sub class of cSampleWriter

Returns: Returns the triggered streamer

See also: cSampleWriter, sample stream.

◆ write_to_sample()

template<typename T>

tResult adtf::streaming::ant::write_to_sample	(	ISample &	oSample,
		const T &	oValue )

Helper to write the value oValue to the sample oSample. This will WriteLock the Sample and copy the memory to the SampleBuffer of Sample.

Parameters

[in] oSample The Sample to write to. (mind you must set a still a timestamp to the sample, see ISample::SetTime)

Template Parameters

T	The Type of `oValue`

Parameters

[in] oValue The value to write.

Remarks: This must be a plain data type (c-style structure or basic type) or at least an standrad layout type.

Returns: Standard Error Code of ISampleBuffer::Write

Namespaces

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ cDynamicSampleReader

◆ cSingleSampleReader

◆ size_limited_sample_reader

◆ time_limited_sample_reader

Function Documentation

◆ add_binding_proxy()

◆ add_data_in_port()

◆ add_data_out_port()

◆ add_graph_object()

◆ add_paired_connections()

◆ add_piped_connections()

◆ add_sample_stream_in_port()

◆ add_sample_stream_out_port()

◆ alloc_sample()

◆ check_loop_call_in_trigger_pipe()

◆ create_adtf_audio_stream_type()

◆ create_adtf_image_stream_type()

◆ create_client()

◆ create_inner_pipe()

◆ create_runner()

◆ create_sample_info_hash_key()

◆ create_server()

◆ create_trigger_pipe()

◆ create_weak_binding_server()

◆ flush()

◆ get_child_objects()

◆ get_data_binding_objects()

◆ get_default_buffer_factory()

◆ get_filter_graph_object()

◆ get_filter_graph_objects()

◆ get_graph_objects()

◆ get_help_link()

◆ get_interface_binding_objects()

◆ get_named_graph_object_from_graph()

◆ get_named_graph_object_full_name()

◆ get_property()

◆ get_reference_buffer_factory()

◆ get_runner_objects()

◆ get_sample_info()

◆ get_sample_substream_id()

◆ get_sample_time() [1/2]

◆ get_sample_time() [2/2]

◆ get_stream_type_audio_format()

◆ get_stream_type_image_format()

◆ get_streaming_graph_object()

◆ get_streaming_graph_objects()

◆ is_compatible()

◆ is_equal()

◆ read_from_sample()

◆ set_description() [1/2]

◆ set_description() [2/2]

◆ set_editor()

◆ set_editors()

◆ set_help_link()

◆ set_property()

◆ set_sample_info()

◆ set_sample_substream_id()

◆ set_sample_time()

◆ set_stream_type_audio_format()

◆ set_stream_type_image_format()

◆ stream_image_format_get_generic_mask()

◆ stream_image_format_get_generic_pixel_size()

◆ stream_image_format_is_generic()

◆ stream_image_format_is_generic_rgb()

◆ trigger()

◆ write_to_sample()