adtf::services::ant Namespace Reference

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

Classes
class	cPlayerStreams
class	IApplication
class	IKernel
class	ILogging
class	IMacroResolver
class	IMemoryAllocator
class	IPlayer
	ADTF Playback Service Control interface to control the ADTF Player. More...
class	IRecorder
	Recorder Service Control interface to control the Recorder. More...
class	IRecordingFile
class	IRecordingSignal
class	IReferenceClock
	The IReferenceClock interface provides the reference time source for the filter graph. More...
class	IRPCObjectServerRegistry
class	ISession
class	ISessionManager
	Session Manager interface defines System Core Object. More...

Functions
adtf::util::cString	adtf_resolve_macros (const char *strString)
void	adtf_register_macro (const char *strMacro, const char *strMacroString)
tResult	get_player (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 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]	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.

get_player()

tResult adtf::services::ant::get_player ( 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