|
ADTF
|
#include <filtergraph.h>
Public Member Functions | |
| cFilterGraph () | |
| CTOR. | |
| ~cFilterGraph () override | |
| DTOR. | |
| tResult | SetState (tFilterGraphState eFilterState) override |
| tFilterGraphState | GetState () const override |
| tResult | AddConnection (const char *strName, const char *strSourceName, const char *strSourceConnector, const char *strDestinationName, const char *strDestinationConnector, int32_t ui32OrderNumber, bool bSync) |
| tResult | AddNamedGraphObject (const ucom::ant::iobject_ptr< INamedGraphObject > &pItem, int32_t ui32OrderNumber) override |
| tResult | RemoveNamedGraphObject (const ucom::ant::iobject_ptr< INamedGraphObject > &pItem) override |
| tResult | SetParent (const ucom::ant::IObject *oParentObject) override |
| void | SetConnectionCreationState (IFilterGraph::tFilterGraphState eState) |
| void | SetLegacyConnectionOrder (bool bLegacyOrder) |
| void | SetLegacyShutdownOrder (bool bLegacyOrder) |
| void | SetConcurrentInitialization (bool bEnabled) noexcept |
| void | SetPostConnectionCallback (std::function< tResult()> fnCallback) |
| tResult | GetProperties (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const override |
| Retrieves readable properties object of a Filter Graph. | |
| tResult | GetProperties (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties) override |
| Retrieves writeable properties object of a Filter Graph. | |
| tResult | AttachConfiguration (const char *strName, base::ant::IConfiguration &oAttachedConfiguration) override |
| Attaches a configuration to the Filter Graph under a specified name. | |
| tResult | DetachConfiguration (const char *strName) override |
| Detaches a configuration attached with AttachConfiguration. | |
| tResult | AddPropertyLink (const char *strSourcePropertyName, const char *strTargetObject, const char *strTargetProperty) |
| void | DisableObjectInitializationUponAdd () |
| tResult | RegisterScopedMacroResolver (const ucom::ant::iobject_ptr< services::ant::IMacroResolver > &pScopedMacroResolver) noexcept |
| tResult | GetScopedMacroResolver (ucom::ant::iobject_ptr< services::ant::IMacroResolver > &pScopedMacroResolver) const noexcept override |
| tResult | RemoveNamedGraphObject (const char *strName) |
Public Member Functions inherited from adtf::ucom::catwo::object< IFilter, ant::IFilterGraph, graph< runtime_behaviour< interface_binding< ant::data_binding< named_graph_object< zebra::IFilterGraph > > > > >, base::ant::IConfiguration > | |
| tResult | GetInterface (const char *i_strIID, void *&o_pInterface) override |
| Query interfaces on an object. | |
| tResult | GetInterface (const char *i_strIID, const void *&o_pInterface) const override |
| Provides const correct interface querying. | |
| void | Destroy () const override |
| Switch from non-virtual destructor to virtual destructor. | |
| tResult | GetInterface (const char *i_strIID, void *&o_pInterface) override |
| Query interfaces on an object. | |
| tResult | GetInterface (const char *i_strIID, const void *&o_pInterface) const override |
| Provides const correct interface querying. | |
| void | Destroy () const override |
| Switch from non-virtual destructor to virtual destructor. | |
| tResult | GetInterface (const char *i_strIID, void *&o_pInterface) override |
| Query interfaces on an object. | |
| tResult | GetInterface (const char *i_strIID, const void *&o_pInterface) const override |
| Provides const correct interface querying. | |
| void | Destroy () const override |
| Switch from non-virtual destructor to virtual destructor. | |
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! | |
Default implementation for the IFilterGraph interface.
| tResult adtf::streaming::cFilterGraph::AddConnection | ( | const char * | strName, |
| const char * | strSourceName, | ||
| const char * | strSourceConnector, | ||
| const char * | strDestinationName, | ||
| const char * | strDestinationConnector, | ||
| int32_t | ui32OrderNumber, | ||
| bool | bSync ) |
Adds a conection to the filter graph. See filter graph_connections for possible connstions.
| [in] | strName | Name of the connection. Mind, that the connections are part of teh Filter Graph as named graph objects, too. |
| [in] | strSourceName | Name of the source (filter, port, ...) |
| [in] | strSourceConnector | Name of the source connector (pin, binding object, ...) |
| [in] | strDestinationName | Name of the destination (filter, port, ...) |
| [in] | strDestinationConnector | Name of the destination connector (pin, binding object, ...) |
| [in] | ui32OrderNumber | Order number of connection for establishing the connection. |
| [in] | bSync | Either the connection is synchronous or not. |
|
override |
This is to intialize and build an FilterGraph. See the INamedGraphObject and all derived default implementations within the SDK.
Items with the same ui32OrderNumber will initialized in order of AddNamedGraphObject call.
| [in] | pItem | The item to add. |
| [in] | ui32OrderNumber | The initialize order number of the item. |
| ERR_INVALID_ARG | No name set for graph object. |
| ERR_RESOURCE_IN_USE | There is already a graph object with the name. |
| tResult adtf::streaming::cFilterGraph::AddPropertyLink | ( | const char * | strSourcePropertyName, |
| const char * | strTargetObject, | ||
| const char * | strTargetProperty ) |
Adds a link between a graph property and a property of a graph component.
| [in] | strSourcePropertyName | The name of the graph property. |
| [in] | strTargetObject | The name of the target object. |
| [in] | strTargetProperty | The name of the target property. |
|
override |
Attaches a configuration to the Filter Graph under a specified name.
| strName | name of the configiration to attach |
| oAttachedConfiguration | the configiration to attach |
|
override |
Detaches a configuration attached with AttachConfiguration.
| strName | name of the configiration to deattach |
| void adtf::streaming::cFilterGraph::DisableObjectInitializationUponAdd | ( | ) |
Disables modification of the state when adding objects. Use SetState() later on.
|
override |
Retrieves writeable properties object of a Filter Graph.
| pProperties | the properties object of the Filter Graph |
|
override |
Retrieves readable properties object of a Filter Graph.
| pProperties | the properties object of the Filter Graph |
|
override |
Returns the current state of the filtergraph.
| tResult adtf::streaming::ant::cGraph::RemoveNamedGraphObject | ( | const char * | strName | ) |
Removes a named Object from the Filter Graph
| [in] | strName | Name of the item to remove. |
| ERR_NOT_FOUND | No item with the name strName exists |
|
noexcept |
Set whether objects without main thread affinity change their states concurrently.
This is enabled by default, see set_main_thread_affinity(). When disabled, all objects change their states on the calling thread in the order of their order numbers. This is a recovery path for components that turn out not to cope with concurrent initialization, e.g. a service whose interfaces are not thread safe.
ADTF_DISABLE_CONCURRENT_INITIALIZATION environment variable to a non-empty value. | [in] | bEnabled | If false, all objects change their states on the calling thread. |
| void adtf::streaming::cFilterGraph::SetConnectionCreationState | ( | IFilterGraph::tFilterGraphState | eState | ) |
Set the state before which the connections should be established.
The default is IFilterGraph::tFilterGraphState::State_Ready.
ADTF_CONNECTION_CREATION_STATE environment variable to the desired value (i.e. 2). | eState | The filter graph state before which the connections should be established. |
| void adtf::streaming::cFilterGraph::SetLegacyConnectionOrder | ( | bool | bLegacyOrder | ) |
Set whether or not the old legacy connection establishment order should be used.
ADTF_LEGACY_CONNECTION_ESTABLISHMENT_ORDER environment variable to a non-empty value. | [in] | bLegacyOrder | If true the old order will be used. |
| void adtf::streaming::cFilterGraph::SetLegacyShutdownOrder | ( | bool | bLegacyOrder | ) |
Switch between 'old' legacy and 'new' shutdown order of all graph objects.
In both modes, objects without main thread affinity leave the states before the connection creation state concurrently, before all others, see set_main_thread_affinity() and SetConcurrentInitialization(). All other stages and the removal of the objects keep the selected order.
ADTF_LEGACY_SHUTDOWN_ORDER environment variable to a non-empty value. | [in] | bLegacyOrder | If true the old legacy shutdown order will be used. |
| void adtf::streaming::cFilterGraph::SetPostConnectionCallback | ( | std::function< tResult()> | fnCallback | ) |
Adds a callback that is called after all connections have been established and before the graph objects are set to state post connect.
| [in] | fnCallback | The callback that should be executed. |
|
override |
The FilterGraph state is treaded as a level machine. Only a root graph changes states, and it changes those of all objects in its subgraphs as well.
| ERR_INVALID_STATE | The graph is a subgraph, which follows the state of its root graph. |