ADM Elements¶
AudioProgramme¶
-
class
AudioProgramme
: public std::enable_shared_from_this<AudioProgramme>¶ Class representation of the audioProgramme ADM element.
- Warning
- This class has unsupported parameters:
Public Types
-
typedef AudioProgrammeTag
tag
¶
-
typedef AudioProgrammeId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioProgramme>
copy
() const¶ Copy AudioProgramme.
The actual copy constructor is private to ensure that an AudioProgramme can only be created as a
std::shared_ptr
. This is not a deep copy! All referenced objects will be disconnected.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioProgrammeId id)¶ AudioProgrammeId setter.
-
void
set
(AudioProgrammeName name)¶ AudioProgrammeName setter.
-
void
set
(AudioProgrammeLanguage language)¶ AudioProgrammeLanguage setter.
-
void
set
(Start start)¶ Start setter.
-
void
set
(End end)¶ End setter.
-
void
set
(LoudnessMetadata loudnessMetadata)¶ LoudnessMetadata setter.
-
void
set
(MaxDuckingDepth depth)¶ MaxDuckingDepth setter.
-
void
set
(AudioProgrammeReferenceScreen refScreen)¶ AudioProgrammeReferenceScreen setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
Add reference to an AudioContent.
-
template <typename Element>
ElementRange<Element>getReferences
()¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the ADM elements with the specified type.
-
template <typename Element>
ElementRange<const Element>getReferences
() const¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the ADM elements with the specified type.
Remove reference to an AudioContent.
-
template <typename Element>
voidclearReferences
()¶ Clear references to Elements template.
Templated clear method with the ADM parameter type as template argument. Removes all references to the ADM elements with the specified type.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioProgramme>create
(AudioProgrammeName name, Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioProgramme object can only be created as a
std::shared_ptr
.
-
class
AudioProgrammeId
¶ Representation of an AudioProgrammeId.
Unnamed Group
-
bool
operator==
(const AudioProgrammeId &other) const¶ Operator overload.
Compares the string representation of the AudioProgrammeId.
-
bool
operator!=
(const AudioProgrammeId &other) const¶
-
bool
operator<
(const AudioProgrammeId &other) const¶
Public Types
-
typedef AudioProgrammeIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioProgrammeId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioProgrammeIdValue value)¶ Set value.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::AudioProgrammeName = typedef detail::NamedType<std::string, AudioProgrammeNameTag>
NamedType for the audioProgrammeName attribute.
-
using
adm::AudioProgrammeLanguage = typedef detail::NamedType<std::string, AudioProgrammeLanguageTag>
NamedType for the language attribute of the audioProgramme element.
-
using
adm::End = typedef detail::NamedType<std::chrono::nanoseconds, EndTag>
NamedType for the end attribute.
-
using
adm::MaxDuckingDepth = typedef detail::NamedType<double, MaxDuckingDepthTag, detail::RangeValidator<-62, 0>>
NamedType for the maxDuckingDepth attribute element.
Valid values are in the range [-62, 0]
AudioContent¶
-
class
AudioContent
: public std::enable_shared_from_this<AudioContent>¶ Class representation of the audioContent ADM element.
- Warning
- This class has unsupported parameters:
Unnamed Group
-
void
set
(DialogueId kind)¶ Dialogue setter.
- Note
- Setting one of the dialogue kinds always ensures consistency. If DialogueId is set the corresponding ContentKind will be set to undefined. If one of the ContentKinds is set DialogueId will be set accordingly.
-
void
set
(ContentKind kind)¶
-
void
set
(NonDialogueContentKind kind)¶
-
void
set
(DialogueContentKind kind)¶
-
void
set
(MixedContentKind kind)¶
Public Types
-
typedef AudioContentTag
tag
¶
-
typedef AudioContentId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioContent>
copy
() const¶ Copy AudioContent.
The actual copy constructor is private to ensure that an AudioContent can only be created as a
std::shared_ptr
. This is not a deep copy! All referenced objects will be disconnected.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the ADM parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioContentId id)¶ AudioContentId setter.
-
void
set
(AudioContentName name)¶ AudioContentName setter.
-
void
set
(AudioContentLanguage language)¶ AudioContentLanguage setter.
-
void
set
(LoudnessMetadata loudnessMetadata)¶ LoudnessMetadata setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
- Note
- Unsetting DialogueId automatically unsets the corresponding ContentKind. Unsetting one of the ContentKinds automatically unsets DialogueId.
Add reference to an AudioObject.
-
template <typename Element>
ElementRange<const Element>getReferences
() const¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the adm elements with the specified type.
-
template <typename Element>
ElementRange<Element>getReferences
()¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the adm elements with the specified type.
Remove reference to an AudioObject.
-
template <typename Element>
voidclearReferences
()¶ Clear references to Elements template.
Templated clear method with the ADM parameter type as template argument. Removes all references to the adm elements with the specified type.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioContent>create
(AudioContentName name, Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioContent object can only be created as a
std::shared_ptr
.
-
class
AudioContentId
¶ Representation of an AudioContentId.
Unnamed Group
-
bool
operator==
(const AudioContentId &other) const¶ Operator overload.
Compares the string representation of the AudioContentId.
-
bool
operator!=
(const AudioContentId &other) const¶
-
bool
operator<
(const AudioContentId &other) const¶
Public Types
-
typedef AudioContentIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioContentId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioContentIdValue value)¶ Set value.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::AudioContentName = typedef detail::NamedType<std::string, AudioContentNameTag>
NamedType for the audioContentName attribute.
-
using
adm::AudioContentLanguage = typedef detail::NamedType<std::string, AudioContentLanguageTag>
NamedType for the language attribute of the audioContent element.
AudioObject¶
-
class
AudioObject
: public std::enable_shared_from_this<AudioObject>¶ Class representation of the audioObject ADM element.
Public Types
-
typedef AudioObjectTag
tag
¶
-
typedef AudioObjectId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioObject>
copy
() const¶ Copy AudioObject.
The actual copy constructor is private to ensure that an AudioObject can only be created as a
std::shared_ptr
. This is not a deep copy! All referenced objects will be disconnected.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioObjectId id)¶ AudioObjectId setter.
-
void
set
(AudioObjectName name)¶ AudioObjectName setter.
-
void
set
(Start start)¶ Start setter.
-
void
set
(Duration duration)¶ Duration setter.
-
void
set
(DialogueId id)¶ DialogueId setter.
-
void
set
(Importance importance)¶ Importance setter.
-
void
set
(Interact interact)¶ Interact setter.
-
void
set
(DisableDucking disableDucking)¶ DisableDucking setter.
-
void
set
(AudioObjectInteraction objectInteraction)¶ AudioObjectInteraction setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
Add reference to another AudioObject.
Add reference to an AudioPackFormat.
Add reference to an AudioTrackUid.
-
template <typename Element>
ElementRange<const Element>getReferences
() const¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the ADM elements with the specified type.
-
template <typename Element>
ElementRange<Element>getReferences
()¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the ADM elements with the specified type.
Remove reference to an AudioObject.
Remove reference to an AudioPackFormat.
Remove reference to an AudioTrackUid.
-
template <typename Element>
voidclearReferences
()¶ Clear references to Elements template.
Templated clear method with the ADM parameter type as template argument. Removes all references to the ADM elements with the specified type.
Add reference to a complementary AudioObject.
-
const std::vector<std::shared_ptr<AudioObject>> &
getComplementaryObjects
() const¶ Get references to complementary AudioObjects.
Remove reference to a complementary AudioObject.
-
void
clearComplementaryObjects
()¶ Remove all references to complementary AudioObjects.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioObject>create
(AudioObjectName name, Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioObject object can only be created as a
std::shared_ptr
.
-
typedef AudioObjectTag
-
class
AudioObjectId
¶ Representation of an AudioObjectId.
Unnamed Group
-
bool
operator==
(const AudioObjectId &other) const¶ Operator overload.
Compares the string representation of the AudioObjectId.
-
bool
operator!=
(const AudioObjectId &other) const¶
-
bool
operator<
(const AudioObjectId &other) const¶
Public Types
-
typedef AudioObjectIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioObjectId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioObjectIdValue value)¶ Set value.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::AudioObjectName = typedef detail::NamedType<std::string, AudioObjectNameTag>
NamedType for the audioObjectName attribute.
-
using
adm::DialogueId = typedef detail::NamedType<unsigned int, DialogueIdTag, detail::RangeValidator<0, 2>>
NamedType for the dialogueId attribute.
Valid values are in the range [0, 2]
-
using
adm::Interact = typedef detail::NamedType<bool, InteractTag>
NamedType for the interact attribute.
-
using
adm::DisableDucking = typedef detail::NamedType<bool, DisableDuckingTag>
NamedType for the disableDucking attribute.
-
class
AudioObjectInteraction
¶ ADM parameter class to specify a channel lock.
Public Types
-
typedef AudioObjectInteractionTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioObjectInteraction
(OnOffInteract onOffInteract, Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(OnOffInteract)¶ OnOffInteract setter.
-
void
set
(GainInteract)¶ GainInteract setter.
-
void
set
(PositionInteract)¶ PositionInteract setter.
-
void
set
(GainInteractionRange)¶ GainInteractionRange setter.
-
void
set
(PositionInteractionRange)¶ PositionInteractionRange setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef AudioObjectInteractionTag
-
using
adm::OnOffInteract = typedef detail::NamedType<bool, OnOffInteractTag>
NamedType for channelLockFlag parameter.
-
using
adm::GainInteract = typedef detail::NamedType<bool, GainInteractTag>
NamedType for channelLockFlag parameter.
-
using
adm::PositionInteract = typedef detail::NamedType<bool, PositionInteractTag>
NamedType for channelLockFlag parameter.
-
class
GainInteractionRange
¶ ADM parameter class to specify a gainInteractionRange.
Public Types
-
typedef GainInteractionRangeTag
tag
¶
Public Functions
-
template <typename... Parameters>
GainInteractionRange
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(GainInteractionMin)¶ GainInteractionMin setter.
-
void
set
(GainInteractionMax)¶ GainInteractionMax setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef GainInteractionRangeTag
-
class
PositionInteractionRange
¶ ADM parameter class to specify a positionInteractionRange.
Public Types
-
typedef PositionInteractionRangeTag
tag
¶
Public Functions
-
template <typename... Parameters>
PositionInteractionRange
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AzimuthInteractionMin)¶ AzimuthInteractionMin setter.
-
void
set
(AzimuthInteractionMax)¶ AzimuthInteractionMax setter.
-
void
set
(ElevationInteractionMin)¶ ElevationInteractionMin setter.
-
void
set
(ElevationInteractionMax)¶ ElevationInteractionMax setter.
-
void
set
(DistanceInteractionMin)¶ DistanceInteractionMin setter.
-
void
set
(DistanceInteractionMax)¶ DistanceInteractionMax setter.
-
void
set
(XInteractionMin)¶ XInteractionMin setter.
-
void
set
(XInteractionMax)¶ XInteractionMax setter.
-
void
set
(YInteractionMin)¶ YInteractionMin setter.
-
void
set
(YInteractionMax)¶ YInteractionMax setter.
-
void
set
(ZInteractionMin)¶ ZInteractionMin setter.
-
void
set
(ZInteractionMax)¶ ZInteractionMax setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef PositionInteractionRangeTag
AudioTrackUid¶
-
class
AudioTrackUid
: public std::enable_shared_from_this<AudioTrackUid>¶ Class representation of the audioTrackUID ADM element.
- Warning
- This class has unsupported parameters:
- audioMXFLookUp
Public Types
-
typedef AudioTrackUidTag
tag
¶
-
typedef AudioTrackUidId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioTrackUid>
copy
() const¶ Copy AudioTrackUid.
The actual copy constructor is private to ensure that an AudioTrackUid can only be created as a
std::shared_ptr
. This is not a deep copy! All referenced objects will be disconnected.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioTrackUidId id)¶ AudioTrackUidId setter.
-
void
set
(SampleRate sampleRate)¶ SampleRate setter.
-
void
set
(BitDepth bitDepth)¶ BitDepth setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
Set reference to an AudioTrackFormat.
A pending unresolved reference will be removed.
Set reference to an AudioPackFormat.
A pending unresolved reference will be removed.
-
template <typename Element>
std::shared_ptr<const Element>getReference
() const¶
-
template <typename Element>
std::shared_ptr<Element>getReference
()¶ Get reference to ADM element template.
Templated get method with the ADM parameter type as template argument. Returns the reference to the ADM element with the specified type. If it is not set a nullptr will be returned.
-
template <typename Element>
voidremoveReference
()¶ Remove reference to an Element template.
Templated remove method with the ADM parameter type as template argument. Removes the reference to the ADM elements with the specified type.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioTrackUid>create
(Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioTrackUid object can only be created as a
std::shared_ptr
.
-
class
AudioTrackUidId
¶ Representation of an AudioTrackUidId.
Unnamed Group
-
bool
operator==
(const AudioTrackUidId &other) const¶ Operator overload.
Compares the string representation of the AudioTrackUidId.
-
bool
operator!=
(const AudioTrackUidId &other) const¶
-
bool
operator<
(const AudioTrackUidId &other) const¶
Public Types
-
typedef AudioTrackUidIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioTrackUidId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioTrackUidIdValue value)¶ Set value.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::SampleRate = typedef detail::NamedType<unsigned int, SampleRateTag>
NamedType for the sampleRate element.
-
using
adm::BitDepth = typedef detail::NamedType<unsigned int, BitDepthTag>
NamedType for the bitDepth element.
AudioPackFormat¶
-
class
AudioPackFormat
: public std::enable_shared_from_this<AudioPackFormat>¶ Class representation of the audioPackFormat ADM element.
Public Types
-
typedef AudioPackFormatTag
tag
¶
-
typedef AudioPackFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioPackFormat>
copy
() const¶ Copy AudioPackFormat.
The actual copy constructor is private to ensure that an AudioPackFormat can only be created as a
std::shared_ptr
. This is not a deep copy! All referenced objects will be disconnected.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioPackFormatId id)¶ AudioPackFormatId setter.
-
void
set
(AudioPackFormatName name)¶ AudioPackFormatName setter.
-
void
set
(Importance importance)¶ Importance setter.
-
void
set
(AbsoluteDistance distance)¶ AbsoluteDistance setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
Add reference to an AudioChannelFormat.
Add reference to another AudioPackFormat.
-
template <typename Element>
ElementRange<const Element>getReferences
() const¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the ADM elements with the specified type.
-
template <typename Element>
ElementRange<Element>getReferences
()¶ Get references to ADM elements template.
Templated get method with the ADM parameter type as template argument. Returns a set of all references to the ADM elements with the specified type.
Remove reference to an AudioChannelFormat.
Remove reference to an AudioPackFormat.
-
template <typename Element>
voidclearReferences
()¶ Clear references to Elements template.
Templated clear method with the ADM parameter type as template argument. Removes all references to the ADM elements with the specified type.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioPackFormat>create
(AudioPackFormatName name, TypeDescriptor channelType, Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioPackFormat object can only be created as a
std::shared_ptr
.
-
typedef AudioPackFormatTag
-
class
AudioPackFormatId
¶ Representation of an AudioPackFormatId.
Unnamed Group
-
bool
operator==
(const AudioPackFormatId &other) const¶ Operator overload.
Compares the string representation of the AudioPackFormatId.
-
bool
operator!=
(const AudioPackFormatId &other) const¶
-
bool
operator<
(const AudioPackFormatId &other) const¶
Public Types
-
typedef AudioPackFormatIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioPackFormatId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(TypeDescriptor channelType)¶ Set channel type.
-
void
set
(AudioPackFormatIdValue value)¶ Set value.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::AudioPackFormatName = typedef detail::NamedType<std::string, AudioPackFormatNameTag>
NamedType for the audioPackFormatName attribute.
-
using
adm::AbsoluteDistance = typedef detail::NamedType<float, AbsoluteDistanceTag>
NamedType for the absoluteDistance attribute.
AudioChannelFormat¶
-
class
AudioChannelFormat
: public std::enable_shared_from_this<AudioChannelFormat>¶ Class representation of the audioChannelFormat ADM element.
Public Types
-
typedef AudioChannelFormatTag
tag
¶
-
typedef AudioChannelFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioChannelFormat>
copy
() const¶ Copy AudioChannelFormat.
The actual copy constructor is private to ensure that an AudioChannelFormat can only be created as a
std::shared_ptr
. Added AudioBlockFormats will be copied too.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioChannelFormatId id)¶ AudioChannelFormatId setter.
-
void
set
(AudioChannelFormatName name)¶ AudioChannelFormatName setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
add
(AudioBlockFormatDirectSpeakers blockFormat)¶ Add AudioBlockFormats.
The AudioBlockFormat has to be of the correct type. Otherwise an exception is thrown.
-
void
add
(AudioBlockFormatMatrix blockFormat)¶
-
void
add
(AudioBlockFormatObjects blockFormat)¶
-
void
add
(AudioBlockFormatHoa blockFormat)¶
-
void
add
(AudioBlockFormatBinaural blockFormat)¶
-
template <typename AudioBlockFormat>
BlockFormatsConstRange<AudioBlockFormat>getElements
() const¶ AudioBlockFormat elements getter template.
Templated getter with the wanted audioBlockFormat type as template argument.
- Return
- ContainerProxy containing all audioBlockFormats of the given type.
-
template <typename AudioBlockFormat>
BlockFormatsRange<AudioBlockFormat>getElements
()¶ AudioBlockFormat elements getter template.
Templated getter with the wanted audioBlockFormat type as template argument.
- Return
- ContainerProxy containing all audioBlockFormats of the given type.
-
void
clearAudioBlockFormats
()¶ Clear AudioBlockFormats.
Removes all audioBlockFormats from the AudioChannelFormat
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioChannelFormat>create
(AudioChannelFormatName name, TypeDescriptor channelType, Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioChannelFormat object can only be created as a
std::shared_ptr
.
-
typedef AudioChannelFormatTag
-
class
AudioChannelFormatId
¶ Representation of an AudioChannelFormatId.
Unnamed Group
-
bool
operator==
(const AudioChannelFormatId &other) const¶ Operator overload.
Compares the string representation of the AudioChannelFormatId.
-
bool
operator!=
(const AudioChannelFormatId &other) const¶
-
bool
operator<
(const AudioChannelFormatId &other) const¶
Public Types
-
typedef AudioChannelFormatIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioChannelFormatId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(TypeDescriptor channelType)¶ Set channel type.
-
void
set
(AudioChannelFormatIdValue value)¶ Set value.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::AudioChannelFormatName = typedef detail::NamedType<std::string, AudioChannelFormatNameTag>
NamedType for the audioChannelFormatName attribute.
-
class
Frequency
¶ ADM parameter class to specify a speaker position.
Public Types
-
typedef FrequencyTag
tag
¶
Public Functions
-
template <typename... Parameters>
Frequency
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(HighPass frequency)¶ HighPass setter.
-
void
set
(LowPass frequency)¶ LowPass setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef FrequencyTag
AudioStreamFormat¶
-
class
AudioStreamFormat
: public std::enable_shared_from_this<AudioStreamFormat>¶ Class representation of the audioStreamFormat ADM element.
Notes on std::weak_ptr usage
Please note that the references to
AudioTrackFormat
s are represented usingstd::weak_ptr
. Consequently, the method to retrieve those references isAudioStreamFormat::getAudioTrackFormatReferences()
to make the difference to othergetReferences<Element>()
explicit.The reason for using
std::weak_ptr
in the first place is because there’s a cyclic reference betweenAudioStreamFormat
andAudioTrackFormat
. As it turns out, using thestd::weak_ptr
forAudioTrackFormat
is much more convenient than the other way around. This is mostly due to the fact that otherwise there’s no direct connection from e.g.AudioTrackUid
toAudioStreamFormat
, which would cause the latter to be removed if we would use thestd::weak_ptr
connection the other way around.Furthermore, from the code we wrote so far, we can see that the
AudioTrackFormat -> AudioStreamFormat
connection is used quite often, while theAudioStreamFormat -> AudioTrackFormat
has been virtually unused so far. Thus it was the obvious choice to make the first use case more convenient for users of the library.Public Types
-
enum
ReferenceSyncOption
¶ Options to change AudioStreamFormat/AudioTrackFormat reference sync behaviour.
These options are to be used with
setReference
andremoveReference
and controls if this AudioTrackFormat is automatically added/removed as a reference to the AudioStreamFormat if it is referenced by this.The default (and only) behaviour is to keep AudioTrackFormat and AudioStreamFormat in sync.
Future applications might want to use a more relaxed policy by providing (and implementing, and testing!) other options.
Values:
-
sync_with_track_format
=
0x1
¶ commit all changes to AudioStreamFormat
-
-
typedef AudioStreamFormatTag
tag
¶
-
typedef AudioStreamFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioStreamFormat>
copy
() const¶ Copy AudioStreamFormat.
The actual copy constructor is private to ensure that an AudioStreamFormat can only be created as a
std::shared_ptr
. This is not deep copy! All referenced objects will be disconnected.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioStreamFormatId id)¶ AudioStreamFormatId setter.
-
void
set
(AudioStreamFormatName name)¶ AudioStreamFormatName setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
Set reference to an AudioChannelFormat.
A pending unresolved reference will be removed.
Set reference to an AudioPackFormat.
A pending unresolved reference will be removed.
-
bool
addReference
(std::weak_ptr<AudioTrackFormat> trackFormat, ReferenceSyncOption sync = ReferenceSyncOption::sync_with_track_format)¶ Add reference to an AudioTrackFormat.
- Parameters
trackFormat
: which should be added.sync
: controls if this will be automatically added totrackFormat
as a reference as well.
-
template <typename Element>
std::shared_ptr<const Element>getReference
() const¶ Get reference to ADM element template.
Templated get method with the ADM parameter type as template argument. Returns the reference to the ADM element with the specified type. If it is not set a nullptr will be returned.
-
template <typename Element>
std::shared_ptr<Element>getReference
()¶ Get reference to ADM element template.
Templated get method with the ADM parameter type as template argument. Returns the reference to the ADM element with the specified type. If it is not set a nullptr will be returned.
-
ElementWeakRange<const AudioTrackFormat>
getAudioTrackFormatReferences
() const¶ Get references to AudioTrackFormats.
Returns a range of std::weak_ptr<const AudioTrackFormats>.
- Note
- Please read the class documentation of adm::AudioStreamFormat for the rationale behind using std::weak_ptr.
-
ElementWeakRange<AudioTrackFormat>
getAudioTrackFormatReferences
()¶ Get references to AudioTrackFormats.
Returns a range of std::weak_ptr<AudioTrackFormats>.
- Note
- Please read the class documentation of adm::AudioStreamFormat for the rationale behind using std::weak_ptr.
-
void
removeReference
(std::weak_ptr<AudioTrackFormat> trackFormat, ReferenceSyncOption sync = ReferenceSyncOption::sync_with_track_format)¶ Remove reference to an AudioTrackFormat.
- Parameters
trackFormat
: reference which should be removed.sync
: controls if this will be automatically added totrackFormat
as a reference as well.
-
template <typename Element>
voidremoveReference
()¶ Remove reference to an Element template.
Templated remove method with the ADM parameter type as template argument. Removes the reference to the ADM elements with the specified type.
-
template <typename Element>
voidclearReferences
()¶ Clear references to Elements template.
Templated clear method with the ADM parameter type as template argument. Removes all references to the ADM elements with the specified type.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioStreamFormat>create
(AudioStreamFormatName name, FormatDescriptor format, Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioStreamFormat object can only be created as a
std::shared_ptr
.
-
enum
-
class
AudioStreamFormatId
¶ Representation of an AudioStreamFormatId.
Unnamed Group
-
bool
operator==
(const AudioStreamFormatId &other) const¶ Operator overload.
Compares the string representation of the AudioStreamFormatId.
-
bool
operator!=
(const AudioStreamFormatId &other) const¶
-
bool
operator<
(const AudioStreamFormatId &other) const¶
Public Types
-
typedef AudioStreamFormatIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioStreamFormatId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(TypeDescriptor channelType)¶ Set channel type.
-
void
set
(AudioStreamFormatIdValue value)¶ Set value.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::AudioStreamFormatName = typedef detail::NamedType<std::string, AudioStreamFormatNameTag>
NamedType for the audioStreamFormatName attribute.
AudioTrackFormat¶
-
class
AudioTrackFormat
: public std::enable_shared_from_this<AudioTrackFormat>¶ Class representation of the audioTrackFormat ADM element.
Public Types
-
enum
ReferenceSyncOption
¶ Options to change AudioStreamFormat/AudioTrackFormat reference sync behaviour.
These options are to be used with
setReference
andremoveReference
and controls if this AudioTrackFormat is automatically added/removed as a reference to the AudioStreamFormat if it is referenced by this.The default (and only) behaviour is to keep AudioTrackFormat and AudioStreamFormat in sync.
Future applications might want to use a more relaxed policy by providing (and implementing, and testing!) other options.
Values:
-
sync_with_stream_format
=
0x1
¶ commit all changes to AudioStreamFormat
-
-
typedef AudioTrackFormatTag
tag
¶
-
typedef AudioTrackFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
std::shared_ptr<AudioTrackFormat>
copy
() const¶ Copy AudioTrackFormat.
The actual copy constructor is private to ensure that an AudioTrackFormat can only be created as a
std::shared_ptr
. This is not deep copy! All referenced objects will be disconnected.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioTrackFormatId id)¶ AudioTrackFormatId setter.
-
void
set
(AudioTrackFormatName name)¶ AudioTrackFormatName setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
Set reference to an AudioStreamFormat.
A pending unresolved reference will be removed.
- Parameters
streamFormat
: which should be referenced.sync
: controls if this will be automatically added tostreamFormat
as a reference as well.
-
template <typename Element>
std::shared_ptr<const Element>getReference
() const¶ Get reference to ADM element template.
Templated get method with the ADM parameter type as template argument. Returns the reference to the ADM element with the specified type. If it is not set a nullptr will be returned.
-
template <typename Element>
std::shared_ptr<Element>getReference
()¶ Get reference to ADM element template.
Templated get method with the ADM parameter type as template argument. Returns the reference to the ADM element with the specified type. If it is not set a nullptr will be returned.
-
template <typename Element>
voidremoveReference
(ReferenceSyncOption sync = ReferenceSyncOption::sync_with_stream_format)¶ Remove reference to an Element template.
Templated remove method with the ADM parameter type as template argument. Removes the reference to the ADM elements with the specified type.
- Parameters
sync
: controls if any reference to this will be automatically removed from any referencedstreamFormat
as well, if is . For otherElement
types (which do not exist), this option is ignored does nothing
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
std::weak_ptr<Document>
getParent
() const¶ Get adm::Document this element belongs to.
Public Static Functions
-
template <typename... Parameters>
std::shared_ptr<AudioTrackFormat>create
(AudioTrackFormatName name, FormatDescriptor format, Parameters... optionalNamedArgs)¶ Static create function template.
Templated static create function which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters. The actual constructor is private. This way it is ensured, that an AudioTrackFormat object can only be created as a
std::shared_ptr
.
-
enum
-
class
AudioTrackFormatId
¶ Representation of an AudioTrackFormatId.
Unnamed Group
-
bool
operator==
(const AudioTrackFormatId &other) const¶ Operator overload.
Compares the string representation of the AudioTrackFormatId.
-
bool
operator!=
(const AudioTrackFormatId &other) const¶
-
bool
operator<
(const AudioTrackFormatId &other) const¶
Public Types
-
typedef AudioTrackFormatIdTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioTrackFormatId
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(TypeDescriptor channelType)¶ Set channel type.
-
void
set
(AudioTrackFormatIdValue value)¶ Set value.
-
void
set
(AudioTrackFormatIdCounter counter)¶ Set counter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
bool
-
using
adm::AudioTrackFormatName = typedef detail::NamedType<std::string, AudioTrackFormatNameTag>
NamedType for the audioTrackFormatName attribute.
AudioBlockFormat¶
As the audioBlockFormat ADM elements are quite different for each typeDefinition
there are five different AudioBlockFormat
classes.
Warning
The typeDefinitions Matrix
and HOA
are not completely
supported yet.
-
class
AudioBlockFormatDirectSpeakers
¶ Class representation for ADM element audioBlockFormat if audioChannelFormat.typeDefinition == “DirectSpeakers”.
Public Types
-
typedef AudioBlockFormatDirectSpeakersTag
tag
¶
Public Functions
-
template <typename... Parameters>
AudioBlockFormatDirectSpeakers
(Parameters... optionalNamedArgs)¶
-
AudioBlockFormatDirectSpeakers
(const AudioBlockFormatDirectSpeakers&)¶
-
AudioBlockFormatDirectSpeakers
(AudioBlockFormatDirectSpeakers&&)¶
-
AudioBlockFormatDirectSpeakers &
operator=
(const AudioBlockFormatDirectSpeakers&)¶
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
bool
isDefault
(detail::ParameterTraits<Rtime>::tag) const¶
-
void
set
(AudioBlockFormatId id)¶ AudioBlockFormatId setter.
-
void
set
(Rtime rtime)¶ Rtime setter.
-
void
set
(Duration duration)¶ Duration setter.
-
void
set
(SpeakerPosition speakerPosition)¶ SpeakerPosition setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
bool
add
(SpeakerLabel label)¶ Add a SpeakerLabel.
-
void
remove
(SpeakerLabel label)¶ remove a SpeakerLabel
-
typedef AudioBlockFormatDirectSpeakersTag
-
class
SpeakerPosition
¶ ADM parameter class to specify a speaker position.
- Warning
- The SpeakerPosition class does not support cartesian coordinates.
Public Types
-
typedef SpeakerPositionTag
tag
¶
Public Functions
-
template <typename... Parameters>
SpeakerPosition
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(Azimuth azimuth)¶ Azimuth setter.
-
void
set
(AzimuthMin azimuthMin)¶ AzimuthMin setter.
-
void
set
(AzimuthMax azimuthMax)¶ AzimuthMax setter.
-
void
set
(Elevation elevation)¶ Elevation setter.
-
void
set
(ElevationMin elevationMin)¶ Elevation minimum setter.
-
void
set
(ElevationMax elevationMax)¶ ElevationMax setter.
-
void
set
(Distance distance)¶ Distance setter.
-
void
set
(DistanceMin distanceMin)¶ DistanceMin setter.
-
void
set
(DistanceMax distanceMax)¶ DistanceMax setter.
-
void
set
(ScreenEdgeLock screenEdgeLock)¶ ScreenEdgeLock setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
class
AudioBlockFormatMatrix
¶ Class representation for ADM element audioBlockFormat if audioChannelFormat.typeDefinition == “Matrix”.
- Warning
- This class has unsupported parameters
- encodePackFormatIDRef
- decodePackFormatIDRef
- inputPackFormatIDRef
- outputPackFormatIDRef
Public Types
-
typedef AudioBlockFormatMatrixTag
tag
¶
-
typedef AudioBlockFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
template <typename... Parameters>
AudioBlockFormatMatrix
(Parameters... optionalNamedArgs)¶
-
AudioBlockFormatMatrix
(const AudioBlockFormatMatrix&)¶
-
AudioBlockFormatMatrix
(AudioBlockFormatMatrix&&)¶
-
AudioBlockFormatMatrix &
operator=
(const AudioBlockFormatMatrix&)¶
-
AudioBlockFormatMatrix &
operator=
(AudioBlockFormatMatrix&&)¶
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
bool
isDefault
(detail::ParameterTraits<Rtime>::tag) const¶
-
void
set
(AudioBlockFormatId id)¶ AudioBlockFormatId setter.
-
void
set
(Rtime rtime)¶ Rtime setter.
-
void
set
(Duration duration)¶ Duration setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
class
AudioBlockFormatObjects
¶ Class representation for ADM element audioBlockFormat if audioChannelFormat.typeDefinition == “Objects”.
- Warning
- This class has unsupported parameters
- ZoneExclusion
- ScreenRef
Public Types
-
typedef AudioBlockFormatObjectsTag
tag
¶
-
typedef AudioBlockFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
template <typename... Parameters>
AudioBlockFormatObjects
(CartesianPosition position, Parameters... optionalNamedArgs)¶
-
template <typename... Parameters>
AudioBlockFormatObjects
(SphericalPosition position, Parameters... optionalNamedArgs)¶
-
AudioBlockFormatObjects
(const AudioBlockFormatObjects&)¶
-
AudioBlockFormatObjects
(AudioBlockFormatObjects&&)¶
-
AudioBlockFormatObjects &
operator=
(const AudioBlockFormatObjects&)¶
-
AudioBlockFormatObjects &
operator=
(AudioBlockFormatObjects&&)¶
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioBlockFormatId id)¶ AudioBlockFormatId setter.
-
void
set
(Rtime rtime)¶ Rtime setter.
-
void
set
(Duration duration)¶ Duration setter.
-
void
set
(Cartesian cartesian)¶ Cartesian setter.
- Note
- If setting the ADM parameter cartesian will change the coordinate system the corresponding position will be set to a default value.
-
void
set
(Position position)¶ Position setter.
- Note
- Setting a SphericalPosition will automatically unset the CartesianPosition and the other way around. If a CartesianPosition is set the Cartesian flag will be set too. If a SphericalPosition is set the Cartesian flag will only be set if has already been set before (either directly or automatically).
-
void
set
(SphericalPosition position)¶ SphericalPosition setter.
- Note
- Setting a SphericalPosition will automatically unset the CartesianPosition. The Cartesian flag will only be set if it has already been set before (either directly or automatically).
-
void
set
(CartesianPosition position)¶ CartesianPosition setter.
- Note
- Setting a CartesianPosition will automatically unset the SphericalPosition. Also the Cartesian flag will be set automatically.
-
void
set
(Width width)¶ Width setter.
-
void
set
(Height height)¶ Height setter.
-
void
set
(Depth depth)¶ Depth setter.
-
void
set
(ScreenEdgeLock screenEdgeLock)¶ ScreenEdgeLock setter.
-
void
set
(Gain gain)¶ Gain setter.
-
void
set
(Diffuse diffuse)¶ Diffuse setter.
-
void
set
(ChannelLock channelLock)¶ ChannelLock setter.
-
void
set
(ObjectDivergence objectDivergence)¶ ObjectDivergence setter.
-
void
set
(JumpPosition jumpPosition)¶ JumpPosition setter.
-
void
set
(ScreenRef screenRef)¶ ScreenRef setter.
-
void
set
(Importance importance)¶ Importance setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
using
adm::Cartesian = typedef detail::NamedType<bool, CartesianTag>
NamedType for cartesian parameter.
-
typedef boost::variant<SphericalPosition, CartesianPosition>
adm
::
Position
¶ Type to hold a SphericalPosition or CartesianPosition.
-
class
SphericalPosition
¶ ADM parameter class to specify a spherical position.
Public Types
-
typedef SphericalPositionTag
tag
¶
Public Functions
-
SphericalPosition
(Azimuth azimuth = Azimuth(0.f), Elevation elevation = Elevation(0.f))¶ Constructor without optional parameters.
-
template <typename... Parameters>
SphericalPosition
(Azimuth azimuth, Elevation elevation, Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(Azimuth azimuth)¶ Azimuth setter.
-
void
set
(Elevation elevation)¶ Elevation setter.
-
void
set
(Distance distance)¶ Distance setter.
-
void
set
(ScreenEdgeLock screenEdgeLock)¶ ScreenEdgeLock setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef SphericalPositionTag
-
class
CartesianPosition
¶ ADM parameter class to specify a cartesian position.
Public Types
-
typedef CartesianPositionTag
tag
¶
Public Functions
-
CartesianPosition
(X x = X(0.f), Y y = Y(1.f))¶ Constructor without optional parameters.
-
template <typename... Parameters>
CartesianPosition
(X x, Y y, Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(X x)¶ X setter.
-
void
set
(Y y)¶ Y setter.
-
void
set
(Z z)¶ Z setter.
-
void
set
(ScreenEdgeLock screenEdgeLock)¶ ScreenEdgeLock setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef CartesianPositionTag
-
using
adm::Width = typedef detail::NamedType<float, WidthTag>
NamedType for width parameter.
-
using
adm::Height = typedef detail::NamedType<float, HeightTag>
NamedType for height parameter.
-
using
adm::Depth = typedef detail::NamedType<float, DepthTag>
NamedType for depth parameter.
-
class
ScreenEdgeLock
¶ ADM parameter class to specify a screen edge lock.
Public Types
-
typedef ScreenEdgeLockTag
tag
¶
Public Functions
-
template <typename... Parameters>
ScreenEdgeLock
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(ScreenEdge screenEdge)¶ ScreenEdge setter.
-
void
set
(HorizontalEdge horizontalEdge)¶ HorizontalEdge setter.
-
void
set
(VerticalEdge verticalEdge)¶ VerticalEdge setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef ScreenEdgeLockTag
-
using
adm::ScreenEdge = typedef detail::NamedType<std::string, ScreenEdgeTag, detail::ScreenEdgeValidator>
NamedType for the screen edge.
Valid values are “left”, “right”, “top” and “bottom”
-
using
adm::HorizontalEdge = typedef detail::NamedType<std::string, HorizontalEdgeTag, detail::HorizontalEdgeValidator>
NamedType for the horizontal screen edge.
Valid values are “left” and “right”
-
using
adm::VerticalEdge = typedef detail::NamedType<std::string, VerticalEdgeTag, detail::VerticalEdgeValidator>
NamedType for the vertical screen edge.
Valid values are “top” and “bottom”
-
using
adm::Gain = typedef detail::NamedType<float, GainTag>
NamedType for gain parameter.
-
using
adm::Diffuse = typedef detail::NamedType<float, DiffuseTag, detail::RangeValidator<0, 1>>
NamedType for diffuse parameter.
-
class
ChannelLock
¶ ADM parameter class to specify a channel lock.
Public Types
-
typedef ChannelLockTag
tag
¶
Public Functions
-
template <typename... Parameters>
ChannelLock
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(ChannelLockFlag channelLockFlag)¶ ChannelLockFlag setter.
-
void
set
(MaxDistance maxDistance)¶ MaxDistance setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef ChannelLockTag
-
using
adm::ChannelLockFlag = typedef detail::NamedType<bool, ChannelLockFlagTag>
NamedType for channelLockFlag parameter.
-
using
adm::MaxDistance = typedef detail::NamedType<float, MaxDistanceTag, detail::RangeValidator<0, 2>>
NamedType for the maxDistance attribute.
Valid values are in the range [0, 2].
-
class
ObjectDivergence
¶ ADM parameter class to specify the object divergence.
Public Types
-
typedef ObjectDivergenceTag
tag
¶
Public Functions
-
template <typename... Parameters>
ObjectDivergence
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(Divergence divergence)¶ Divergence setter.
-
void
set
(AzimuthRange azimuthRange)¶ AzimuthRange setter.
-
void
set
(PositionRange positionRange)¶ PositionRange setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef ObjectDivergenceTag
-
class
JumpPosition
¶ ADM parameter class to specify a jump position.
Public Types
-
typedef JumpPositionTag
tag
¶
Public Functions
-
template <typename... Parameters>
JumpPosition
(Parameters... optionalNamedArgs)¶ Constructor template.
Templated constructor which accepts a variable number of ADM parameters in random order after the mandatory ADM parameters.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(JumpPositionFlag objectDivergenceFlag)¶ JumpPositionFlag setter.
-
void
set
(InterpolationLength interpolationLength)¶ InterpolationLength setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
void
print
(std::ostream &os) const¶ Print overview to ostream.
-
typedef JumpPositionTag
-
using
adm::JumpPositionFlag = typedef detail::NamedType<bool, JumpPositionFlagTag>
NamedType for jumpPositionFlag parameter.
-
using
adm::InterpolationLength = typedef detail::NamedType<std::chrono::nanoseconds, interpolationLengthTag>
NamedType for interpolationLength parameter.
-
using
adm::ScreenRef = typedef detail::NamedType<bool, ScreenRefTag>
NamedType for screenref parameter.
-
class
AudioBlockFormatHoa
¶ Class representation for ADM element audioBlockFormat if audioChannelFormat.typeDefinition == “HOA”.
- Warning
- This class has unsupported parameters
- Equation
- Order
- Degree
- Normalization
- NfcRefDist
- ScreenRef
Public Types
-
typedef AudioBlockFormatHoaTag
tag
¶
-
typedef AudioBlockFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
template <typename... Parameters>
AudioBlockFormatHoa
(Parameters... optionalNamedArgs)¶
-
AudioBlockFormatHoa
(const AudioBlockFormatHoa&)¶
-
AudioBlockFormatHoa
(AudioBlockFormatHoa&&)¶
-
AudioBlockFormatHoa &
operator=
(const AudioBlockFormatHoa&)¶
-
AudioBlockFormatHoa &
operator=
(AudioBlockFormatHoa&&)¶
-
std::shared_ptr<AudioBlockFormatHoa>
copy
() const¶ Copy AudioBlockFormatHoa.
The actual copy constructor is private to ensure that an AudioBlockFormatHoa can only be created as a
std::shared_ptr
.
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
bool
isDefault
(detail::ParameterTraits<Rtime>::tag) const¶
-
void
set
(AudioBlockFormatId id)¶ AudioBlockFormatId setter.
-
void
set
(Rtime rtime)¶ Rtime setter.
-
void
set
(Duration duration)¶ Duration setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
class
AudioBlockFormatBinaural
¶ Class representation for ADM element audioBlockFormat if audioChannelFormat.typeDefinition == “Binaural”.
Public Types
-
typedef AudioBlockFormatBinauralTag
tag
¶
-
typedef AudioBlockFormatId
id_type
¶ Type that holds the id for this element;.
Public Functions
-
template <typename... Parameters>
AudioBlockFormatBinaural
(Parameters... optionalNamedArgs)¶
-
AudioBlockFormatBinaural
(const AudioBlockFormatBinaural&)¶
-
AudioBlockFormatBinaural
(AudioBlockFormatBinaural&&)¶
-
AudioBlockFormatBinaural &
operator=
(const AudioBlockFormatBinaural&)¶
-
AudioBlockFormatBinaural &
operator=
(AudioBlockFormatBinaural&&)¶
-
template <typename Parameter>
Parameterget
() const¶ ADM parameter getter template.
Templated getter with the wanted ADM parameter type as template argument. If currently no value is available trying to get the adm parameter will result in an exception. Check with the has method before
-
template <typename Parameter>
boolhas
() const¶ ADM parameter has template.
Templated has method with the ADM parameter type as template argument. Returns true if the ADM parameter is set or has a default value.
-
template <typename Parameter>
boolisDefault
() const¶ ADM parameter isDefault template.
Templated isDefault method with the ADM parameter type as template argument. Returns true if the ADM parameter is the default value.
-
void
set
(AudioBlockFormatId id)¶ AudioBlockFormatId setter.
-
void
set
(Rtime rtime)¶ Rtime setter.
-
void
set
(Duration duration)¶ Duration setter.
-
template <typename Parameter>
voidunset
()¶ ADM parameter unset template.
Templated unset method with the ADM parameter type as template argument. Removes an ADM parameter if it is optional or resets it to the default value if there is one.
-
typedef AudioBlockFormatBinauralTag