ADTF  3.13.2
IStreamTypeabstract

Defines access methods for the interface of a Stream Type - see also Stream Type and Stream Meta Type for more information. More...

Inheritance diagram for IStreamType:
[legend]

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 100 of file streamtype_intf.h.

Member Function Documentation

◆ GetConfig() [1/2]

virtual tResult GetConfig ( ucom::ant::iobject_ptr< base::ant::IProperties > &  pProperties)
pure virtual

Get all properties of a Stream Type (read/write)

Parameters
[out]pPropertiesAll properties of a Stream Type (can be modified)
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

Referenced by adtf::streaming::ant::get_property(), stream_meta_type_plain::IsCompatible(), and adtf::streaming::ant::set_property().

◆ GetConfig() [2/2]

virtual tResult GetConfig ( ucom::ant::iobject_ptr< const base::ant::IProperties > &  pProperties) const
pure virtual

Get all properties of a Stream Type (read only) - const correct.

Parameters
[out]pPropertiesAll properties of a Stream Type
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

◆ GetMetaType()

virtual tResult GetMetaType ( ucom::ant::iobject_ptr< const IStreamMetaType > &  pMetaType) const
pure virtual

Get the Stream Meta Type definition of the Stream Type.

Parameters
[out]pMetaTypeThe Stream Meta Type definition of this Stream Type
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

Referenced by cLegacyPinEvents::OnTypeChanged().

◆ GetMetaTypeName()

virtual tResult GetMetaTypeName ( base::ant::IString &&  strTypeName) const
pure virtual

Get the meta type name of this instance.

Returns
Standard error code
Parameters
[out]strTypeNameThe meta type name as string
Return values
ERR_NOERROREverything went fine

Referenced by adtf::streaming::lucky::get_stream_type_audio_format(), adtf::streaming::ant::operator==(), and adtf::streaming::lucky::set_stream_type_audio_format().

◆ GetVersion()

virtual adtf::util::tVersion GetVersion ( ) const
pure virtual

Get version of this instance of the StreamMetaType.

Returns
Version of the StreamMetaType instantiated.
See also
adtf_util::tVersion

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Nov 16 2021 by doxygen 1.8.14)