ADTF  3.14.2
adtf::services::ant Namespace Reference

Namespace for all service interfaces provided since v3.0. More...

Classes

class  IApplication
 The IApplication interface wraps a generic processing loop. More...
 
class  ILogging
 Interface for the ADTF Logging Service. More...
 
class  IMacroResolver
 The IMacroResolver interface provides methods for resolving macros in strings. More...
 
class  IPlayer
 ADTF Playback Service Control interface to control the ADTF Player. More...
 
class  cPlayerStreams
 Helper class that stores all streams from a player. More...
 
class  IRecorder
 ADTFDAT File Recorder Service Control interface to control the ADTFDAT File Recorder. More...
 
class  IRecordingFile
 Interface for manipulating recording files. More...
 
class  IRecordingSignal
 
class  ISignalListening
 Interface for listening to signals that are available via the signal regsitry. More...
 
class  ISignalRegistry
 Interface for asynchronous signal transmission. More...
 
class  IReferenceClock
 The IReferenceClock interface provides the reference time source for the filter graph. More...
 
class  IMediaDescriptionService
 Interface for the ADTF media description service. More...
 
class  IRPCObjectServerRegistry
 The Object Server Registry is a single instance to create a single adress entry for RPC Server Objects. More...
 
class  IKernel
 Kernel interface for thread, timer and signal handling. More...
 
class  IMemoryAllocator
 Interface for allocation and releasing of memory. More...
 
class  ISession
 Main interface for a Session. More...
 
class  ISessionManager
 Session Manager interface defines a System Core Object. More...
 

Functions

adtf::util::cString adtf_resolve_macros (const char *strString)
 Resolves the macro within a string and returns the result. More...
 
void adtf_register_macro (const char *strMacro, const char *strMacroString)
 Registers a macro within the IMacroResolver. More...
 
tResult get_player (ucom::object_ptr< IPlayer > &pPlayer)
 Gets the current registered player instance. More...
 
template<typename RecorderInterface = IRecorder>
tResult get_recorders (adtf::ucom::object_list< RecorderInterface > &lstRecorders)
 Gets the all registered recorder instances. More...
 
template<typename RecorderInterface = IRecorder>
tResult get_recorder (adtf::ucom::ant::object_ptr< RecorderInterface > &pRecorder)
 Gets the current registered recorder instance. More...
 
tResult get_session (ucom::ant::iobject_ptr< ISession > &pCurrentSession)
 Retrieves the current ISession from ISessionManager. More...
 
tResult get_session_filter_graph (ucom::ant::iobject_ptr< adtf::streaming::IFilterGraph > &pCurrentFilterGraph)
 Retrieves the current adtf::streaming::ant::IFilterGraph from ISessionManager. More...
 
tResult get_session_streaming_graph (ucom::ant::iobject_ptr< adtf::streaming::IStreamingGraph > &pCurrentStreamingGraph)
 Retrieves the current adtf::streaming::ant::IStreamingGraph from ISessionManager. More...
 
tResult create_empty_session ()
 Creates an empty session. More...
 

Detailed Description

Namespace for all service interfaces provided since v3.0.

Function Documentation

◆ adtf_register_macro()

void adtf::services::ant::adtf_register_macro ( const char *  strMacro,
const char *  strMacroString 
)
inline

Registers a macro within the IMacroResolver.

It will try to register a macro using the single IMacroResolver registered within runtime. If IMacroResolver is not present the adtf_util::cSystem::SetEnvVariable is used.

Parameters
[in]strMacroMacroName (NULL-terminated!)
[in]strMacroStringMacro string to reset if macro is used (NULL-terminated!)

Definition at line 174 of file macroresolver_intf.h.

References _runtime, and IRuntime::GetObject().

◆ adtf_resolve_macros()

adtf::util::cString adtf::services::ant::adtf_resolve_macros ( const char *  strString)
inline

Resolves the macro within a string and returns the result.

It will try to resolve a macro by using the single IMacroResolver registered within runtime. If IMacroResolver is not present the adtf_util::cMacroResolver is used.

Parameters
[in]strStringThe string with macros to resolve (NULL-terminated!)
Returns
instance of the resolved string.

Definition at line 144 of file macroresolver_intf.h.

References _runtime, adtf_string_intf, and IRuntime::GetObject().

◆ create_empty_session()

tResult adtf::services::ant::create_empty_session ( )

Creates an empty session.

Returns
standard result code
Return values
ERR_INVALID_STATEThis function can only be calles while runlevel is adtf::base::tADTFRunLevel::RL_Shutdown.

◆ get_player()

tResult adtf::services::ant::get_player ( ucom::object_ptr< IPlayer > &  pPlayer)
inline

Gets the current registered player instance.

Return values
ERR_NOERRORSucceeded.
ERR_NOTFOUNDNo object found with IPlayer interface. Make sure the Playback Service is registered.

Definition at line 228 of file player_intf.h.

References _runtime, and IRuntime::GetObject().

◆ get_recorder()

tResult adtf::services::ant::get_recorder ( adtf::ucom::ant::object_ptr< RecorderInterface > &  pRecorder)
inline

Gets the current registered recorder instance.

Remarks
This function needs the ADTF System SDK to included before.
Return values
ERR_NOERRORSucceeded.
ERR_NOTFOUNDNo object found with IRecorder interface. Make sure the ADTFDAT File Recorder is registered.

Definition at line 166 of file recorder_intf.h.

References get_recorders(), object_ptr< T >::Reset(), and RETURN_IF_FAILED.

◆ get_recorders()

tResult adtf::services::ant::get_recorders ( adtf::ucom::object_list< RecorderInterface > &  lstRecorders)
inline

Gets the all registered recorder instances.

Remarks
This function needs the ADTF System SDK to included before.
Return values
ERR_NOERRORSucceeded.
ERR_NOTFOUNDNo object found with IRecorder interface. Make sure the ADTFDAT File Recorder is registered.

Definition at line 132 of file recorder_intf.h.

References adtf::streaming::ant::get_filter_graph_objects(), get_session(), adtf::streaming::ant::get_streaming_graph_objects(), and RETURN_IF_FAILED.

Referenced by get_recorder().

◆ get_session()

tResult adtf::services::ant::get_session ( ucom::ant::iobject_ptr< ISession > &  pCurrentSession)

Retrieves the current ISession from ISessionManager.

Parameters
[in,out]pCurrentSessionreturn value of the current session.
Returns
standard result code
Return values
ERR_NOT_FOUNDNo session manager found.
ERR_NOT_INITIALIZEDNo Session initialized.

Referenced by get_recorders().

◆ get_session_filter_graph()

tResult adtf::services::ant::get_session_filter_graph ( ucom::ant::iobject_ptr< adtf::streaming::IFilterGraph > &  pCurrentFilterGraph)

Retrieves the current adtf::streaming::ant::IFilterGraph from ISessionManager.

Parameters
[in,out]pCurrentFilterGraphreturn value of the current Filter Graph.
Returns
standard result code
Return values
ERR_NOT_FOUNDNo session manager found.
ERR_NOT_INITIALIZEDNo Session initialized, No Filter Graph initialized.
See also
get_session

◆ get_session_streaming_graph()

tResult adtf::services::ant::get_session_streaming_graph ( ucom::ant::iobject_ptr< adtf::streaming::IStreamingGraph > &  pCurrentStreamingGraph)

Retrieves the current adtf::streaming::ant::IStreamingGraph from ISessionManager.

Parameters
[in,out]pCurrentStreamingGraphreturn value of the current Streaming Graph.
Returns
standard result code
Return values
ERR_NOT_FOUNDNo session manager found.
ERR_NOT_INITIALIZEDNo Session initialized, No Streaming Graph initialized.
See also
get_session

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue May 10 2022 by doxygen 1.9.1)