Namespace for a summary of all service interfaces provided by ADTF. More...

Namespaces
namespace	ant
	Namespace for all service interfaces provided since v3.0.

namespace	bat
	Namespace for all service interfaces provided since v3.1.

namespace	catwo
	Namespace for all service interfaces provided since v3.2.

namespace	devil
	Namespace for all service interfaces provided since v3.3.

namespace	elasto
	Namespace for all service interfaces provided since v3.4.

namespace	flash
	Namespace for all service interfaces provided since v3.5.

namespace	giant
	Namespace for all service interfaces provided since v3.6.

namespace	joker
	Namespace for all service interfaces provided since v3.9.

namespace	lucky
	Namespace for all service interfaces provided since v3.11.

namespace	osborn
	Namespace for all service interfaces provided since v3.14.

namespace	penguin
	Namespace for all service interfaces provided since v3.15.

namespace	quiet
	Namespace for all service interfaces provided since v3.16.

namespace	riddler
	Namespace for all service interfaces provided since v3.17.

namespace	testing
	Namespace for all service testing functionality.

namespace	thor
	Namespace for all service interfaces provided since v3.19.

namespace	vision
	Namespace for all service interfaces provided since v3.21.

namespace	wolverine
	Namespace for all service interfaces provided since v3.22.

namespace	x
	Namespace for all service interfaces provided since v3.23.

namespace	yak
	Namespace for all service interfaces provided since v3.24.

namespace	zebra
	Namespace for all service interfaces provided since v3.25.

Classes
class	cPlayerStreams

class	IADTFFileSupport

class	IApplication

class	IKernel

class	IMacroResolver

class	IMemoryAllocator

class	IPlayer
	ADTF Playback Service Control interface to control the ADTF Player. More...

class	IRecorder

class	IRecordingFile

class	IRecordingSignal

class	IReferenceClock
	brings latest IReferenceClock to users scope More...

class	IRPCObjectServerRegistry

class	ISampleStreamTracer

class	ISession
	brings the latest versions to users space More...

class	ISessionManager
	Session Manager interface defines System Core Object. More...

class	job_runnable

Typedefs
using	ILogging = ant::ILogging

Functions
template<typename CALLABLE>
	job_runnable (CALLABLE &&) -> job_runnable< CALLABLE && >

template<typename CALLABLE, std::enable_if_t< std::is_invocable_r< tResult, CALLABLE >::value, bool > = true>
tResult	enqueue_job (CALLABLE &&fnJobFunction, bool bWait=false) noexcept

adtf::util::cString	adtf_resolve_macros (const char *strString)

void	adtf_register_macro (const char strMacro, const char strMacroString)

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

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

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

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

tResult	create_empty_session ()

Detailed Description

Namespace for a summary of all service interfaces provided by ADTF.

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.

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]	strMacro	MacroName (NULL-terminated!)
[in]	strMacroString	Macro string to reset if macro is used (NULL-terminated!)

◆ 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] strString The string with macros to resolve (NULL-terminated!)

Returns: instance of the resolved string.

◆ create_empty_session()

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

Creates an empty session.

Returns: standard result code

Return values

ERR_INVALID_STATE This function can only be calles while runlevel is adtf::base::tADTFRunLevel::RL_Shutdown.

◆ enqueue_job()

template<typename CALLABLE, std::enable_if_t< std::is_invocable_r< tResult, CALLABLE >::value, bool > = true>

tResult adtf::services::enqueue_job	(	CALLABLE &&	fnJobFunction,
		bool	bWait = false )

inlinenoexcept

Enqueues the given function in the active applications event loop.

Parameters

[in]	fnJobFunction	The function the execute from within the event loop
[in]	bWait	Whether or not to block until the function has been executed.

Returns: ERR_CANCELLED in case that the event loop is shutting down before the function has been executed. The result of the function when called with bWait = true

◆ get_player()

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

inline

Gets the current registered player instance.

Return values

ERR_NOERROR	Succeeded.
ERR_NOTFOUND	No object found with IPlayer interface. Make sure the Playback Service is registered.

◆ get_session()

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

Retrieves the current ISession from ISessionManager.

Parameters

[in,out] pCurrentSession return value of the current session.

Returns: standard result code

Return values

ERR_NOT_FOUND	No session manager found.
ERR_NOT_INITIALIZED	No Session initialized.

◆ 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] pCurrentFilterGraph return value of the current Filter Graph.

Returns: standard result code

Return values

ERR_NOT_FOUND	No session manager found.
ERR_NOT_INITIALIZED	No 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] pCurrentStreamingGraph return value of the current Streaming Graph.

Returns: standard result code

Return values

ERR_NOT_FOUND	No session manager found.
ERR_NOT_INITIALIZED	No Session initialized, No Streaming Graph initialized.

See also: get_session

◆ job_runnable()

template<typename CALLABLE>

adtf::services::job_runnable ( CALLABLE && ) -> job_runnable< CALLABLE && >

Helper deduction guide for job_runnable to deduce the type of the given callable and forward it to the template parameter.

Namespaces

Classes

Typedefs

Functions

Detailed Description

Function Documentation

◆ adtf_register_macro()

◆ adtf_resolve_macros()

◆ create_empty_session()

◆ enqueue_job()

◆ get_player()

◆ get_session()

◆ get_session_filter_graph()

◆ get_session_streaming_graph()

◆ job_runnable()