ADTF
3.18.2
|
Provides the global 'types' object within scripts. More...
Public Member Functions | |
Q_INVOKABLE QObject * | createDefinition (const QString &strStructName) |
Create a new cScriptStructure definition. More... | |
Q_INVOKABLE QObject * | getDefinition (const QString &strStructName) |
Returns a stream type with a media description set from the Media Description Service. More... | |
Q_INVOKABLE QObject * | createStreamType (const QString &strMetaType) |
Create a new cStreamTypeWrapper instance with the given Stream Meta Type. More... | |
Q_INVOKABLE QObject * | createPlainStreamType (const QString &strCType) |
Create a new cStreamTypeWrapper instance for a adtf/plain stream type with the a given c-type. More... | |
Q_INVOKABLE QObject * | createSubStreamsType () |
Creates a stream type that can handle Substreams. More... | |
Q_INVOKABLE QObject * | fromDescriptionFile (const QString &strStructName, const QString &strFileName, bool bResolveStruct=true) |
Creates an 'adtf/default' Stream Type from the given media description file. More... | |
Q_INVOKABLE QObject * | fromDescriptionString (const QString &strStructName, const QString &strMediaDescription, bool bResolveStruct=true) |
Creates an 'adtf/default' Stream Type from the given media description string. More... | |
Private Attributes | |
QJSEngine & | m_oEngine |
adtf::util::cFilepath | m_strScriptFolder |
Provides the global 'types' object within scripts.
Definition at line 138 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/javascriptfiltersdk/src/types.h.
Q_INVOKABLE QObject* createDefinition | ( | const QString & | strStructName | ) |
Create a new cScriptStructure definition.
[in] | strStructName | The name of the structure. |
Q_INVOKABLE QObject* createPlainStreamType | ( | const QString & | strCType | ) |
Create a new cStreamTypeWrapper instance for a adtf/plain stream type with the a given c-type.
[in] | strCType | The c-type name ( bool, int8, uint8, int16, uint16, " "int32, uint32, int64, uint64, float, double) |
Q_INVOKABLE QObject* createStreamType | ( | const QString & | strMetaType | ) |
Create a new cStreamTypeWrapper instance with the given Stream Meta Type.
This allows you to create any stream type manually by setting the Properties.
[in] | strMetaType | The Stream Meta Type. |
Q_INVOKABLE QObject* createSubStreamsType | ( | ) |
Creates a stream type that can handle Substreams.
Q_INVOKABLE QObject* fromDescriptionFile | ( | const QString & | strStructName, |
const QString & | strFileName, | ||
bool | bResolveStruct = true |
||
) |
Creates an 'adtf/default' Stream Type from the given media description file.
[in] | strStructName | The name of the struct within the .description file |
[in] | strFileName | The filename of the .description file. You can use macros as well. Relative filenames are resolved with respect to the script file. |
[in] | bResolveStruct | If true, the DDL will be reduced to contain only the definition of strStructName and its dependencies. |
Q_INVOKABLE QObject* fromDescriptionString | ( | const QString & | strStructName, |
const QString & | strMediaDescription, | ||
bool | bResolveStruct = true |
||
) |
Creates an 'adtf/default' Stream Type from the given media description string.
[in] | strStructName | The name of the struct within the .description file |
[in] | strMediaDescription | The string containing the media description. |
[in] | bResolveStruct | If true, the DDL will be reduced to contain only the definition of strStructName and its dependencies. |
Q_INVOKABLE QObject* getDefinition | ( | const QString & | strStructName | ) |
Returns a stream type with a media description set from the Media Description Service.
Please mind that the prefered way to use description files in scripting is via the fromDescriptionFile() method.
[in] | strStructName | The name of the structure that should be retrieved from the service.. |