ADTF Config Tool

Since ADTF version 3.3.0 there is a config tool available (bin\adtf_config_tool.exe). The ADTF Config Tool allows the user to manipulate ADTF Graph and ADTF Properties files. It can be used in scripting environments to perform basic tasks like activating/deactivating ADTF Graph items and/or change property values. You can compare it to light console version of ADTF Configuration Editor with the focus for scripting. Please take a look at the tools -help output for documentation of the available commands:

                
adtf_config_tool

Usage:
        adtf_config_tool -h
        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e objects [--plugin-description]

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e systemobjects [--plugin-description]

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e plugindescription <graphobject>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e isactive <graphobject>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e activate <graphobject>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e deactivate <graphobject>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e listprops <graphobject>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e listpropvalues <graphobject>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e setprop <graphobject> <propertyname>
                         <value>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e getprop <graphobject> <propertyname>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e addcomponent <graph> <componenttype>
                         <classid> <label>

        adtf_config_tool [--dry-run] [--environment <adtfenvironmentfile>] [--session
                         <adtfsessionfile>] [--graph <adtfgraphfile>] [--properties
                         <adtfgraphpropertiesfile>] [--system <adtfsystemfile>] [--system-properties
                         <adtfsystempropertiesfile>] [--cesettings <adtfcesettingsfile>]
                         [--validate-plugindescription] -e connect <component> <component>
                         [--output-pin <pin>] ([--input-pin <pin>] | [--runner-pin <pin>])

Options:
        -h, --help  Print the usage info and quit.
        --dry-run   Do not save changes to the files.
        --environment <adtfenvironmentfile>
                    Specify an ADTF environment file that should be loaded. This overrides whatever
                    is specified in the settings file.

        --session <adtfsessionfile>
                    Loads the given session file and its referenced system, graph and properties
                    files.

        --graph <adtfgraphfile>
                    Loads the given graph file.

        --properties <adtfgraphpropertiesfile>
                    Loads the given properties file.

        --system <adtfsystemfile>
                    Loads the given system file.

        --system-properties <adtfsystempropertiesfile>
                    Loads the given system properties file.

        --cesettings <adtfcesettingsfile>
                    Loads the given cesettings file.

        --validate-plugindescription
                    Deactivate the plugindescription validation

        -e, --execute
                    Execute command and quit

        Available commands:

          objects [--plugin-description]

            List all available graph objects.

              --plugin-description
                    print plugin descriptions

          systemobjects [--plugin-description]

            List all available system objects.

              --plugin-description
                    print plugin descriptions

          plugindescription <graphobject>

            List all available plugindescription information of graph object.

              <graphobject>
                    The name of the graph object.

          isactive <graphobject>

            Prints whether the the given graph object is activated or deactivated.

              <graphobject>
                    The name of the graph object.

          activate <graphobject>

            Activate the given graph object.

              <graphobject>
                    The name of the graph object.

          deactivate <graphobject>

            Deactivate the given graph object.

              <graphobject>
                    The name of the graph object.

          listprops <graphobject>

            List the properties of the given graph object.

              <graphobject>
                    The name of the graph object.

          listpropvalues <graphobject>

            List the properties and their values of the given graph object.

              <graphobject>
                    The name of the graph object.

          setprop <graphobject> <propertyname> <value>

            Set the given property value of the given graph object.

              <graphobject>
                    The name of the graph object.

              <propertyname>
                    The name of the property.

              <value>
                    The new value of the property.

          getprop <graphobject> <propertyname>

            Get a property value of the given graph object.

              <graphobject>
                    The name of the graph object.

              <propertyname>
                    The name of the property.

          addcomponent <graph> <componenttype> <classid> <label>

            Add a component to given graph.

              <graph>
                    The name of the graph.

              <componenttype>
                    The type of the component, one of: samplestream, bindingproxy, filter,
                    activerunner, sink, source

              <classid>
                    The class id of the component.

              <label>
                    The label of the component.

          connect <component> <component> [--output-pin <pin>] ([--input-pin <pin>] | [--runner-pin
          <pin>])

            Connect two given components in the same graph via given pins.

              <component>
                    The name of the source component.

              <component>
                    The name of the destination component.

              --output-pin <pin>
                    Source data pin name.

              --input-pin <pin>
                    Destination data pin name.

              --runner-pin <pin>
                    Destination runner pin.

                
            

Available objects of an ADTF Session

To reference any ADTF Component inside the ADTF Session you need to know its unique path. To list the path of all ADTF Components inside an ADTF Graph file issue the following command (either supply the name of an ADTF Session file or the name of ADTF Graph file):

If you have selected one of the ADTF Components you can use

adtf_config_tool.exe <sessionfile/graphfile> -e listprops <component>

to get a list of all available properties which can be set via setprop and getprop.

Example add and connect a Filter

Since version 3.4.0 you can use the method addcomponent to add a new ADTF Component into an existing ADTF Graph in an existing .adtfgraph file

adtf_config_tool.exe <sessionfile/graphfile> -e addcomponent <GRAPH> <COMPONENT_TYPE> <CLASS_ID> <LABEL>

To find an existing ADTF Graph file for the parameter <GRAPH> use adtf_config_tool.exe <session> -e objects. Than define the <COMPONENT_TYPE> which you want to add to the ADTF Graph. Possible values are:

and the <CLASS_ID> of the componet (e.g. default_sample_stream.streaming.adtf.cid). Finally choose a name for the added ADTF Component in the ADTF Graph, the name must be unique.

The following example first adds a SampleStream, second a Filter and establishes a connection beween these two ADTF Components.

            
adtf_config_tool.exe <sessionfile/graphfile> -e addcomponent "Playback Sample/graphs/video_visual/" samplestream default_sample_stream.streaming.adtf.cid "SampleStream"
adtf_config_tool.exe <sessionfile/graphfile> -e addcomponent "Playback Sample/graphs/video_visual/" filter example.filter.adtf.cid "Filter"
adtf_config_tool.exe <sessionfile/graphfile> -e connect "Playback Sample/graphs/video_visual/sample_streams/SampleStream" "Playback Sample/graphs/video_visual/filters/Filter" -input_pin=in1
        

Scripting Mode

The ADTF Config Tool supports very basic scripting (see -e command). For more information on how to do this, please have a look at our Create Graph Scripting Example.

Where to go next?

With the ADTF Statusmonitor you can receive some system information during runtime.