Defines access methods for the interface of a Stream Type - see also Stream Type and Stream Meta Type for more information. More...
Public Member Functions | |
| ADTF_IID (IStreamType, "streamtype.ant.streaming.adtf.iid") | |
| Interface ID for the Stream Type interface. | |
| virtual tResult | GetMetaTypeName (base::ant::IString &&strTypeName) const =0 |
| Get the meta type name of this instance. More... | |
| virtual adtf::util::tVersion | GetVersion () const =0 |
| Get version of this instance of the StreamMetaType. More... | |
| virtual tResult | GetConfig (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties)=0 |
| Get all properties of a Stream Type (read/write) More... | |
| virtual tResult | GetConfig (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const =0 |
| Get all properties of a Stream Type (read only) - const correct. More... | |
| virtual tResult | GetMetaType (ucom::ant::iobject_ptr< const IStreamMetaType > &pMetaType) const =0 |
| Get the Stream Meta Type definition of the Stream Type. 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 | |
| ~IStreamType ()=default | |
| not destructable | |
| Protected Member Functions inherited from IObject | |
| ~IObject ()=default | |
| Protected destructor --> Use implemented Destroy() instead of delete! | |
Detailed Description
Defines access methods for the interface of a Stream Type - see also Stream Type and Stream Meta Type for more information.
The IStreamType interface reflects the class which is used to instantiate objects of Stream Types as described in Stream Type and Stream Meta Type.
Definition at line 102 of file streamtype_intf.h.
Member Function Documentation
◆ GetConfig() [1/2]
|
pure virtual |
Get all properties of a Stream Type (read/write)
- Parameters
-
[out] pProperties All properties of a Stream Type (can be modified)
- Returns
- Standard error code
- Return values
-
ERR_NOERROR Everything went fine
Referenced by adtf::streaming::ant::get_property(), stream_meta_type_plain::IsCompatible(), stream_meta_type_string::IsCompatible(), and adtf::streaming::ant::set_property().
◆ GetConfig() [2/2]
|
pure virtual |
Get all properties of a Stream Type (read only) - const correct.
- Parameters
-
[out] pProperties All properties of a Stream Type
- Returns
- Standard error code
- Return values
-
ERR_NOERROR Everything went fine
◆ GetMetaType()
|
pure virtual |
Get the Stream Meta Type definition of the Stream Type.
- Parameters
-
[out] pMetaType The Stream Meta Type definition of this Stream Type
- Returns
- Standard error code
- Return values
-
ERR_NOERROR Everything went fine
◆ GetMetaTypeName()
|
pure virtual |
Get the meta type name of this instance.
- Returns
- Standard error code
- Parameters
-
[out] strTypeName The meta type name as string
- Return values
-
ERR_NOERROR Everything went fine
Referenced by adtf::streaming::lucky::get_stream_type_audio_format(), adtf::streaming::spider::is_equal(), adtf::streaming::ant::operator==(), and adtf::streaming::lucky::set_stream_type_audio_format().
◆ GetVersion()
|
pure virtual |
Get version of this instance of the StreamMetaType.
- Returns
- Version of the StreamMetaType instantiated.
- See also
- adtf_util::tVersion