ADTF  3.13.2
stream_meta_type_audio

Use this Stream Meta Type for describing a audio stream with samples and sample rate. More...

Static Public Member Functions

static tVoid SetProperties (const adtf::ucom::iobject_ptr< adtf::base::IProperties > &pProperties)
 Sets the default properties to the given pProperties. More...
 

Static Public Attributes

static constexpr const tChar *const MetaTypeName = "adtf/audio"
 StreamMetaTypeName for audiotype (audio stream).
 
static constexpr const tChar *const FormatName = "format_name"
 Name for the Property of the format name. More...
 
static constexpr const tChar *const ChannelCount = "channel_count"
 Name for the Property for the amount of channels. More...
 
static constexpr const tChar *const SampleRateHz = "sample_rate_hz"
 Name for the Property for the sample rate in hz. More...
 
static constexpr const tChar *const BitsPerSample = "bits_per_sample"
 Name for the Property for number of bits per sample. More...
 
static constexpr const tChar *const SampleCount = "sample_count"
 Name for the Property for number of samples. More...
 

Detailed Description

Use this Stream Meta Type for describing a audio stream with samples and sample rate.

Concept template to create the "adtf/audio" Stream Meta Type for the generator template stream_meta_type.

Remarks
Mind that this defines only the absolute minimum of properties for audio storage, many formats will require additional properties.
See also
Stream Meta Type

Definition at line 28 of file streammetatypeaudio.h.

Member Function Documentation

◆ SetProperties()

static tVoid SetProperties ( const adtf::ucom::iobject_ptr< adtf::base::IProperties > &  pProperties)
inlinestatic

Sets the default properties to the given pProperties.

Parameters
pPropertiesThe properties where to set the default properties to

Definition at line 63 of file streammetatypeaudio.h.

References stream_meta_type_audio::BitsPerSample, stream_meta_type_audio::ChannelCount, stream_meta_type_audio::FormatName, stream_meta_type_audio::SampleCount, and stream_meta_type_audio::SampleRateHz.

Member Data Documentation

◆ BitsPerSample

constexpr const tChar* const BitsPerSample = "bits_per_sample"
static

Name for the Property for number of bits per sample.

Name for the Property for number of bits per sample.

Definition at line 52 of file streammetatypeaudio.h.

Referenced by adtf::streaming::lucky::get_stream_type_audio_format(), adtf::streaming::lucky::set_stream_type_audio_format(), and stream_meta_type_audio::SetProperties().

◆ ChannelCount

constexpr const tChar* const ChannelCount = "channel_count"
static

Name for the Property for the amount of channels.

Name for the Property for the amount of channels.

Definition at line 42 of file streammetatypeaudio.h.

Referenced by adtf::streaming::lucky::get_stream_type_audio_format(), adtf::streaming::lucky::set_stream_type_audio_format(), and stream_meta_type_audio::SetProperties().

◆ FormatName

constexpr const tChar* const FormatName = "format_name"
static

Name for the Property of the format name.

Name for the Property of the format name.

Definition at line 37 of file streammetatypeaudio.h.

Referenced by adtf::streaming::lucky::get_stream_type_audio_format(), adtf::streaming::lucky::set_stream_type_audio_format(), and stream_meta_type_audio::SetProperties().

◆ SampleCount

constexpr const tChar* const SampleCount = "sample_count"
static

Name for the Property for number of samples.

Name for the Property for number of samples

Definition at line 57 of file streammetatypeaudio.h.

Referenced by adtf::streaming::lucky::get_stream_type_audio_format(), adtf::streaming::lucky::set_stream_type_audio_format(), and stream_meta_type_audio::SetProperties().

◆ SampleRateHz

constexpr const tChar* const SampleRateHz = "sample_rate_hz"
static

Name for the Property for the sample rate in hz.

Name for the Property for the sample rate in hz.

Definition at line 47 of file streammetatypeaudio.h.

Referenced by adtf::streaming::lucky::get_stream_type_audio_format(), adtf::streaming::lucky::set_stream_type_audio_format(), and stream_meta_type_audio::SetProperties().


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