Macros

Table of Contents

• Retrieving Macros, Setting Macros
• Table of predefined Global Macros
• Table of predefined Scoped Macros

Retrieving Macros, Setting Macros

Macros are place holders for a value within a string. These macros are used within ADTF to

• retrieve environment variables
• set and retrieve session or system specific paths and values
• set and retrieve user-specific macros

A global interface adtf::services::ant::IMacroResolver is provided if you use the section_adtf_default_system. If no Macro Resolver is used within the system, environment variables are used

We recommend to use always:

• adtf::services::ant::adtf_resolve_macros to retrieve a macro value
• adtf::services::ant::adtf_register_macro to set a macro value

The Session Manager will automatically resolve Macros on Properties: See Automatically resolving of macros.

Table of predefined Global Macros

Macro	Description	Additional information
ADTF_DIR	The ADTF_DIR points to your ADTF installation directory.	only set if using ADTF Launcher
ADTF_SESSION_DIR	The ADTF_SESSION_DIR points to directory of the current .adtfsession file loaded (if loaded via adtfsession)	only set if using Session Manager
ADTF_SESSION_FILE_NAME	The ADTF_SESSION_FILE_NAME is resolved to the current .adtfsession file loaded without path (if loaded via adtfsession)	only set if using Session Manager
ADTF_SESSION_FILE_NAME_NOEXT	The ADTF_SESSION_FILE_NAME_NOEXT is resolved to the current .adtfsession file loaded without path and without extension (if loaded via adtfsession)	only set if using Session Manager
ADTF_SESSION_DATA_DIR	The ADTF_SESSION_DATA_DIR points to directory of the current session data (if loaded via adtfsession) By default this directory points to the.	only set if using Session Manager
ADTF_SYSTEM_DIR	The ADTF_SYSTEM_DIR points to directory of the current .adtfsystem file loaded (if loaded via adtfsystem)	only set if using Session Manager
ADTF_SYSTEM_FILE_NAME	The ADTF_SYSTEM_FILE_NAME is resolved to the current .adtfsystem file loaded without path (if loaded via adtfsystem)	only set if using Session Manager
ADTF_SYSTEM_FILE_NAME_NOEXT	The ADTF_SYSTEM_FILE_NAME_NOEXT is resolved to the current .adtfsystem file loaded without path and without extension (if loaded via adtfsystem)	only set if using Session Manager
ADTF_GRAPH_DIR	The ADTF_GRAPH_DIR points to directory of the current .adtfgraph file loaded (if loaded via adtfgraph)	only set if using Session Manager
ADTF_GRAPH_FILE_NAME	The ADTF_GRAPH_FILE_NAME is resolved to the current .adtfgraph file loaded without path (if loaded via adtfgraph)	only set if using Session Manager
ADTF_GRAPH_FILE_NAME_NOEXT	The ADTF_GRAPH_FILE_NAME_NOEXT is resolved to the current .adtfgraph file loaded without path and without extension(if loaded via adtfgraph)	only set if using Session Manager
ADTF_PLAYBACK_FILE_NAMES	The ADTF_PLAYBACK_FILE_NAMES is resolved to the filenames of the currently opened playback files, separated by ';'.	only set if the playback service has opened some files.
ADTF_PLAYBACK_FILE_NAMES_NOEXT	The ADTF_PLAYBACK_FILE_NAMES_NOEXT is resolved to the filenames without the extension of the currently opened playback files, separated by ';'.	only set if the playback service has opened some files.
ADTF_PLAYBACK_FILE_BASENAMES	The ADTF_PLAYBACK_FILE_BASENAMES is resolved to the basenames (filenames without directory components) of the currently opened playback files, separated by ';'.	only set if the playback service has opened some files.
ADTF_PLAYBACK_FILE_BASENAMES_NOEXT	The ADTF_PLAYBACK_FILE_BASENAMES_NOEXT is resolved to the basenames (filenames without directory components) without the extension of the currently opened playback files, separated by ';'.	only set if the playback service has opened some files.
ADTF_PLAYBACK_DIRS	The ADTF_PLAYBACK_DIRS is resolved to the directories that the currently opened playback files reside in, separated by ';'.	only set if the playback service has opened some files.
ADTF_COMPONENT_STORE_DOWNLOAD_DIR	The ADTF_COMPONENT_STORE_DOWNLOAD_DIR points to the root directory of the download folder for content from defined stores.	only set if session has been launched via ADTF Configuration Editor
ADTF_REMOTE_CONTROL_URL	The ADTF_REMOTE_CONTROL_URL represents the RPC url to access the launched session.	only set if session has been launched via ADTF Configuration Editor

Table of predefined Scoped Macros

Scoped Macros are resolved only while initializing and setting properties. These Scoped Macros can only be used within properties while the Session Manager creates the Filter Graph and Streaming Graph.

Scoped Macro	Description	Additional information
THIS_OBJECT_NAME	The THIS_OBJECT_NAME is a scoped macro to resolve the current name of an object.	only set if using Session Manager
THIS_OBJECT_PARENT	The THIS_OBJECT_PARENT is a scoped macro to resolve the current fully path name of an objects parent (. separated)	only set if using Session Manager
THIS_OBJECT_FULL_NAME	The THIS_OBJECT_FULL_NAME is a scoped macro to resolve the current fully path name of an objects (. separated)	only set if using Session Manager