ADTF  3.13.0
IStreamingRequestsabstract

Interface for handling streaming requests. More...

Inheritance diagram for IStreamingRequests:
[legend]

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, tUInt32 nSubStreamId, const base::ant::IProperties *pRequestProperties=nullptr)=0
 RequestSamples of the given Substream to be generated and/or transmitted. More...
 
virtual tVoid RegisterStreamTypeHandler (IStreamTypeHandler &oHandler)=0
 Registers a new stream type handler. More...
 
virtual tVoid 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.

Member Function Documentation

◆ RegisterStreamTypeHandler()

virtual tVoid 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]oHandlerThe new handler.

◆ RequestSamples()

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

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

Parameters
[out]pRequestKeep this as long as you request samples to be transmitted.
[in]nSubStreamIdThe id of the Substream.
[in]pRequestPropertiesThe request properties. If nullptr, then defaults will be used.
Returns
Standard Result.

◆ UnregisterStreamTypeHandler()

virtual tVoid UnregisterStreamTypeHandler ( IStreamTypeHandler oHandler)
pure virtual

Unregisters a stream type handler.

Parameters
[in]oHandlerThe new handler.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Sep 28 2021 by doxygen 1.8.14)