ADTF: IStreamingRequests

Interface for handling streaming requests. More...

Inheritance diagram for IStreamingRequests:

Public Member Functions
	ADTF_IID (IStreamingRequests, "streaming_requests.hollow.streaming.adtf.iid")
	definition of interface id

virtual tResult	RequestSamples (ucom::ant::iobject_ptr< IStreamingRequest > &pRequest, uint32_t nSubStreamId, const base::ant::IProperties *pRequestProperties=nullptr)=0
	RequestSamples of the given Substream to be generated and/or transmitted. More...

virtual void	RegisterStreamTypeHandler (IStreamTypeHandler &oHandler)=0
	Registers a new stream type handler. More...

virtual void	UnregisterStreamTypeHandler (IStreamTypeHandler &oHandler)=0
	Unregisters a stream type handler. More...

Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the `IObject` to be castable with the `ucom_cast()` More...

Protected Member Functions
	~IStreamingRequests ()=default
	not destructable

Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

Interface for handling streaming requests.

Definition at line 57 of file streamingrequests_intf.h.

virtual void RegisterStreamTypeHandler ( IStreamTypeHandler & oHandler )

pure virtual

Registers a new stream type handler.

This will call the IStreamTypeHandler::HandleNewStreamType() method with the current type once and for any later update.

Parameters

[in] oHandler The new handler.

virtual tResult RequestSamples	(	ucom::ant::iobject_ptr< IStreamingRequest > &	pRequest,
		uint32_t	nSubStreamId,
		const base::ant::IProperties *	pRequestProperties = `nullptr`
	)

pure virtual

RequestSamples of the given Substream to be generated and/or transmitted.

Parameters

[out]	pRequest	Keep this as long as you request samples to be transmitted.
[in]	nSubStreamId	The id of the Substream.
[in]	pRequestProperties	The request properties. If nullptr, then defaults will be used.

virtual void UnregisterStreamTypeHandler ( IStreamTypeHandler & oHandler )

pure virtual

Unregisters a stream type handler.

Parameters

[in] oHandler The new handler.