#include <adtf_runtime_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Types
enum class	tADTFMicroRunLevel : int8_t { MRL_Shutdown = ucom::ant::IRuntime::RL_Shutdown , MRL_System = 10 , MRL_Session = 20 , MRL_StreamingGraph = 30 , MRL_FilterGraphConstructed = 33 , MRL_FilterGraphInitialized = 36 , MRL_FilterGraphReady = 40 , MRL_FilterGraph = MRL_FilterGraphReady , MRL_Running = 50 , MRL_Max = MRL_Running , MRL_Internal = ucom::ant::IRuntime::RL_Internal }

enum	tRuntimeHookId : uint32_t { RHI_MicroRunLevelPreIncrement = adtf::ucom::ant::IRuntime::tRuntimeHookId::RHI_RunLevelPreIncrement + 100 , RHI_MicroRunLevelPostIncrement , RHI_MicroRunLevelPreDecrement , RHI_MicroRunLevelPostDecrement , RHI_MicroRunLevelIncrementing , RHI_MicroRunLevelDecrementing }

enum	tServiceEvent : uint32_t { SE_ChangeMicroRunLevel = adtf::ucom::ant::IService::tServiceEvent::SE_ChangeRunLevel + 100 }

Public Member Functions
	ADTF_IID (IADTFRuntime, "adtf_runtime.quiet.base.adtf.iid")

virtual tResult	SetMicroRunLevel (tADTFMicroRunLevel nRunlevelToChangeTo, bool bWait=true)=0

virtual tADTFMicroRunLevel	GetMicroRunLevel () const=0

Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Additional Inherited Members
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Interface for accessing additional funcionality within the ADTF runtime.

Member Enumeration Documentation

◆ tADTFMicroRunLevel

enum class adtf::base::quiet::IADTFRuntime::tADTFMicroRunLevel : int8_t

strong

Micro Runlevels offer more fine grained control to initialization etc.

Enumerator
MRL_Shutdown	The system is shut down.
MRL_System	The system level.
MRL_Session	The session level.
MRL_StreamingGraph	The Streaminggraph level.
MRL_FilterGraphConstructed	All graph objects are constructed.
MRL_FilterGraphInitialized	All graph objects are initialized and ready to be connected.
MRL_FilterGraphReady	All graph objects are connected and ready to be started.
MRL_FilterGraph	The Filtergraph level.
MRL_Running	The Running level.
MRL_Max	maximum level that can be reached

◆ tRuntimeHookId

enum adtf::base::quiet::IADTFRuntime::tRuntimeHookId : uint32_t

Additional hooks for micro runlevel changes.

Enumerator
RHI_MicroRunLevelPreIncrement	Called before the run level is incremented. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel.
RHI_MicroRunLevelPostIncrement	Called after the run level was incremented. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel.
RHI_MicroRunLevelPreDecrement	Called before the run level is decremented. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel.
RHI_MicroRunLevelPostDecrement	Called after the run level was decremented. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel.
RHI_MicroRunLevelIncrementing	Called before the run level is incrementing. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel reaching.
RHI_MicroRunLevelDecrementing	Called while the run level is decrementing. IRuntimeHook::tHookInfo::ui32Param1 contains the runlevel leaving.

◆ tServiceEvent

enum adtf::base::quiet::IADTFRuntime::tServiceEvent : uint32_t

Additional events for micro runlevel changes.

Member Function Documentation

◆ ADTF_IID()

adtf::base::quiet::IADTFRuntime::ADTF_IID	(	IADTFRuntime	,
		"adtf_runtime.quiet.base.adtf.iid"	)

Marks the IRuntime to be castable with the ucom_cast<>

See also: ADTF_IID(_interface, _striid)

◆ GetMicroRunLevel()

virtual tADTFMicroRunLevel adtf::base::quiet::IADTFRuntime::GetMicroRunLevel ( ) const

pure virtual

Returns: The current micro runlevel.

◆ SetMicroRunLevel()

virtual tResult adtf::base::quiet::IADTFRuntime::SetMicroRunLevel	(	tADTFMicroRunLevel	nRunlevelToChangeTo,
		bool	bWait = true )

pure virtual

Request a change to the given micro runlevel

Parameters

[in]	nRunlevelToChangeTo	The runlevel that should be changed to.
[in]	bWait	Whether or not to block until the requested runlevel has been reached.

Returns: Standard result.

The documentation for this class was generated from the following file:

src/libraries/base/include/adtfbase/adtf_runtime_intf.h

Public Types

Public Member Functions

Additional Inherited Members