IStreamingService

Basic sec_streaming_service interface to set the state of an IStreamingService. More...

Inheritance diagram for IStreamingService:

Public Types
enum	tStreamingState : uint8_t { State_Shutdown = 0 , State_Constructed = 1 , State_Initialized = 2 , State_Streaming = 3 }
	States of the Streaming Services. More...

Public Member Functions
	ADTF_IID (IStreamingService, "streaming_service.ant.streaming.adtf.iid")
	definiton of interface id
virtual tResult	SetState (tStreamingState eState)=0
	Sets the state of the Streaming Service. More...
virtual tStreamingState	GetState ()=0
	Gets the current state of the Streaming Service. More...
Public Member Functions inherited from INamedGraphObject
	ADTF_IID (INamedGraphObject, "namedgraphobject.ant.streaming.adtf.iid")
	defintion of interface id
virtual tResult	GetName (base::ant::IString &&strName) const =0
	Gets the Name of the object to the IString rvalue reference strName. More...
virtual tResult	SetName (const char *strName)=0
	Sets the Name of the object. More...
virtual tResult	SetParent (const ucom::ant::IObject *oParentObject)=0
	Sets the Parent of the object. More...
virtual tResult	GetParent (const ucom::ant::IObject *&poParentObject) const =0
	Retrieves the Parent of the object. 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
	~IStreamingService ()=default
	protect DTOR
Protected Member Functions inherited from INamedGraphObject
	~INamedGraphObject ()=default
	not destructable
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

Basic sec_streaming_service interface to set the state of an IStreamingService.

See also

Streaming Service.

Definition at line 23 of file streaming_source_intf.h.

Member Enumeration Documentation

tStreamingState

enum tStreamingState : uint8_t

States of the Streaming Services.

See also

Streaming Service State Machine (within Filter Graph)

Enumerator
State_Shutdown	first entry state.
State_Constructed	All properties are set all pins can be created after this state the pins will be requested and connected.
State_Initialized	All Pins are requested and connected.
State_Streaming	Streaming Data begins, threads and timers should only start here!

Definition at line 35 of file streaming_source_intf.h.

Member Function Documentation

GetState()

virtual tStreamingState GetState ( )

pure virtual

Gets the current state of the Streaming Service.

See also

section_streaming_graph_state

Returns

The current reached state. (only returns the right state if transition is completed).

SetState()

virtual tResult SetState ( tStreamingState  eState )

pure virtual

Sets the state of the Streaming Service.

See also

section_streaming_graph_state

Parameters

eState

[in] State to set

Returns

Standard Result Code depends on the implementation of the Streaming Service

Remarks

Usually NOT thread-safe, should not be called from more than one thread!