#include <libmpd++/RepresentationBase.hh>

Inheritance diagram for com::bbc::libmpdpp::RepresentationBase:

[legend]

Public Types
enum	VideoScan { VIDEO_SCAN_PROGRESSIVE , VIDEO_SCAN_INTERLACED , VIDEO_SCAN_UNKNOWN }

Public Member Functions
	RepresentationBase ()

	RepresentationBase (const RepresentationBase &to_copy)

	RepresentationBase (RepresentationBase &&to_move)

virtual	~RepresentationBase ()

RepresentationBase &	operator= (const RepresentationBase &to_copy)

RepresentationBase &	operator= (RepresentationBase &&to_move)

bool	operator== (const RepresentationBase &to_compare) const

const std::list< URI > &	profiles () const

const URI &	profile (std::list< URI >::size_type idx) const

RepresentationBase &	profilesRemove (const URI &val)

bool	hasWidth () const

const std::optional< unsigned int > &	width () const

RepresentationBase &	width (const std::nullopt_t &)

RepresentationBase &	width (unsigned int val)

bool	hasHeight () const

const std::optional< unsigned int > &	height () const

RepresentationBase &	height (const std::nullopt_t &)

bool	hasSar () const

const std::optional< Ratio > &	sar () const

RepresentationBase &	sar (const std::nullopt_t &)

bool	hasFrameRate () const

const std::optional< FrameRate > &	frameRate () const

RepresentationBase &	frameRate (const std::nullopt_t &)

RepresentationBase &	frameRate (FrameRate::size_type numerator, FrameRate::size_type denominator=1)

const std::list< unsigned int > &	audioSamplingRates () const

unsigned int	audioSamplingRate (std::list< unsigned int >::size_type idx) const

RepresentationBase &	audioSamplingRatesAdd (unsigned int val)

RepresentationBase &	audioSamplingRatesRemove (unsigned int val)

bool	hasMimeType () const

const std::optional< std::string > &	mimeType () const

RepresentationBase &	mimeType (const std::nullopt_t &)

const std::list< std::string > &	segmentProfiles () const

const std::string &	segmentProfile (std::list< std::string >::size_type idx) const

RepresentationBase &	segmentProfilesRemove (const std::string &val)

bool	hasCodecs () const

const std::optional< Codecs > &	codecs () const

RepresentationBase &	codecs (const std::nullopt_t &)

const std::list< std::string > &	containerProfiles () const

const std::string &	containerProfile (std::list< std::string >::size_type idx) const

RepresentationBase &	containerProfilesRemove (const std::string &val)

bool	hasMaximumSAPPeriod () const

const std::optional< double > &	maximumSAPPeriod () const

RepresentationBase &	maximumSAPPeriod (const std::nullopt_t &)

bool	hasStartWithSAP () const

const std::optional< SAP > &	startWithSAP () const

RepresentationBase &	startWithSAP (const std::nullopt_t &)

bool	hasMaxPlayoutRate () const

const std::optional< double > &	maxPlayoutRate () const

RepresentationBase &	maxPlayoutRate (const std::nullopt_t &)

bool	hasCodingDependency () const

const std::optional< bool > &	codingDependency () const

RepresentationBase &	codingDependency (const std::nullopt_t &)

bool	hasScanType () const

const std::optional< VideoScan > &	scanType () const

RepresentationBase &	scanType (const std::nullopt_t &)

unsigned int	selectionPriority () const

RepresentationBase &	selectionPriority (unsigned int val)

bool	hasTag () const

const std::optional< std::string > &	tag () const

RepresentationBase &	tag (const std::nullopt_t &)

const std::list< Descriptor > &	framePackings () const

const Descriptor &	framePacking (std::list< Descriptor >::size_type idx) const

RepresentationBase &	framePackingsRemove (const Descriptor &val)

const std::list< Descriptor > &	audioChannelConfigurations () const

const Descriptor &	audioChannelConfiguration (std::list< Descriptor >::size_type idx) const

RepresentationBase &	audioChannelConfigurationsRemove (const Descriptor &val)

const std::list< ContentProtection > &	contentProtections () const

const ContentProtection &	contentProtection (std::list< ContentProtection >::size_type idx) const

RepresentationBase &	contentProtectionsRemove (const ContentProtection &val)

bool	hasOutputProtection () const

const std::optional< Descriptor > &	outputProtection () const

RepresentationBase &	outputProtection (const std::nullopt_t &)

const std::list< Descriptor > &	essentialProperties () const

const Descriptor &	essentialProperty (std::list< Descriptor >::size_type idx) const

RepresentationBase &	essentialPropertiesRemove (const Descriptor &val)

const std::list< Descriptor > &	supplementalProperties () const

const Descriptor &	supplementalProperty (std::list< Descriptor >::size_type idx) const

RepresentationBase &	supplementalPropertiesRemove (const Descriptor &val)

const std::list< EventStream > &	inbandEventStreams () const

const EventStream &	inbandEventStream (std::list< EventStream >::size_type idx) const

RepresentationBase &	inbandEventStreamsRemove (const EventStream &val)

const std::list< Switching > &	switchings () const

const Switching &	switching (std::list< Switching >::size_type idx) const

RepresentationBase &	switchingsRemove (const Switching &val)

const std::list< RandomAccess > &	randomAccesses () const

const RandomAccess &	randomAccess (std::list< RandomAccess >::size_type idx) const

RepresentationBase &	randomAccessesRemove (const RandomAccess &val)

const std::list< Label > &	groupLabels () const

const Label &	groupLabel (std::list< Label >::size_type idx) const

RepresentationBase &	groupLabelsRemove (const Label &val)

const std::list< Label > &	labels () const

const Label &	label (std::list< Label >::size_type idx) const

RepresentationBase &	labelsRemove (const Label &val)

const std::list< ProducerReferenceTime > &	producerReferenceTimes () const

const ProducerReferenceTime &	producerReferenceTime (std::list< ProducerReferenceTime >::size_type idx) const

RepresentationBase &	producerReferenceTimesRemove (const ProducerReferenceTime &val)

const std::list< ContentPopularityRate > &	contentPopularityRates () const

const ContentPopularityRate &	contentPopularityRate (std::list< ContentPopularityRate >::size_type idx) const

RepresentationBase &	contentPopularityRatesRemove (const ContentPopularityRate &val)

const std::list< Resync > &	resyncs () const

const Resync &	resync (std::list< Resync >::size_type idx) const

RepresentationBase &	resyncsRemove (const Resync &val)


std::list< URI >::const_iterator	profilesBegin () const

std::list< URI >::iterator	profilesBegin ()


std::list< URI >::const_iterator	profilesEnd () const

std::list< URI >::iterator	profilesEnd ()


RepresentationBase &	profiles (const std::list< URI > &_profiles)

RepresentationBase &	profiles (std::list< URI > &&_profiles)


RepresentationBase &	profilesAdd (const URI &val)

RepresentationBase &	profilesAdd (URI &&val)


RepresentationBase &	profilesRemove (const std::list< URI >::const_iterator &it)

RepresentationBase &	profilesRemove (const std::list< URI >::iterator &it)


RepresentationBase &	height (unsigned int val)

RepresentationBase &	height (const std::optional< unsigned int > &val)

RepresentationBase &	height (std::optional< unsigned int > &&val)


RepresentationBase &	sar (const Ratio &val)

RepresentationBase &	sar (Ratio &&val)

RepresentationBase &	sar (const std::optional< Ratio > &val)

RepresentationBase &	sar (std::optional< Ratio > &&val)


RepresentationBase &	frameRate (const FrameRate &val)

RepresentationBase &	frameRate (FrameRate &&val)

RepresentationBase &	frameRate (const std::optional< FrameRate > &val)

RepresentationBase &	frameRate (std::optional< FrameRate > &&val)


std::list< unsignedint >::const_iterator	audioSamplingRatesBegin () const

std::list< unsignedint >::iterator	audioSamplingRatesBegin ()


std::list< unsignedint >::const_iterator	audioSamplingRatesEnd () const

std::list< unsignedint >::iterator	audioSamplingRatesEnd ()


RepresentationBase &	audioSamplingRates (const std::list< unsigned int > &rates)

RepresentationBase &	audioSamplingRates (std::list< unsigned int > &&rates)


RepresentationBase &	audioSamplingRatesRemove (const std::list< unsigned int >::const_iterator &it)

RepresentationBase &	audioSamplingRatesRemove (const std::list< unsigned int >::iterator &it)


RepresentationBase &	mimeType (const std::string &val)

RepresentationBase &	mimeType (std::string &&val)

RepresentationBase &	mimeType (const std::optional< std::string > &val)

RepresentationBase &	mimeType (std::optional< std::string > &&val)


RepresentationBase &	segmentProfiles (const std::list< std::string > &profiles)

RepresentationBase &	segmentProfiles (std::list< std::string > &&profiles)


std::list< std::string >::const_iterator	segmentProfilesBegin () const

std::list< std::string >::iterator	segmentProfilesBegin ()


std::list< std::string >::const_iterator	segmentProfilesEnd () const

std::list< std::string >::iterator	segmentProfilesEnd ()


RepresentationBase &	segmentProfilesAdd (const std::string &val)

RepresentationBase &	segmentProfilesAdd (std::string &&val)


RepresentationBase &	segmentProfilesRemove (const std::list< std::string >::const_iterator &it)

RepresentationBase &	segmentProfilesRemove (const std::list< std::string >::iterator &it)


RepresentationBase &	codecs (const Codecs &val)

RepresentationBase &	codecs (Codecs &&val)

RepresentationBase &	codecs (const std::optional< Codecs > &val)

RepresentationBase &	codecs (std::optional< Codecs > &&val)


RepresentationBase &	containerProfiles (const std::list< std::string > &profiles)

RepresentationBase &	containerProfiles (std::list< std::string > &&profiles)


std::list< std::string >::const_iterator	containerProfilesBegin () const

std::list< std::string >::iterator	containerProfilesBegin ()


std::list< std::string >::const_iterator	containerProfilesEnd () const

std::list< std::string >::iterator	containerProfilesEnd ()


RepresentationBase &	containerProfilesAdd (const std::string &val)

RepresentationBase &	containerProfilesAdd (std::string &&val)


RepresentationBase &	containerProfilesRemove (const std::list< std::string >::const_iterator &it)

RepresentationBase &	containerProfilesRemove (const std::list< std::string >::iterator &it)


RepresentationBase &	maximumSAPPeriod (double val)

RepresentationBase &	maximumSAPPeriod (const std::optional< double > &val)

RepresentationBase &	maximumSAPPeriod (std::optional< double > &&val)


RepresentationBase &	startWithSAP (const SAP &val)

RepresentationBase &	startWithSAP (SAP &&val)

RepresentationBase &	startWithSAP (const std::optional< SAP > &val)

RepresentationBase &	startWithSAP (std::optional< SAP > &&val)


RepresentationBase &	maxPlayoutRate (double val)

RepresentationBase &	maxPlayoutRate (const std::optional< double > &val)

RepresentationBase &	maxPlayoutRate (std::optional< double > &&val)


RepresentationBase &	codingDependency (bool val)

RepresentationBase &	codingDependency (const std::optional< bool > &val)

RepresentationBase &	codingDependency (std::optional< bool > &&val)


RepresentationBase &	scanType (const VideoScan &val)

RepresentationBase &	scanType (VideoScan &&val)

RepresentationBase &	scanType (const std::optional< VideoScan > &val)

RepresentationBase &	scanType (std::optional< VideoScan > &&val)


RepresentationBase &	tag (const std::string &val)

RepresentationBase &	tag (std::string &&val)

RepresentationBase &	tag (const std::optional< std::string > &val)

RepresentationBase &	tag (std::optional< std::string > &&val)


RepresentationBase &	framePackings (const std::list< Descriptor > &packings)

RepresentationBase &	framePackings (std::list< Descriptor > &&packings)


std::list< Descriptor >::const_iterator	framePackingsBegin () const

std::list< Descriptor >::iterator	framePackingsBegin ()


std::list< Descriptor >::const_iterator	framePackingsEnd () const

std::list< Descriptor >::iterator	framePackingsEnd ()


RepresentationBase &	framePackingsAdd (const Descriptor &val)

RepresentationBase &	framePackingsAdd (Descriptor &&val)


RepresentationBase &	framePackingsRemove (const std::list< Descriptor >::const_iterator &it)

RepresentationBase &	framePackingsRemove (const std::list< Descriptor >::iterator &it)


RepresentationBase &	audioChannelConfigurations (const std::list< Descriptor > &packings)

RepresentationBase &	audioChannelConfigurations (std::list< Descriptor > &&packings)


std::list< Descriptor >::const_iterator	audioChannelConfigurationsBegin () const

std::list< Descriptor >::iterator	audioChannelConfigurationsBegin ()


std::list< Descriptor >::const_iterator	audioChannelConfigurationsEnd () const

std::list< Descriptor >::iterator	audioChannelConfigurationsEnd ()


RepresentationBase &	audioChannelConfigurationsAdd (const Descriptor &val)

RepresentationBase &	audioChannelConfigurationsAdd (Descriptor &&val)


RepresentationBase &	audioChannelConfigurationsRemove (const std::list< Descriptor >::const_iterator &it)

RepresentationBase &	audioChannelConfigurationsRemove (const std::list< Descriptor >::iterator &it)


RepresentationBase &	contentProtections (const std::list< ContentProtection > &protections)

RepresentationBase &	contentProtections (std::list< ContentProtection > &&protections)


std::list< ContentProtection >::const_iterator	contentProtectionsBegin () const

std::list< ContentProtection >::iterator	contentProtectionsBegin ()


std::list< ContentProtection >::const_iterator	contentProtectionsEnd () const

std::list< ContentProtection >::iterator	contentProtectionsEnd ()


RepresentationBase &	contentProtectionsAdd (const ContentProtection &val)

RepresentationBase &	contentProtectionsAdd (ContentProtection &&val)


RepresentationBase &	contentProtectionsRemove (const std::list< ContentProtection >::const_iterator &it)

RepresentationBase &	contentProtectionsRemove (const std::list< ContentProtection >::iterator &it)


RepresentationBase &	outputProtection (const Descriptor &val)

RepresentationBase &	outputProtection (Descriptor &&val)

RepresentationBase &	outputProtection (const std::optional< Descriptor > &val)

RepresentationBase &	outputProtection (std::optional< Descriptor > &&val)


RepresentationBase &	essentialProperties (const std::list< Descriptor > &properties)

RepresentationBase &	essentialProperties (std::list< Descriptor > &&properties)


std::list< Descriptor >::const_iterator	essentialPropertiesBegin () const

std::list< Descriptor >::iterator	essentialPropertiesBegin ()


std::list< Descriptor >::const_iterator	essentialPropertiesEnd () const

std::list< Descriptor >::iterator	essentialPropertiesEnd ()


RepresentationBase &	essentialPropertiesAdd (const Descriptor &val)

RepresentationBase &	essentialPropertiesAdd (Descriptor &&val)


RepresentationBase &	essentialPropertiesRemove (const std::list< Descriptor >::const_iterator &it)

RepresentationBase &	essentialPropertiesRemove (const std::list< Descriptor >::iterator &it)


RepresentationBase &	supplementalProperties (const std::list< Descriptor > &properties)

RepresentationBase &	supplementalProperties (std::list< Descriptor > &&properties)


std::list< Descriptor >::const_iterator	supplementalPropertiesBegin () const

std::list< Descriptor >::iterator	supplementalPropertiesBegin ()


std::list< Descriptor >::const_iterator	supplementalPropertiesEnd () const

std::list< Descriptor >::iterator	supplementalPropertiesEnd ()


RepresentationBase &	supplementalPropertiesAdd (const Descriptor &val)

RepresentationBase &	supplementalPropertiesAdd (Descriptor &&val)


RepresentationBase &	supplementalPropertiesRemove (const std::list< Descriptor >::const_iterator &it)

RepresentationBase &	supplementalPropertiesRemove (const std::list< Descriptor >::iterator &it)


RepresentationBase &	inbandEventStreams (const std::list< EventStream > &streams)

RepresentationBase &	inbandEventStreams (std::list< EventStream > &&streams)


std::list< EventStream >::const_iterator	inbandEventStreamsBegin () const

std::list< EventStream >::iterator	inbandEventStreamsBegin ()


std::list< EventStream >::const_iterator	inbandEventStreamsEnd () const

std::list< EventStream >::iterator	inbandEventStreamsEnd ()


RepresentationBase &	inbandEventStreamsAdd (const EventStream &val)

RepresentationBase &	inbandEventStreamsAdd (EventStream &&val)


RepresentationBase &	inbandEventStreamsRemove (const std::list< EventStream >::const_iterator &it)

RepresentationBase &	inbandEventStreamsRemove (const std::list< EventStream >::iterator &it)


RepresentationBase &	switchings (const std::list< Switching > &_switchings)

RepresentationBase &	switchings (std::list< Switching > &&_switchings)


std::list< Switching >::const_iterator	switchingsBegin () const

std::list< Switching >::iterator	switchingsBegin ()


std::list< Switching >::const_iterator	switchingsEnd () const

std::list< Switching >::iterator	switchingsEnd ()


RepresentationBase &	switchingsAdd (const Switching &val)

RepresentationBase &	switchingsAdd (Switching &&val)


RepresentationBase &	switchingsRemove (const std::list< Switching >::const_iterator &it)

RepresentationBase &	switchingsRemove (const std::list< Switching >::iterator &it)


RepresentationBase &	randomAccesses (const std::list< RandomAccess > &accesses)

RepresentationBase &	randomAccesses (std::list< RandomAccess > &&accesses)


std::list< RandomAccess >::const_iterator	randomAccessesBegin () const

std::list< RandomAccess >::iterator	randomAccessesBegin ()


std::list< RandomAccess >::const_iterator	randomAccessesEnd () const

std::list< RandomAccess >::iterator	randomAccessesEnd ()


RepresentationBase &	randomAccessesAdd (const RandomAccess &val)

RepresentationBase &	randomAccessesAdd (RandomAccess &&val)


RepresentationBase &	randomAccessesRemove (const std::list< RandomAccess >::const_iterator &it)

RepresentationBase &	randomAccessesRemove (const std::list< RandomAccess >::iterator &it)


RepresentationBase &	groupLabels (const std::list< Label > &labels)

RepresentationBase &	groupLabels (std::list< Label > &&labels)


std::list< Label >::const_iterator	groupLabelsBegin () const

std::list< Label >::iterator	groupLabelsBegin ()


std::list< Label >::const_iterator	groupLabelsEnd () const

std::list< Label >::iterator	groupLabelsEnd ()


RepresentationBase &	groupLabelsAdd (const Label &val)

RepresentationBase &	groupLabelsAdd (Label &&val)


RepresentationBase &	groupLabelsRemove (const std::list< Label >::const_iterator &it)

RepresentationBase &	groupLabelsRemove (const std::list< Label >::iterator &it)


RepresentationBase &	labels (const std::list< Label > &_labels)

RepresentationBase &	labels (std::list< Label > &&_labels)


std::list< Label >::const_iterator	labelsBegin () const

std::list< Label >::iterator	labelsBegin ()


std::list< Label >::const_iterator	labelsEnd () const

std::list< Label >::iterator	labelsEnd ()


RepresentationBase &	labelsAdd (const Label &val)

RepresentationBase &	labelsAdd (Label &&val)


RepresentationBase &	labelsRemove (const std::list< Label >::const_iterator &it)

RepresentationBase &	labelsRemove (const std::list< Label >::iterator &it)


RepresentationBase &	producerReferenceTimes (const std::list< ProducerReferenceTime > &times)

RepresentationBase &	producerReferenceTimes (std::list< ProducerReferenceTime > &&times)


std::list< ProducerReferenceTime >::const_iterator	producerReferenceTimesBegin () const

std::list< ProducerReferenceTime >::iterator	producerReferenceTimesBegin ()


std::list< ProducerReferenceTime >::const_iterator	producerReferenceTimesEnd () const

std::list< ProducerReferenceTime >::iterator	producerReferenceTimesEnd ()


RepresentationBase &	producerReferenceTimesAdd (const ProducerReferenceTime &val)

RepresentationBase &	producerReferenceTimesAdd (ProducerReferenceTime &&val)


RepresentationBase &	producerReferenceTimesRemove (const std::list< ProducerReferenceTime >::const_iterator &it)

RepresentationBase &	producerReferenceTimesRemove (const std::list< ProducerReferenceTime >::iterator &it)


RepresentationBase &	contentPopularityRates (const std::list< ContentPopularityRate > &rates)

RepresentationBase &	contentPopularityRates (std::list< ContentPopularityRate > &&rates)


std::list< ContentPopularityRate >::const_iterator	contentPopularityRatesBegin () const

std::list< ContentPopularityRate >::iterator	contentPopularityRatesBegin ()


std::list< ContentPopularityRate >::const_iterator	contentPopularityRatesEnd () const

std::list< ContentPopularityRate >::iterator	contentPopularityRatesEnd ()


RepresentationBase &	contentPopularityRatesAdd (const ContentPopularityRate &val)

RepresentationBase &	contentPopularityRatesAdd (ContentPopularityRate &&val)


RepresentationBase &	contentPopularityRatesRemove (const std::list< ContentPopularityRate >::const_iterator &it)

RepresentationBase &	contentPopularityRatesRemove (const std::list< ContentPopularityRate >::iterator &it)


RepresentationBase &	resyncs (const std::list< Resync > &_resyncs)

RepresentationBase &	resyncs (std::list< Resync > &&_resyncs)


std::list< Resync >::const_iterator	resyncsBegin () const

std::list< Resync >::iterator	resyncsBegin ()


std::list< Resync >::const_iterator	resyncsEnd () const

std::list< Resync >::iterator	resyncsEnd ()


RepresentationBase &	resyncsAdd (const Resync &val)

RepresentationBase &	resyncsAdd (Resync &&val)


RepresentationBase &	resyncsRemove (const std::list< Resync >::const_iterator &it)

RepresentationBase &	resyncsRemove (const std::list< Resync >::iterator &it)

Detailed Description

RepresentationBase class

This is a container for the common attributes and elements for AdaptationSet and Representation as described in ISO 23009-1:2022.

The DASH MPD XML schema definition for RepresentationBaseType can be found in ISO 23009-1:2022 Clause 5.3.7.3.

Member Enumeration Documentation

◆ VideoScan

enum com::bbc::libmpdpp::RepresentationBase::VideoScan

Enumeration for implemented VideoScan values

Enumerator
VIDEO_SCAN_PROGRESSIVE	Video scan value is "progressive".
VIDEO_SCAN_INTERLACED	Video scan value is "interlaced".
VIDEO_SCAN_UNKNOWN	Video scan value is unknown (i.e. not one of the other values)

Constructor & Destructor Documentation

◆ RepresentationBase() [1/3]

com::bbc::libmpdpp::RepresentationBase::RepresentationBase ( )

Default constructor

Creates an empty RepresentationBase.

◆ RepresentationBase() [2/3]

com::bbc::libmpdpp::RepresentationBase::RepresentationBase ( const RepresentationBase & to_copy )

Copy constructor

Creates a new RepresentationBase which is a copy of to_copy.

Parameters

to_copy The RepresentationBase to copy.

◆ RepresentationBase() [3/3]

com::bbc::libmpdpp::RepresentationBase::RepresentationBase ( RepresentationBase && to_move )

Move constructor

Creates a new RepresentationBase which is a transfer of the resources and values from to_move.

Parameters

to_move The RepresentationBase to move into this new RepresentationBase.

◆ ~RepresentationBase()

virtual com::bbc::libmpdpp::RepresentationBase::~RepresentationBase ( )

inlinevirtual

Destructor

Member Function Documentation

◆ audioChannelConfiguration()

const Descriptor & com::bbc::libmpdpp::RepresentationBase::audioChannelConfiguration ( std::list< Descriptor >::size_type idx ) const

Get the audio channel configuration descriptor at an index in the list

This will return the audio channel configuration descriptor at the index given in idx (starting at 0). If idx falls outside the audio channel configurations list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of audio channel configurations.

Returns: The audio channel configuration descriptor at list index idx.

Exceptions

std::out_of_range If idx lies outside of the audio channel configurations list.

◆ audioChannelConfigurations() [1/3]

const std::list< Descriptor > & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurations ( ) const

inline

Get the audio channel configurations list

Returns: The audio channel configurations list.

◆ audioChannelConfigurations() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurations ( const std::list< Descriptor > & packings )

inline

Set the audio channel configurations list

Parameters

packings The list of audio channel configurations to set as the audio channel configurations list.

Returns: This RepresentationBase.

◆ audioChannelConfigurations() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurations ( std::list< Descriptor > && packings )

inline

Set the audio channel configurations list

Parameters

packings The list of audio channel configurations to set as the audio channel configurations list.

Returns: This RepresentationBase.

◆ audioChannelConfigurationsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsAdd ( const Descriptor & val )

inline

Add an entry to the audio channel configurations list

Parameters

val	The audio channel configuration descriptor to add to the audio channel configurations list.

Returns: This RepresentationBase.

◆ audioChannelConfigurationsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsAdd ( Descriptor && val )

inline

Add an entry to the audio channel configurations list

Parameters

val	The audio channel configuration descriptor to add to the audio channel configurations list.

Returns: This RepresentationBase.

◆ audioChannelConfigurationsBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsBegin ( )

inline

Get an iterator referencing the start of the audio channel configurations list

Returns: An iterator referencing the start of the audio channel configurations list.

◆ audioChannelConfigurationsBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsBegin ( ) const

inline

Get an iterator referencing the start of the audio channel configurations list

Returns: An iterator referencing the start of the audio channel configurations list.

◆ audioChannelConfigurationsEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsEnd ( )

inline

Get an iterator referencing the end of the audio channel configurations list

Returns: An iterator referencing the end of the audio channel configurations list.

◆ audioChannelConfigurationsEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsEnd ( ) const

inline

Get an iterator referencing the end of the audio channel configurations list

Returns: An iterator referencing the end of the audio channel configurations list.

◆ audioChannelConfigurationsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsRemove ( const Descriptor & val )

Remove an entry to the audio channel configurations list by value

Parameters

val	The audio channel configuration descriptor to remove from the audio channel configurations list.

Returns: This RepresentationBase.

◆ audioChannelConfigurationsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsRemove ( const std::list< Descriptor >::const_iterator & it )

Remove an entry to the audio channel configurations list by iterator

Parameters

it	An iterator referencing an entry from the audio channel configurations list.

Returns: This RepresentationBase.

◆ audioChannelConfigurationsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioChannelConfigurationsRemove ( const std::list< Descriptor >::iterator & it )

Remove an entry to the audio channel configurations list by iterator

Parameters

it	An iterator referencing an entry from the audio channel configurations list.

Returns: This RepresentationBase.

◆ audioSamplingRate()

unsigned int com::bbc::libmpdpp::RepresentationBase::audioSamplingRate ( std::list< unsigned int >::size_type idx ) const

Get an @pudioSamplingRate attribute value from the list of @pudioSamplingRate attribute values

Parameters

idx	The index, starting from 0, of the entry in the @pudioSamplingRate attribute values list to retrieve.

Returns: The audio sampling rate from index idx is the list of @pudioSamplingRate attribute values.

Exceptions

std::out_of_range If the idx index value lies outside the list of @pudioSamplingRate attribute values.

◆ audioSamplingRates() [1/3]

const std::list< unsigned int > & com::bbc::libmpdpp::RepresentationBase::audioSamplingRates ( ) const

inline

Get the @pudioSamplingRate attribute list

Returns: The @pudioSamplingRate attribute value list.

◆ audioSamplingRates() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioSamplingRates ( const std::list< unsigned int > & rates )

inline

Set the audio sampling rate list

Parameters

rates The list of audio sample rates to set the @pudioSamplingRate attribute to.

Returns: This RepresentationBase.

◆ audioSamplingRates() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioSamplingRates ( std::list< unsigned int > && rates )

inline

Set the audio sampling rate list

Parameters

rates The list of audio sample rates to set the @pudioSamplingRate attribute to.

Returns: This RepresentationBase.

◆ audioSamplingRatesAdd()

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesAdd ( unsigned int val )

inline

Add an @pudioSamplingRate entry

Parameters

val	The @pudioSamplingRate value to add to the list.

Returns: This RepresentationBase.

◆ audioSamplingRatesBegin() [1/2]

std::list< unsignedint >::iterator com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesBegin ( )

inline

Get an iterator for the start of the @pudioSamplingRate attribute value list

Returns: An iterator at the start of the @pudioSamplingRate attribute value list.

◆ audioSamplingRatesBegin() [2/2]

std::list< unsignedint >::const_iterator com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesBegin ( ) const

inline

Get an iterator for the start of the @pudioSamplingRate attribute value list

Returns: An iterator at the start of the @pudioSamplingRate attribute value list.

◆ audioSamplingRatesEnd() [1/2]

std::list< unsignedint >::iterator com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesEnd ( )

inline

Get an iterator for the end of the @pudioSamplingRate attribute value list

Returns: An iterator at the end of the @pudioSamplingRate attribute value list.

◆ audioSamplingRatesEnd() [2/2]

std::list< unsignedint >::const_iterator com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesEnd ( ) const

inline

Get an iterator for the end of the @pudioSamplingRate attribute value list

Returns: An iterator at the end of the @pudioSamplingRate attribute value list.

◆ audioSamplingRatesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesRemove ( const std::list< unsigned int >::const_iterator & it )

Remove an @pudioSamplingRate entry from the list

Parameters

it	An iterator for an entry in the @pudioSamplingRate values list.

Returns: This RepresentationBase.

◆ audioSamplingRatesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesRemove ( const std::list< unsigned int >::iterator & it )

Remove an @pudioSamplingRate entry from the list

Parameters

it	An iterator for an entry in the @pudioSamplingRate values list.

Returns: This RepresentationBase.

◆ audioSamplingRatesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::audioSamplingRatesRemove ( unsigned int val )

Remove an @pudioSamplingRate value from the list

Parameters

val	The @pudioSamplingRate value to remove from the list.

Returns: This RepresentationBase.

◆ codecs() [1/6]

const std::optional< Codecs > & com::bbc::libmpdpp::RepresentationBase::codecs ( ) const

inline

Get the optional @codecs attribute value

Returns: The optional @codecs attribute value.

◆ codecs() [2/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codecs ( Codecs && val )

inline

Set the @codecs attribute value

Parameters

val	The value to set for the @codecs attribute

Returns: This RepresentationBase.

◆ codecs() [3/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codecs ( const Codecs & val )

inline

Set the @codecs attribute value

Parameters

val	The value to set for the @codecs attribute

Returns: This RepresentationBase.

◆ codecs() [4/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codecs ( const std::nullopt_t & )

inline

Unset the @codecs attribute value

Returns: This RepresentationBase.

◆ codecs() [5/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codecs ( const std::optional< Codecs > & val )

inline

Set the @codecs attribute value

Parameters

val	The value to set for the @codecs attribute

Returns: This RepresentationBase.

◆ codecs() [6/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codecs ( std::optional< Codecs > && val )

inline

Set the @codecs attribute value

Parameters

val	The value to set for the @codecs attribute

Returns: This RepresentationBase.

◆ codingDependency() [1/5]

const std::optional< bool > & com::bbc::libmpdpp::RepresentationBase::codingDependency ( ) const

inline

Get the optional @codingDependency attribute value

Returns: The optional @codingDependency attribute value.

◆ codingDependency() [2/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codingDependency ( bool val )

inline

Set the @codingDependency attribute value

Parameters

val	The value to set in the @codingDependency attribute.

Returns: This RepresentationBase.

◆ codingDependency() [3/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codingDependency ( const std::nullopt_t & )

inline

Unset the optional @codingDependency attribute value

Returns: This RepresentationBase.

◆ codingDependency() [4/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codingDependency ( const std::optional< bool > & val )

inline

Set the @codingDependency attribute value

Parameters

val	The value to set in the @codingDependency attribute.

Returns: This RepresentationBase.

◆ codingDependency() [5/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::codingDependency ( std::optional< bool > && val )

inline

Set the @codingDependency attribute value

Parameters

val	The value to set in the @codingDependency attribute.

Returns: This RepresentationBase.

◆ containerProfile()

const std::string & com::bbc::libmpdpp::RepresentationBase::containerProfile ( std::list< std::string >::size_type idx ) const

Get the container profile string at an index in the list

This will return the container profile string at the index given in idx (starting at 0). If idx fall outside the container profiles list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of container profiles.

Returns: The container profile string at list index idx.

Exceptions

std::out_of_range If idx lies outside of the container profiles list.

◆ containerProfiles() [1/3]

const std::list< std::string > & com::bbc::libmpdpp::RepresentationBase::containerProfiles ( ) const

inline

Get the container profiles list

Returns: The container profiles list.

◆ containerProfiles() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::containerProfiles ( const std::list< std::string > & profiles )

inline

Set the container profiles list

Parameters

profiles The list of profiles to set as container profiles.

Returns: This RepresentationBase.

◆ containerProfiles() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::containerProfiles ( std::list< std::string > && profiles )

inline

Set the container profiles list

Parameters

profiles The list of profiles to set as container profiles.

Returns: This RepresentationBase.

◆ containerProfilesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::containerProfilesAdd ( const std::string & val )

inline

Add an entry to the container profiles list

Parameters

val	The string value to add to the container profiles list.

Returns: This RepresentationBase.

◆ containerProfilesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::containerProfilesAdd ( std::string && val )

inline

Add an entry to the container profiles list

Parameters

val	The string value to add to the container profiles list.

Returns: This RepresentationBase.

◆ containerProfilesBegin() [1/2]

std::list< std::string >::iterator com::bbc::libmpdpp::RepresentationBase::containerProfilesBegin ( )

inline

Get an iterator referencing the start of the container profiles list

Returns: An iterator referencing the start of the container profiles list.

◆ containerProfilesBegin() [2/2]

std::list< std::string >::const_iterator com::bbc::libmpdpp::RepresentationBase::containerProfilesBegin ( ) const

inline

Get an iterator referencing the start of the container profiles list

Returns: An iterator referencing the start of the container profiles list.

◆ containerProfilesEnd() [1/2]

std::list< std::string >::iterator com::bbc::libmpdpp::RepresentationBase::containerProfilesEnd ( )

inline

Get an iterator referencing the end of the container profiles list

Returns: An iterator referencing the end of the container profiles list.

◆ containerProfilesEnd() [2/2]

std::list< std::string >::const_iterator com::bbc::libmpdpp::RepresentationBase::containerProfilesEnd ( ) const

inline

Get an iterator referencing the end of the container profiles list

Returns: An iterator referencing the end of the container profiles list.

◆ containerProfilesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::containerProfilesRemove ( const std::list< std::string >::const_iterator & it )

Remove an entry to the container profiles list by iterator

Parameters

it	An iterator referencing an entry from the container profiles list.

Returns: This RepresentationBase.

◆ containerProfilesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::containerProfilesRemove ( const std::list< std::string >::iterator & it )

Remove an entry to the container profiles list by iterator

Parameters

it	An iterator referencing an entry from the container profiles list.

Returns: This RepresentationBase.

◆ containerProfilesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::containerProfilesRemove ( const std::string & val )

Remove an entry to the container profiles list by value

Parameters

val	The string value to remove from the container profiles list.

Returns: This RepresentationBase.

◆ contentPopularityRate()

const ContentPopularityRate & com::bbc::libmpdpp::RepresentationBase::contentPopularityRate ( std::list< ContentPopularityRate >::size_type idx ) const

Get the content popularity rate at an index in the list

This will return the content popularity rate at the index given in idx (starting at 0). If idx falls outside the content popularity rates list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of content popularity rates.

Returns: The content popularity rate at list index idx.

Exceptions

std::out_of_range If idx lies outside of the content popularity rates list.

◆ contentPopularityRates() [1/3]

const std::list< ContentPopularityRate > & com::bbc::libmpdpp::RepresentationBase::contentPopularityRates ( ) const

inline

Get the content popularity rates list

Returns: The content popularity rates list.

◆ contentPopularityRates() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentPopularityRates ( const std::list< ContentPopularityRate > & rates )

inline

Set the content popularity rates list

Parameters

rates The list of content popularity rates to set as the content popularity rates list.

Returns: This RepresentationBase.

◆ contentPopularityRates() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentPopularityRates ( std::list< ContentPopularityRate > && rates )

inline

Set the content popularity rates list

Parameters

rates The list of content popularity rates to set as the content popularity rates list.

Returns: This RepresentationBase.

◆ contentPopularityRatesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesAdd ( const ContentPopularityRate & val )

inline

Add an entry to the content popularity rates list

Parameters

val	The content popularity rate to add to the content popularity rates list.

Returns: This RepresentationBase.

◆ contentPopularityRatesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesAdd ( ContentPopularityRate && val )

inline

Add an entry to the content popularity rates list

Parameters

val	The content popularity rate to add to the content popularity rates list.

Returns: This RepresentationBase.

◆ contentPopularityRatesBegin() [1/2]

std::list< ContentPopularityRate >::iterator com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesBegin ( )

inline

Get an iterator referencing the start of the content popularity rates list

Returns: An iterator referencing the start of the content popularity rates list.

◆ contentPopularityRatesBegin() [2/2]

std::list< ContentPopularityRate >::const_iterator com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesBegin ( ) const

inline

Get an iterator referencing the start of the content popularity rates list

Returns: An iterator referencing the start of the content popularity rates list.

◆ contentPopularityRatesEnd() [1/2]

std::list< ContentPopularityRate >::iterator com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesEnd ( )

inline

Get an iterator referencing the end of the content popularity rates list

Returns: An iterator referencing the end of the content popularity rates list.

◆ contentPopularityRatesEnd() [2/2]

std::list< ContentPopularityRate >::const_iterator com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesEnd ( ) const

inline

Get an iterator referencing the end of the content popularity rates list

Returns: An iterator referencing the end of the content popularity rates list.

◆ contentPopularityRatesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesRemove ( const ContentPopularityRate & val )

Remove an entry to the content popularity rates list by value

Parameters

val	The content popularity rate to remove from the content popularity rates list.

Returns: This RepresentationBase.

◆ contentPopularityRatesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesRemove ( const std::list< ContentPopularityRate >::const_iterator & it )

Remove an entry to the content popularity rates list by iterator

Parameters

it	An iterator referencing an entry from the content popularity rates list.

Returns: This RepresentationBase.

◆ contentPopularityRatesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentPopularityRatesRemove ( const std::list< ContentPopularityRate >::iterator & it )

Remove an entry to the content popularity rates list by iterator

Parameters

it	An iterator referencing an entry from the content popularity rates list.

Returns: This RepresentationBase.

◆ contentProtection()

const ContentProtection & com::bbc::libmpdpp::RepresentationBase::contentProtection ( std::list< ContentProtection >::size_type idx ) const

Get the content protection at an index in the list

This will return the content protection at the index given in idx (starting at 0). If idx falls outside the content protections list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of content protections.

Returns: The content protection at list index idx.

Exceptions

std::out_of_range If idx lies outside of the content protections list.

◆ contentProtections() [1/3]

const std::list< ContentProtection > & com::bbc::libmpdpp::RepresentationBase::contentProtections ( ) const

inline

Get the content protections list

Returns: The content protections list.

◆ contentProtections() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentProtections ( const std::list< ContentProtection > & protections )

inline

Set the content protections list

Parameters

protections The list of content protections to set as the content protections list.

Returns: This RepresentationBase.

◆ contentProtections() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentProtections ( std::list< ContentProtection > && protections )

inline

Set the content protections list

Parameters

protections The list of content protections to set as the content protections list.

Returns: This RepresentationBase.

◆ contentProtectionsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentProtectionsAdd ( const ContentProtection & val )

inline

Add an entry to the content protections list

Parameters

val	The content protection to add to the content protections list.

Returns: This RepresentationBase.

◆ contentProtectionsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentProtectionsAdd ( ContentProtection && val )

inline

Add an entry to the content protections list

Parameters

val	The content protection to add to the content protections list.

Returns: This RepresentationBase.

◆ contentProtectionsBegin() [1/2]

std::list< ContentProtection >::iterator com::bbc::libmpdpp::RepresentationBase::contentProtectionsBegin ( )

inline

Get an iterator referencing the start of the content protections list

Returns: An iterator referencing the start of the content protections list.

◆ contentProtectionsBegin() [2/2]

std::list< ContentProtection >::const_iterator com::bbc::libmpdpp::RepresentationBase::contentProtectionsBegin ( ) const

inline

Get an iterator referencing the start of the content protections list

Returns: An iterator referencing the start of the content protections list.

◆ contentProtectionsEnd() [1/2]

std::list< ContentProtection >::iterator com::bbc::libmpdpp::RepresentationBase::contentProtectionsEnd ( )

inline

Get an iterator referencing the end of the content protections list

Returns: An iterator referencing the end of the content protections list.

◆ contentProtectionsEnd() [2/2]

std::list< ContentProtection >::const_iterator com::bbc::libmpdpp::RepresentationBase::contentProtectionsEnd ( ) const

inline

Get an iterator referencing the end of the content protections list

Returns: An iterator referencing the end of the content protections list.

◆ contentProtectionsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentProtectionsRemove ( const ContentProtection & val )

Remove an entry to the content protections list by value

Parameters

val	The content protection to remove from the content protections list.

Returns: This RepresentationBase.

◆ contentProtectionsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentProtectionsRemove ( const std::list< ContentProtection >::const_iterator & it )

Remove an entry to the content protections list by iterator

Parameters

it	An iterator referencing an entry from the content protections list.

Returns: This RepresentationBase.

◆ contentProtectionsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::contentProtectionsRemove ( const std::list< ContentProtection >::iterator & it )

Remove an entry to the content protections list by iterator

Parameters

it	An iterator referencing an entry from the content protections list.

Returns: This RepresentationBase.

◆ essentialProperties() [1/3]

const std::list< Descriptor > & com::bbc::libmpdpp::RepresentationBase::essentialProperties ( ) const

inline

Get the essential properties list

Returns: The essential properties list.

◆ essentialProperties() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::essentialProperties ( const std::list< Descriptor > & properties )

inline

Set the essential properties list

Parameters

properties The list of essential properties to set as the essential properties list.

Returns: This RepresentationBase.

◆ essentialProperties() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::essentialProperties ( std::list< Descriptor > && properties )

inline

Set the essential properties list

Parameters

properties The list of essential properties to set as the essential properties list.

Returns: This RepresentationBase.

◆ essentialPropertiesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::essentialPropertiesAdd ( const Descriptor & val )

inline

Add an entry to the essential properties list

Parameters

val	The essential property descriptor to add to the essential properties list.

Returns: This RepresentationBase.

◆ essentialPropertiesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::essentialPropertiesAdd ( Descriptor && val )

inline

Add an entry to the essential properties list

Parameters

val	The essential property descriptor to add to the essential properties list.

Returns: This RepresentationBase.

◆ essentialPropertiesBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::essentialPropertiesBegin ( )

inline

Get an iterator referencing the start of the essential properties list

Returns: An iterator referencing the start of the essential properties list.

◆ essentialPropertiesBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::essentialPropertiesBegin ( ) const

inline

Get an iterator referencing the start of the essential properties list

Returns: An iterator referencing the start of the essential properties list.

◆ essentialPropertiesEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::essentialPropertiesEnd ( )

inline

Get an iterator referencing the end of the essential properties list

Returns: An iterator referencing the end of the essential properties list.

◆ essentialPropertiesEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::essentialPropertiesEnd ( ) const

inline

Get an iterator referencing the end of the essential properties list

Returns: An iterator referencing the end of the essential properties list.

◆ essentialPropertiesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::essentialPropertiesRemove ( const Descriptor & val )

Remove an entry to the essential properties list by value

Parameters

val	The essential property descriptor to remove from the essential properties list.

Returns: This RepresentationBase.

◆ essentialPropertiesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::essentialPropertiesRemove ( const std::list< Descriptor >::const_iterator & it )

Remove an entry to the essential properties list by iterator

Parameters

it	An iterator referencing an entry from the essential properties list.

Returns: This RepresentationBase.

◆ essentialPropertiesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::essentialPropertiesRemove ( const std::list< Descriptor >::iterator & it )

Remove an entry to the essential properties list by iterator

Parameters

it	An iterator referencing an entry from the essential properties list.

Returns: This RepresentationBase.

◆ essentialProperty()

const Descriptor & com::bbc::libmpdpp::RepresentationBase::essentialProperty ( std::list< Descriptor >::size_type idx ) const

Get the essential property descriptor at an index in the list

This will return the essential property descriptor at the index given in idx (starting at 0). If idx fall outside the essential properties list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of essential properties.

Returns: The essential property descriptor at list index idx.

Exceptions

std::out_of_range If idx lies outside of the essential properties list.

◆ framePacking()

const Descriptor & com::bbc::libmpdpp::RepresentationBase::framePacking ( std::list< Descriptor >::size_type idx ) const

Get the frame packing descriptor at an index in the list

This will return the frame packing descriptor at the index given in idx (starting at 0). If idx fall outside the frame packings list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of frame packings.

Returns: The frame packing descriptor at list index idx.

Exceptions

std::out_of_range If idx lies outside of the frame packings list.

◆ framePackings() [1/3]

const std::list< Descriptor > & com::bbc::libmpdpp::RepresentationBase::framePackings ( ) const

inline

Get the frame packings list

Returns: The frame packings list.

◆ framePackings() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::framePackings ( const std::list< Descriptor > & packings )

inline

Set the frame packings list

Parameters

packings The list of frame packings to set as the frame packings list.

Returns: This RepresentationBase.

◆ framePackings() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::framePackings ( std::list< Descriptor > && packings )

inline

Set the frame packings list

Parameters

packings The list of frame packings to set as the frame packings list.

Returns: This RepresentationBase.

◆ framePackingsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::framePackingsAdd ( const Descriptor & val )

inline

Add an entry to the frame packings list

Parameters

val	The frame packing descriptor to add to the frame packings list.

Returns: This RepresentationBase.

◆ framePackingsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::framePackingsAdd ( Descriptor && val )

inline

Add an entry to the frame packings list

Parameters

val	The frame packing descriptor to add to the frame packings list.

Returns: This RepresentationBase.

◆ framePackingsBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::framePackingsBegin ( )

inline

Get an iterator referencing the start of the frame packings list

Returns: An iterator referencing the start of the frame packings list.

◆ framePackingsBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::framePackingsBegin ( ) const

inline

Get an iterator referencing the start of the frame packings list

Returns: An iterator referencing the start of the frame packings list.

◆ framePackingsEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::framePackingsEnd ( )

inline

Get an iterator referencing the end of the frame packings list

Returns: An iterator referencing the end of the frame packings list.

◆ framePackingsEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::framePackingsEnd ( ) const

inline

Get an iterator referencing the end of the frame packings list

Returns: An iterator referencing the end of the frame packings list.

◆ framePackingsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::framePackingsRemove ( const Descriptor & val )

Remove an entry to the frame packings list by value

Parameters

val	The frame packing descriptor to remove from the frame packings list.

Returns: This RepresentationBase.

◆ framePackingsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::framePackingsRemove ( const std::list< Descriptor >::const_iterator & it )

Remove an entry to the frame packings list by iterator

Parameters

it	An iterator referencing an entry from the frame packings list.

Returns: This RepresentationBase.

◆ framePackingsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::framePackingsRemove ( const std::list< Descriptor >::iterator & it )

Remove an entry to the frame packings list by iterator

Parameters

it	An iterator referencing an entry from the frame packings list.

Returns: This RepresentationBase.

◆ frameRate() [1/7]

const std::optional< FrameRate > & com::bbc::libmpdpp::RepresentationBase::frameRate ( ) const

inline

Get the optional @frameRate attribute value

Returns: The optional @frameRate attribute value.

◆ frameRate() [2/7]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::frameRate ( const FrameRate & val )

inline

Set the @frameRate attribute value

Parameters

val	The frame rate value to set in the @frameRate attribute.

Returns: This RepresentationBase.

◆ frameRate() [3/7]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::frameRate ( const std::nullopt_t & )

inline

Unset the @frameRate attribute value

Returns: This RepresentationBase.

◆ frameRate() [4/7]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::frameRate ( const std::optional< FrameRate > & val )

inline

Set the @frameRate attribute value

Parameters

val	The frame rate value to set in the @frameRate attribute.

Returns: This RepresentationBase.

◆ frameRate() [5/7]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::frameRate ( FrameRate && val )

inline

Set the @frameRate attribute value

Parameters

val	The frame rate value to set in the @frameRate attribute.

Returns: This RepresentationBase.

◆ frameRate() [6/7]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::frameRate	(	FrameRate::size_type	numerator,
		FrameRate::size_type	denominator = 1 )

inline

Set the @frameRate attribute value

Parameters

numerator	The number of frames per `denominator` seconds.
denominator	The number of seconds over which `numerator` frames are given, defaults to 1 if not provided.

Returns: This RepresentationBase.

◆ frameRate() [7/7]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::frameRate ( std::optional< FrameRate > && val )

inline

Set the @frameRate attribute value

Parameters

val	The frame rate value to set in the @frameRate attribute.

Returns: This RepresentationBase.

◆ groupLabel()

const Label & com::bbc::libmpdpp::RepresentationBase::groupLabel ( std::list< Label >::size_type idx ) const

Get the group label at an index in the list

This will return the group label at the index given in idx (starting at 0). If idx falls outside the group labels list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of group labels.

Returns: The group label at list index idx.

Exceptions

std::out_of_range If idx lies outside of the group labels list.

◆ groupLabels() [1/3]

const std::list< Label > & com::bbc::libmpdpp::RepresentationBase::groupLabels ( ) const

inline

Get the group labels list

Returns: The group labels list.

◆ groupLabels() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::groupLabels ( const std::list< Label > & labels )

inline

Set the group labels list

Parameters

labels The list of group labels to set as the group labels list.

Returns: This RepresentationBase.

◆ groupLabels() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::groupLabels ( std::list< Label > && labels )

inline

Set the group labels list

Parameters

labels The list of group labels to set as the group labels list.

Returns: This RepresentationBase.

◆ groupLabelsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::groupLabelsAdd ( const Label & val )

inline

Add an entry to the group labels list

Parameters

val	The group label to add to the group labels list.

Returns: This RepresentationBase.

◆ groupLabelsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::groupLabelsAdd ( Label && val )

inline

Add an entry to the group labels list

Parameters

val	The group label to add to the group labels list.

Returns: This RepresentationBase.

◆ groupLabelsBegin() [1/2]

std::list< Label >::iterator com::bbc::libmpdpp::RepresentationBase::groupLabelsBegin ( )

inline

Get an iterator referencing the start of the group labels list

Returns: An iterator referencing the start of the group labels list.

◆ groupLabelsBegin() [2/2]

std::list< Label >::const_iterator com::bbc::libmpdpp::RepresentationBase::groupLabelsBegin ( ) const

inline

Get an iterator referencing the start of the group labels list

Returns: An iterator referencing the start of the group labels list.

◆ groupLabelsEnd() [1/2]

std::list< Label >::iterator com::bbc::libmpdpp::RepresentationBase::groupLabelsEnd ( )

inline

Get an iterator referencing the end of the group labels list

Returns: An iterator referencing the end of the group labels list.

◆ groupLabelsEnd() [2/2]

std::list< Label >::const_iterator com::bbc::libmpdpp::RepresentationBase::groupLabelsEnd ( ) const

inline

Get an iterator referencing the end of the group labels list

Returns: An iterator referencing the end of the group labels list.

◆ groupLabelsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::groupLabelsRemove ( const Label & val )

Remove an entry to the group labels list by value

Parameters

val	The group label to remove from the group labels list.

Returns: This RepresentationBase.

◆ groupLabelsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::groupLabelsRemove ( const std::list< Label >::const_iterator & it )

Remove an entry to the group labels list by iterator

Parameters

it	An iterator referencing an entry from the group labels list.

Returns: This RepresentationBase.

◆ groupLabelsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::groupLabelsRemove ( const std::list< Label >::iterator & it )

Remove an entry to the group labels list by iterator

Parameters

it	An iterator referencing an entry from the group labels list.

Returns: This RepresentationBase.

◆ hasCodecs()

bool com::bbc::libmpdpp::RepresentationBase::hasCodecs ( ) const

inline

Check if the @codecs attribute has a value set

Returns: true if the @codecs attribute has a value set.

◆ hasCodingDependency()

bool com::bbc::libmpdpp::RepresentationBase::hasCodingDependency ( ) const

inline

Check if the @codingDependency attribute has been set

Returns: true if the @codingDependency attribute has been set, otherwise false.

◆ hasFrameRate()

bool com::bbc::libmpdpp::RepresentationBase::hasFrameRate ( ) const

inline

Check if the @frameRate attribute has a value set

Returns: true if the @frameRate attribute has a value set.

◆ hasHeight()

bool com::bbc::libmpdpp::RepresentationBase::hasHeight ( ) const

inline

Check if the @height attribute has been set

Returns: true if the @height attribute has been set, otherwise false.

◆ hasMaximumSAPPeriod()

bool com::bbc::libmpdpp::RepresentationBase::hasMaximumSAPPeriod ( ) const

inline

Check if the @maximumSAPPeriod attribute has been set

Returns: true if the @maximumSAPPeriod attribute has been set, otherwise false.

◆ hasMaxPlayoutRate()

bool com::bbc::libmpdpp::RepresentationBase::hasMaxPlayoutRate ( ) const

inline

Check if the @maxPlayoutRate attribute has been set

Returns: true if the @maxPlayoutRate attribute has been set, otherwise false.

◆ hasMimeType()

bool com::bbc::libmpdpp::RepresentationBase::hasMimeType ( ) const

inline

Check if the @mimeType attribute has a value set

Returns: true if the @mimeType attribute has a value set.

◆ hasOutputProtection()

bool com::bbc::libmpdpp::RepresentationBase::hasOutputProtection ( ) const

inline

Check if the OutputProtection element has a value set

Returns: true if the OutputProtection element has a value set.

◆ hasSar()

bool com::bbc::libmpdpp::RepresentationBase::hasSar ( ) const

inline

Check if the @sar attribute is set

Returns: true if the @sar attribute is set.

◆ hasScanType()

bool com::bbc::libmpdpp::RepresentationBase::hasScanType ( ) const

inline

Check if the @scanType attribute has a value set

Returns: true if the @scanType attribute has a value set.

◆ hasStartWithSAP()

bool com::bbc::libmpdpp::RepresentationBase::hasStartWithSAP ( ) const

inline

Check if the @startWithSAP attribute has a value set

Returns: true if the @startWithSAP attribute has a value set.

◆ hasTag()

bool com::bbc::libmpdpp::RepresentationBase::hasTag ( ) const

inline

Check if the @tag attribute has a value set

Returns: true if the @tag attribute has a value set.

◆ hasWidth()

bool com::bbc::libmpdpp::RepresentationBase::hasWidth ( ) const

inline

Check if the @width attribute has been set

Returns: true if the @width attribute has been set, otherwise false.

◆ height() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::RepresentationBase::height ( ) const

inline

Get the optional @height attribute value

Returns: The optional @height attribute value.

◆ height() [2/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::height ( const std::nullopt_t & )

inline

Unset the optional @height attribute value

Returns: This RepresentationBase.

◆ height() [3/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::height ( const std::optional< unsigned int > & val )

inline

Set the @height attribute value

Parameters

val	The value to set in the @height attribute.

Returns: This RepresentationBase.

◆ height() [4/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::height ( std::optional< unsigned int > && val )

inline

Set the @height attribute value

Parameters

val	The value to set in the @height attribute.

Returns: This RepresentationBase.

◆ height() [5/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::height ( unsigned int val )

inline

Set the @height attribute value

Parameters

val	The value to set in the @height attribute.

Returns: This RepresentationBase.

◆ inbandEventStream()

const EventStream & com::bbc::libmpdpp::RepresentationBase::inbandEventStream ( std::list< EventStream >::size_type idx ) const

Get the inband event stream at an index in the list

This will return the inband event stream at the index given in idx (starting at 0). If idx falls outside the inband event streams list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of inband event streams.

Returns: The inband event stream at list index idx.

Exceptions

std::out_of_range If idx lies outside of the inband event streams list.

◆ inbandEventStreams() [1/3]

const std::list< EventStream > & com::bbc::libmpdpp::RepresentationBase::inbandEventStreams ( ) const

inline

Get the inband event streams list

Returns: The inband event streams list.

◆ inbandEventStreams() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::inbandEventStreams ( const std::list< EventStream > & streams )

inline

Set the inband event streams list

Parameters

streams The list of inband event streams to set as the inband event streams list.

Returns: This RepresentationBase.

◆ inbandEventStreams() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::inbandEventStreams ( std::list< EventStream > && streams )

inline

Set the inband event streams list

Parameters

streams The list of inband event streams to set as the inband event streams list.

Returns: This RepresentationBase.

◆ inbandEventStreamsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsAdd ( const EventStream & val )

inline

Add an entry to the inband event streams list

Parameters

val	The inband event stream to add to the inband event streams list.

Returns: This RepresentationBase.

◆ inbandEventStreamsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsAdd ( EventStream && val )

inline

Add an entry to the inband event streams list

Parameters

val	The inband event stream to add to the inband event streams list.

Returns: This RepresentationBase.

◆ inbandEventStreamsBegin() [1/2]

std::list< EventStream >::iterator com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsBegin ( )

inline

Get an iterator referencing the start of the inband event streams list

Returns: An iterator referencing the start of the inband event streams list.

◆ inbandEventStreamsBegin() [2/2]

std::list< EventStream >::const_iterator com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsBegin ( ) const

inline

Get an iterator referencing the start of the inband event streams list

Returns: An iterator referencing the start of the inband event streams list.

◆ inbandEventStreamsEnd() [1/2]

std::list< EventStream >::iterator com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsEnd ( )

inline

Get an iterator referencing the end of the inband event streams list

Returns: An iterator referencing the end of the inband event streams list.

◆ inbandEventStreamsEnd() [2/2]

std::list< EventStream >::const_iterator com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsEnd ( ) const

inline

Get an iterator referencing the end of the inband event streams list

Returns: An iterator referencing the end of the inband event streams list.

◆ inbandEventStreamsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsRemove ( const EventStream & val )

Remove an entry to the inband event streams list by value

Parameters

val	The inband event stream to remove from the inband event streams list.

Returns: This RepresentationBase.

◆ inbandEventStreamsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsRemove ( const std::list< EventStream >::const_iterator & it )

Remove an entry to the inband event streams list by iterator

Parameters

it	An iterator referencing an entry from the inband event streams list.

Returns: This RepresentationBase.

◆ inbandEventStreamsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::inbandEventStreamsRemove ( const std::list< EventStream >::iterator & it )

Remove an entry to the inband event streams list by iterator

Parameters

it	An iterator referencing an entry from the inband event streams list.

Returns: This RepresentationBase.

◆ label()

const Label & com::bbc::libmpdpp::RepresentationBase::label ( std::list< Label >::size_type idx ) const

Get the label at an index in the list

This will return the label at the index given in idx (starting at 0). If idx falls outside the labels list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of labels.

Returns: The label at list index idx.

Exceptions

std::out_of_range If idx lies outside of the labels list.

◆ labels() [1/3]

const std::list< Label > & com::bbc::libmpdpp::RepresentationBase::labels ( ) const

inline

Get the labels list

Returns: The labels list.

◆ labels() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::labels ( const std::list< Label > & _labels )

inline

Set the labels list

Parameters

_labels The list of labels to set as the labels list.

Returns: This RepresentationBase.

◆ labels() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::labels ( std::list< Label > && _labels )

inline

Set the labels list

Parameters

_labels The list of labels to set as the labels list.

Returns: This RepresentationBase.

◆ labelsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::labelsAdd ( const Label & val )

inline

Add an entry to the labels list

Parameters

val	The label to add to the labels list.

Returns: This RepresentationBase.

◆ labelsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::labelsAdd ( Label && val )

inline

Add an entry to the labels list

Parameters

val	The label to add to the labels list.

Returns: This RepresentationBase.

◆ labelsBegin() [1/2]

std::list< Label >::iterator com::bbc::libmpdpp::RepresentationBase::labelsBegin ( )

inline

Get an iterator referencing the start of the labels list

Returns: An iterator referencing the start of the labels list.

◆ labelsBegin() [2/2]

std::list< Label >::const_iterator com::bbc::libmpdpp::RepresentationBase::labelsBegin ( ) const

inline

Get an iterator referencing the start of the labels list

Returns: An iterator referencing the start of the labels list.

◆ labelsEnd() [1/2]

std::list< Label >::iterator com::bbc::libmpdpp::RepresentationBase::labelsEnd ( )

inline

Get an iterator referencing the end of the labels list

Returns: An iterator referencing the end of the labels list.

◆ labelsEnd() [2/2]

std::list< Label >::const_iterator com::bbc::libmpdpp::RepresentationBase::labelsEnd ( ) const

inline

Get an iterator referencing the end of the labels list

Returns: An iterator referencing the end of the labels list.

◆ labelsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::labelsRemove ( const Label & val )

Remove an entry to the labels list by value

Parameters

val	The label to remove from the labels list.

Returns: This RepresentationBase.

◆ labelsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::labelsRemove ( const std::list< Label >::const_iterator & it )

Remove an entry to the labels list by iterator

Parameters

it	An iterator referencing an entry from the labels list.

Returns: This RepresentationBase.

◆ labelsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::labelsRemove ( const std::list< Label >::iterator & it )

Remove an entry to the labels list by iterator

Parameters

it	An iterator referencing an entry from the labels list.

Returns: This RepresentationBase.

◆ maximumSAPPeriod() [1/5]

const std::optional< double > & com::bbc::libmpdpp::RepresentationBase::maximumSAPPeriod ( ) const

inline

Get the optional @maximumSAPPeriod attribute value

Returns: The optional @maximumSAPPeriod attribute value.

◆ maximumSAPPeriod() [2/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maximumSAPPeriod ( const std::nullopt_t & )

inline

Unset the optional @maximumSAPPeriod attribute value

Returns: This RepresentationBase.

◆ maximumSAPPeriod() [3/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maximumSAPPeriod ( const std::optional< double > & val )

inline

Set the @maximumSAPPeriod attribute value

Parameters

val	The value to set in the @maximumSAPPeriod attribute.

Returns: This RepresentationBase.

◆ maximumSAPPeriod() [4/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maximumSAPPeriod ( double val )

inline

Set the @maximumSAPPeriod attribute value

Parameters

val	The value to set in the @maximumSAPPeriod attribute.

Returns: This RepresentationBase.

◆ maximumSAPPeriod() [5/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maximumSAPPeriod ( std::optional< double > && val )

inline

Set the @maximumSAPPeriod attribute value

Parameters

val	The value to set in the @maximumSAPPeriod attribute.

Returns: This RepresentationBase.

◆ maxPlayoutRate() [1/5]

const std::optional< double > & com::bbc::libmpdpp::RepresentationBase::maxPlayoutRate ( ) const

inline

Get the optional @maxPlayoutRate attribute value

Returns: The optional @maxPlayoutRate attribute value.

◆ maxPlayoutRate() [2/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maxPlayoutRate ( const std::nullopt_t & )

inline

Unset the optional @maxPlayoutRate attribute value

Returns: This RepresentationBase.

◆ maxPlayoutRate() [3/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maxPlayoutRate ( const std::optional< double > & val )

inline

Set the @maxPlayoutRate attribute value

Parameters

val	The value to set in the @maxPlayoutRate attribute.

Returns: This RepresentationBase.

◆ maxPlayoutRate() [4/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maxPlayoutRate ( double val )

inline

Set the @maxPlayoutRate attribute value

Parameters

val	The value to set in the @maxPlayoutRate attribute.

Returns: This RepresentationBase.

◆ maxPlayoutRate() [5/5]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::maxPlayoutRate ( std::optional< double > && val )

inline

Set the @maxPlayoutRate attribute value

Parameters

val	The value to set in the @maxPlayoutRate attribute.

Returns: This RepresentationBase.

◆ mimeType() [1/6]

const std::optional< std::string > & com::bbc::libmpdpp::RepresentationBase::mimeType ( ) const

inline

Get the optional @mimeType attribute value

Returns: The optional @mimeType attribute value.

◆ mimeType() [2/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::mimeType ( const std::nullopt_t & )

inline

Unset the @mimeType attribute value

Returns: This RepresentationBase.

◆ mimeType() [3/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::mimeType ( const std::optional< std::string > & val )

inline

Set the @mimeType attribute value

Parameters

val	The value to set for the @mimeType attribute

Returns: This RepresentationBase.

◆ mimeType() [4/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::mimeType ( const std::string & val )

inline

Set the @mimeType attribute value

Parameters

val	The value to set for the @mimeType attribute

Returns: This RepresentationBase.

◆ mimeType() [5/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::mimeType ( std::optional< std::string > && val )

inline

Set the @mimeType attribute value

Parameters

val	The value to set for the @mimeType attribute

Returns: This RepresentationBase.

◆ mimeType() [6/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::mimeType ( std::string && val )

inline

Set the @mimeType attribute value

Parameters

val	The value to set for the @mimeType attribute

Returns: This RepresentationBase.

◆ operator=() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::operator= ( const RepresentationBase & to_copy )

Copy operator

Replace the current RepresentationBase with a copy of the values from to_copy.

Parameters

to_copy The RepresentationBase to copy.

Returns: This RepresentationBase.

◆ operator=() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::operator= ( RepresentationBase && to_move )

Move operator

Replace the current RepresentationBase with the resources and values from to_move.

Parameters

to_move The RepresentationBase to move into this new RepresentationBase.

Returns: This RepresentationBase.

◆ operator==()

bool com::bbc::libmpdpp::RepresentationBase::operator== ( const RepresentationBase & to_compare ) const

Equality operator

Check if to_compare has an equal value to this RepresentationBase.

Parameters

to_compare The other RepresentationBase to compare to this.

Returns: true if this RepresentationBase has the same values as to_compare.

◆ outputProtection() [1/6]

const std::optional< Descriptor > & com::bbc::libmpdpp::RepresentationBase::outputProtection ( ) const

inline

Get the optional OutputProtection element value

Returns: The optional OutputProtection element value.

◆ outputProtection() [2/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::outputProtection ( const Descriptor & val )

inline

Set the OutputProtection element value

Parameters

val	The output protection descriptor to set in the OutputProtection element.

Returns: This RepresentationBase.

◆ outputProtection() [3/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::outputProtection ( const std::nullopt_t & )

inline

Unset the OutputProtection element value

Returns: This RepresentationBase.

◆ outputProtection() [4/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::outputProtection ( const std::optional< Descriptor > & val )

inline

Set the OutputProtection element value

Parameters

val	The output protection descriptor to set in the OutputProtection element.

Returns: This RepresentationBase.

◆ outputProtection() [5/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::outputProtection ( Descriptor && val )

inline

Set the OutputProtection element value

Parameters

val	The output protection descriptor to set in the OutputProtection element.

Returns: This RepresentationBase.

◆ outputProtection() [6/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::outputProtection ( std::optional< Descriptor > && val )

inline

Set the OutputProtection element value

Parameters

val	The output protection descriptor to set in the OutputProtection element.

Returns: This RepresentationBase.

◆ producerReferenceTime()

const ProducerReferenceTime & com::bbc::libmpdpp::RepresentationBase::producerReferenceTime ( std::list< ProducerReferenceTime >::size_type idx ) const

Get the producer reference time at an index in the list

This will return the producer reference time at the index given in idx (starting at 0). If idx falls outside the producer reference times list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of producer reference times.

Returns: The producer reference time at list index idx.

Exceptions

std::out_of_range If idx lies outside of the producer reference times list.

◆ producerReferenceTimes() [1/3]

const std::list< ProducerReferenceTime > & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimes ( ) const

inline

Get the producer reference times list

Returns: The producer reference times list.

◆ producerReferenceTimes() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimes ( const std::list< ProducerReferenceTime > & times )

inline

Set the producer reference times list

Parameters

times The list of producer reference times to set as the producer reference times list.

Returns: This RepresentationBase.

◆ producerReferenceTimes() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimes ( std::list< ProducerReferenceTime > && times )

inline

Set the producer reference times list

Parameters

times The list of producer reference times to set as the producer reference times list.

Returns: This RepresentationBase.

◆ producerReferenceTimesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesAdd ( const ProducerReferenceTime & val )

inline

Add an entry to the producer reference times list

Parameters

val	The producer reference time to add to the producer reference times list.

Returns: This RepresentationBase.

◆ producerReferenceTimesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesAdd ( ProducerReferenceTime && val )

inline

Add an entry to the producer reference times list

Parameters

val	The producer reference time to add to the producer reference times list.

Returns: This RepresentationBase.

◆ producerReferenceTimesBegin() [1/2]

std::list< ProducerReferenceTime >::iterator com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesBegin ( )

inline

Get an iterator referencing the start of the producer reference times list

Returns: An iterator referencing the start of the producer reference times list.

◆ producerReferenceTimesBegin() [2/2]

std::list< ProducerReferenceTime >::const_iterator com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesBegin ( ) const

inline

Get an iterator referencing the start of the producer reference times list

Returns: An iterator referencing the start of the producer reference times list.

◆ producerReferenceTimesEnd() [1/2]

std::list< ProducerReferenceTime >::iterator com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesEnd ( )

inline

Get an iterator referencing the end of the producer reference times list

Returns: An iterator referencing the end of the producer reference times list.

◆ producerReferenceTimesEnd() [2/2]

std::list< ProducerReferenceTime >::const_iterator com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesEnd ( ) const

inline

Get an iterator referencing the end of the producer reference times list

Returns: An iterator referencing the end of the producer reference times list.

◆ producerReferenceTimesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesRemove ( const ProducerReferenceTime & val )

Remove an entry to the producer reference times list by value

Parameters

val	The producer reference time to remove from the producer reference times list.

Returns: This RepresentationBase.

◆ producerReferenceTimesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesRemove ( const std::list< ProducerReferenceTime >::const_iterator & it )

Remove an entry to the producer reference times list by iterator

Parameters

it	An iterator referencing an entry from the producer reference times list.

Returns: This RepresentationBase.

◆ producerReferenceTimesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::producerReferenceTimesRemove ( const std::list< ProducerReferenceTime >::iterator & it )

Remove an entry to the producer reference times list by iterator

Parameters

it	An iterator referencing an entry from the producer reference times list.

Returns: This RepresentationBase.

◆ profile()

const URI & com::bbc::libmpdpp::RepresentationBase::profile ( std::list< URI >::size_type idx ) const

Get an entry from the profiles list

Parameters

idx	The index in the list (starting from 0) of the profile URI to retrieve.

Returns: The profile URI at list index idx.

Exceptions

std::out_of_range If the idx index references a URI outside the profiles list.

◆ profiles() [1/3]

const std::list< URI > & com::bbc::libmpdpp::RepresentationBase::profiles ( ) const

inline

Get the list of profiles

Returns: the list of profile URIs.

◆ profiles() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::profiles ( const std::list< URI > & _profiles )

inline

Set the profiles list

Parameters

_profiles The list of profiles to set the profiles list to.

Returns: This RepresentationBase.

◆ profiles() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::profiles ( std::list< URI > && _profiles )

inline

Set the profiles list

Parameters

_profiles The list of profiles to set the profiles list to.

Returns: This RepresentationBase.

◆ profilesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::profilesAdd ( const URI & val )

inline

Add a value to the profiles list

Parameters

val	The profile URI value to add to the @profile attribute.

Returns: This RepresentationBase.

◆ profilesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::profilesAdd ( URI && val )

inline

Add a value to the profiles list

Parameters

val	The profile URI value to add to the @profile attribute.

Returns: This RepresentationBase.

◆ profilesBegin() [1/2]

std::list< URI >::iterator com::bbc::libmpdpp::RepresentationBase::profilesBegin ( )

inline

Get an iterator for the start of the profiles list

Returns: An iterator for the start of the profiles list.

◆ profilesBegin() [2/2]

std::list< URI >::const_iterator com::bbc::libmpdpp::RepresentationBase::profilesBegin ( ) const

inline

Get an iterator for the start of the profiles list

Returns: An iterator for the start of the profiles list.

◆ profilesEnd() [1/2]

std::list< URI >::iterator com::bbc::libmpdpp::RepresentationBase::profilesEnd ( )

inline

Get an iterator for the end of the profiles list

Returns: An iterator for the end of the profiles list.

◆ profilesEnd() [2/2]

std::list< URI >::const_iterator com::bbc::libmpdpp::RepresentationBase::profilesEnd ( ) const

inline

Get an iterator for the end of the profiles list

Returns: An iterator for the end of the profiles list.

◆ profilesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::profilesRemove ( const std::list< URI >::const_iterator & it )

Remove a URI from the profiles list by iterator

Parameters

it	An iterator referencing the entry to remove from the @profile attribute.

Returns: This RepresentationBase.

◆ profilesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::profilesRemove ( const std::list< URI >::iterator & it )

Remove a URI from the profiles list by iterator

Parameters

it	An iterator referencing the entry to remove from the @profile attribute.

Returns: This RepresentationBase.

◆ profilesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::profilesRemove ( const URI & val )

Remove a URI from the profiles list by value

Parameters

val	The profile URI value of the entry to remove from the @profile attribute.

Returns: This RepresentationBase.

◆ randomAccess()

const RandomAccess & com::bbc::libmpdpp::RepresentationBase::randomAccess ( std::list< RandomAccess >::size_type idx ) const

Get the random access value at an index in the list

This will return the random access at the index given in idx (starting at 0). If idx falls outside the random accesses list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of random accesses.

Returns: The random access at list index idx.

Exceptions

std::out_of_range If idx lies outside of the random accesses list.

◆ randomAccesses() [1/3]

const std::list< RandomAccess > & com::bbc::libmpdpp::RepresentationBase::randomAccesses ( ) const

inline

Get the random accesses list

Returns: The random accesses list.

◆ randomAccesses() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::randomAccesses ( const std::list< RandomAccess > & accesses )

inline

Set the random accesses list

Parameters

accesses The list of random accesses to set as the random accesses list.

Returns: This RepresentationBase.

◆ randomAccesses() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::randomAccesses ( std::list< RandomAccess > && accesses )

inline

Set the random accesses list

Parameters

accesses The list of random accesses to set as the random accesses list.

Returns: This RepresentationBase.

◆ randomAccessesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::randomAccessesAdd ( const RandomAccess & val )

inline

Add an entry to the random accesses list

Parameters

val	The random access to add to the random accesses list.

Returns: This RepresentationBase.

◆ randomAccessesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::randomAccessesAdd ( RandomAccess && val )

inline

Add an entry to the random accesses list

Parameters

val	The random access to add to the random accesses list.

Returns: This RepresentationBase.

◆ randomAccessesBegin() [1/2]

std::list< RandomAccess >::iterator com::bbc::libmpdpp::RepresentationBase::randomAccessesBegin ( )

inline

Get an iterator referencing the start of the random accesses list

Returns: An iterator referencing the start of the random accesses list.

◆ randomAccessesBegin() [2/2]

std::list< RandomAccess >::const_iterator com::bbc::libmpdpp::RepresentationBase::randomAccessesBegin ( ) const

inline

Get an iterator referencing the start of the random accesses list

Returns: An iterator referencing the start of the random accesses list.

◆ randomAccessesEnd() [1/2]

std::list< RandomAccess >::iterator com::bbc::libmpdpp::RepresentationBase::randomAccessesEnd ( )

inline

Get an iterator referencing the end of the random accesses list

Returns: An iterator referencing the end of the random accesses list.

◆ randomAccessesEnd() [2/2]

std::list< RandomAccess >::const_iterator com::bbc::libmpdpp::RepresentationBase::randomAccessesEnd ( ) const

inline

Get an iterator referencing the end of the random accesses list

Returns: An iterator referencing the end of the random accesses list.

◆ randomAccessesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::randomAccessesRemove ( const RandomAccess & val )

Remove an entry to the random accesses list by value

Parameters

val	The random access to remove from the random accesses list.

Returns: This RepresentationBase.

◆ randomAccessesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::randomAccessesRemove ( const std::list< RandomAccess >::const_iterator & it )

Remove an entry to the random accesses list by iterator

Parameters

it	An iterator referencing an entry from the random accesses list.

Returns: This RepresentationBase.

◆ randomAccessesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::randomAccessesRemove ( const std::list< RandomAccess >::iterator & it )

Remove an entry to the random accesses list by iterator

Parameters

it	An iterator referencing an entry from the random accesses list.

Returns: This RepresentationBase.

◆ resync()

const Resync & com::bbc::libmpdpp::RepresentationBase::resync ( std::list< Resync >::size_type idx ) const

Get the resync at an index in the list

This will return the resync at the index given in idx (starting at 0). If idx falls outside the resyncs list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of resyncs.

Returns: The resync at list index idx.

Exceptions

std::out_of_range If idx lies outside of the resyncs list.

◆ resyncs() [1/3]

const std::list< Resync > & com::bbc::libmpdpp::RepresentationBase::resyncs ( ) const

inline

Get the resyncs list

Returns: The resyncs list.

◆ resyncs() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::resyncs ( const std::list< Resync > & _resyncs )

inline

Set the resyncs list

Parameters

_resyncs The list of resyncs to set as the resyncs list.

Returns: This RepresentationBase.

◆ resyncs() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::resyncs ( std::list< Resync > && _resyncs )

inline

Set the resyncs list

Parameters

_resyncs The list of resyncs to set as the resyncs list.

Returns: This RepresentationBase.

◆ resyncsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::resyncsAdd ( const Resync & val )

inline

Add an entry to the resyncs list

Parameters

val	The resync to add to the resyncs list.

Returns: This RepresentationBase.

◆ resyncsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::resyncsAdd ( Resync && val )

inline

Add an entry to the resyncs list

Parameters

val	The resync to add to the resyncs list.

Returns: This RepresentationBase.

◆ resyncsBegin() [1/2]

std::list< Resync >::iterator com::bbc::libmpdpp::RepresentationBase::resyncsBegin ( )

inline

Get an iterator referencing the start of the resyncs list

Returns: An iterator referencing the start of the resyncs list.

◆ resyncsBegin() [2/2]

std::list< Resync >::const_iterator com::bbc::libmpdpp::RepresentationBase::resyncsBegin ( ) const

inline

Get an iterator referencing the start of the resyncs list

Returns: An iterator referencing the start of the resyncs list.

◆ resyncsEnd() [1/2]

std::list< Resync >::iterator com::bbc::libmpdpp::RepresentationBase::resyncsEnd ( )

inline

Get an iterator referencing the end of the resyncs list

Returns: An iterator referencing the end of the resyncs list.

◆ resyncsEnd() [2/2]

std::list< Resync >::const_iterator com::bbc::libmpdpp::RepresentationBase::resyncsEnd ( ) const

inline

Get an iterator referencing the end of the resyncs list

Returns: An iterator referencing the end of the resyncs list.

◆ resyncsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::resyncsRemove ( const Resync & val )

Remove an entry to the resyncs list by value

Parameters

val	The resync to remove from the resyncs list.

Returns: This RepresentationBase.

◆ resyncsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::resyncsRemove ( const std::list< Resync >::const_iterator & it )

Remove an entry to the resyncs list by iterator

Parameters

it	An iterator referencing an entry from the resyncs list.

Returns: This RepresentationBase.

◆ resyncsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::resyncsRemove ( const std::list< Resync >::iterator & it )

Remove an entry to the resyncs list by iterator

Parameters

it	An iterator referencing an entry from the resyncs list.

Returns: This RepresentationBase.

◆ sar() [1/6]

const std::optional< Ratio > & com::bbc::libmpdpp::RepresentationBase::sar ( ) const

inline

Get the optional @sar attribute value

Get the sample aspect ratio.

Returns: The optional sample aspect ratio.

◆ sar() [2/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::sar ( const Ratio & val )

inline

Set the @sar attribute value

Set the sample aspect ratio.

Parameters

val	The sample aspect ratio to set in the @sar attribute.

Returns: This RepresentationBase.

◆ sar() [3/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::sar ( const std::nullopt_t & )

inline

Unset the @sar attribute value

Returns: This RepresentationBase.

◆ sar() [4/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::sar ( const std::optional< Ratio > & val )

inline

Set the @sar attribute value

Set the sample aspect ratio.

Parameters

val	The sample aspect ratio to set in the @sar attribute.

Returns: This RepresentationBase.

◆ sar() [5/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::sar ( Ratio && val )

inline

Set the @sar attribute value

Set the sample aspect ratio.

Parameters

val	The sample aspect ratio to set in the @sar attribute.

Returns: This RepresentationBase.

◆ sar() [6/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::sar ( std::optional< Ratio > && val )

inline

Set the @sar attribute value

Set the sample aspect ratio.

Parameters

val	The sample aspect ratio to set in the @sar attribute.

Returns: This RepresentationBase.

◆ scanType() [1/6]

const std::optional< VideoScan > & com::bbc::libmpdpp::RepresentationBase::scanType ( ) const

inline

Get the optional @scanType attribute value

Returns: The optional @scanType attribute value.

◆ scanType() [2/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::scanType ( const std::nullopt_t & )

inline

Unset the @scanType attribute value

Returns: This RepresentationBase.

◆ scanType() [3/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::scanType ( const std::optional< VideoScan > & val )

inline

Set the @scanType attribute value

Parameters

val	The video scan type value to set in the @scanType attribute.

Returns: This RepresentationBase.

◆ scanType() [4/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::scanType ( const VideoScan & val )

inline

Set the @scanType attribute value

Parameters

val	The video scan type value to set in the @scanType attribute.

Returns: This RepresentationBase.

◆ scanType() [5/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::scanType ( std::optional< VideoScan > && val )

inline

Set the @scanType attribute value

Parameters

val	The video scan type value to set in the @scanType attribute.

Returns: This RepresentationBase.

◆ scanType() [6/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::scanType ( VideoScan && val )

inline

Set the @scanType attribute value

Parameters

val	The video scan type value to set in the @scanType attribute.

Returns: This RepresentationBase.

◆ segmentProfile()

const std::string & com::bbc::libmpdpp::RepresentationBase::segmentProfile ( std::list< std::string >::size_type idx ) const

Get the segment profile string at an index in the list

This will return the segment profile string at the index given in idx (starting at 0). If idx fall outside the segment profiles list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of segment profiles.

Returns: The segment profile string at list index idx.

Exceptions

std::out_of_range If idx lies outside of the segment profiles list.

◆ segmentProfiles() [1/3]

const std::list< std::string > & com::bbc::libmpdpp::RepresentationBase::segmentProfiles ( ) const

inline

Get the segment profiles list

Returns: The segment profiles list.

◆ segmentProfiles() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::segmentProfiles ( const std::list< std::string > & profiles )

inline

Set the segment profiles list

Parameters

profiles The list of profiles to set as segment profiles.

Returns: This RepresentationBase.

◆ segmentProfiles() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::segmentProfiles ( std::list< std::string > && profiles )

inline

Set the segment profiles list

Parameters

profiles The list of profiles to set as segment profiles.

Returns: This RepresentationBase.

◆ segmentProfilesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::segmentProfilesAdd ( const std::string & val )

inline

Add an entry to the segment profiles list

Parameters

val	The string value to add to the segment profiles list.

Returns: This RepresentationBase.

◆ segmentProfilesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::segmentProfilesAdd ( std::string && val )

inline

Add an entry to the segment profiles list

Parameters

val	The string value to add to the segment profiles list.

Returns: This RepresentationBase.

◆ segmentProfilesBegin() [1/2]

std::list< std::string >::iterator com::bbc::libmpdpp::RepresentationBase::segmentProfilesBegin ( )

inline

Get an iterator referencing the start of the segment profiles list

Returns: An iterator referencing the start of the segment profiles list.

◆ segmentProfilesBegin() [2/2]

std::list< std::string >::const_iterator com::bbc::libmpdpp::RepresentationBase::segmentProfilesBegin ( ) const

inline

Get an iterator referencing the start of the segment profiles list

Returns: An iterator referencing the start of the segment profiles list.

◆ segmentProfilesEnd() [1/2]

std::list< std::string >::iterator com::bbc::libmpdpp::RepresentationBase::segmentProfilesEnd ( )

inline

Get an iterator referencing the end of the segment profiles list

Returns: An iterator referencing the end of the segment profiles list.

◆ segmentProfilesEnd() [2/2]

std::list< std::string >::const_iterator com::bbc::libmpdpp::RepresentationBase::segmentProfilesEnd ( ) const

inline

Get an iterator referencing the end of the segment profiles list

Returns: An iterator referencing the end of the segment profiles list.

◆ segmentProfilesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::segmentProfilesRemove ( const std::list< std::string >::const_iterator & it )

Remove an entry to the segment profiles list by iterator

Parameters

it	An iterator referencing an entry from the segment profiles list.

Returns: This RepresentationBase.

◆ segmentProfilesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::segmentProfilesRemove ( const std::list< std::string >::iterator & it )

Remove an entry to the segment profiles list by iterator

Parameters

it	An iterator referencing an entry from the segment profiles list.

Returns: This RepresentationBase.

◆ segmentProfilesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::segmentProfilesRemove ( const std::string & val )

Remove an entry to the segment profiles list by value

Parameters

val	The string value to remove from the segment profiles list.

Returns: This RepresentationBase.

◆ selectionPriority() [1/2]

unsigned int com::bbc::libmpdpp::RepresentationBase::selectionPriority ( ) const

inline

Get the @selectionPriority attribute value

Returns: The @selectionPriority attribute value.

◆ selectionPriority() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::selectionPriority ( unsigned int val )

inline

Set the @selectionPriority attribute value

If this value is set to the default of 1, then it will be omitted from XML output.

Parameters

val	Set the @selectionPriority attribute value to `val`.

Returns: This RepresentationBase.

◆ startWithSAP() [1/6]

const std::optional< SAP > & com::bbc::libmpdpp::RepresentationBase::startWithSAP ( ) const

inline

Get the optional @startWithSAP attribute value

Returns: The optional @startWithSAP attribute value.

◆ startWithSAP() [2/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::startWithSAP ( const SAP & val )

inline

Set the @startWithSAP attribute value

Parameters

val	The starts with SAP value to set in the @startWithSAP attribute.

Returns: This RepresentationBase.

◆ startWithSAP() [3/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::startWithSAP ( const std::nullopt_t & )

inline

Unset the @startWithSAP attribute value

Returns: This RepresentationBase.

◆ startWithSAP() [4/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::startWithSAP ( const std::optional< SAP > & val )

inline

Set the @startWithSAP attribute value

Parameters

val	The starts with SAP value to set in the @startWithSAP attribute.

Returns: This RepresentationBase.

◆ startWithSAP() [5/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::startWithSAP ( SAP && val )

inline

Set the @startWithSAP attribute value

Parameters

val	The starts with SAP value to set in the @startWithSAP attribute.

Returns: This RepresentationBase.

◆ startWithSAP() [6/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::startWithSAP ( std::optional< SAP > && val )

inline

Set the @startWithSAP attribute value

Parameters

val	The starts with SAP value to set in the @startWithSAP attribute.

Returns: This RepresentationBase.

◆ supplementalProperties() [1/3]

const std::list< Descriptor > & com::bbc::libmpdpp::RepresentationBase::supplementalProperties ( ) const

inline

Get the supplemental properties list

Returns: The supplemental properties list.

◆ supplementalProperties() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::supplementalProperties ( const std::list< Descriptor > & properties )

inline

Set the supplemental properties list

Parameters

properties The list of supplemental properties to set as the supplemental properties list.

Returns: This RepresentationBase.

◆ supplementalProperties() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::supplementalProperties ( std::list< Descriptor > && properties )

inline

Set the supplemental properties list

Parameters

properties The list of supplemental properties to set as the supplemental properties list.

Returns: This RepresentationBase.

◆ supplementalPropertiesAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesAdd ( const Descriptor & val )

inline

Add an entry to the supplemental properties list

Parameters

val	The supplemental property descriptor to add to the supplemental properties list.

Returns: This RepresentationBase.

◆ supplementalPropertiesAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesAdd ( Descriptor && val )

inline

Add an entry to the supplemental properties list

Parameters

val	The supplemental property descriptor to add to the supplemental properties list.

Returns: This RepresentationBase.

◆ supplementalPropertiesBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesBegin ( )

inline

Get an iterator referencing the start of the supplemental properties list

Returns: An iterator referencing the start of the supplemental properties list.

◆ supplementalPropertiesBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesBegin ( ) const

inline

Get an iterator referencing the start of the supplemental properties list

Returns: An iterator referencing the start of the supplemental properties list.

◆ supplementalPropertiesEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesEnd ( )

inline

Get an iterator referencing the end of the supplemental properties list

Returns: An iterator referencing the end of the supplemental properties list.

◆ supplementalPropertiesEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesEnd ( ) const

inline

Get an iterator referencing the end of the supplemental properties list

Returns: An iterator referencing the end of the supplemental properties list.

◆ supplementalPropertiesRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesRemove ( const Descriptor & val )

Remove an entry to the supplemental properties list by value

Parameters

val	The supplemental property descriptor to remove from the supplemental properties list.

Returns: This RepresentationBase.

◆ supplementalPropertiesRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesRemove ( const std::list< Descriptor >::const_iterator & it )

Remove an entry to the supplemental properties list by iterator

Parameters

it	An iterator referencing an entry from the supplemental properties list.

Returns: This RepresentationBase.

◆ supplementalPropertiesRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::supplementalPropertiesRemove ( const std::list< Descriptor >::iterator & it )

Remove an entry to the supplemental properties list by iterator

Parameters

it	An iterator referencing an entry from the supplemental properties list.

Returns: This RepresentationBase.

◆ supplementalProperty()

const Descriptor & com::bbc::libmpdpp::RepresentationBase::supplementalProperty ( std::list< Descriptor >::size_type idx ) const

Get the supplemental property descriptor at an index in the list

This will return the supplemental property descriptor at the index given in idx (starting at 0). If idx fall outside the supplemental properties list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of supplemental properties.

Returns: The supplemental property descriptor at list index idx.

Exceptions

std::out_of_range If idx lies outside of the supplemental properties list.

◆ switching()

const Switching & com::bbc::libmpdpp::RepresentationBase::switching ( std::list< Switching >::size_type idx ) const

Get the switching at an index in the list

This will return the switching at the index given in idx (starting at 0). If idx falls outside the switchings list then a std::out_of_range exception will be thrown.

Parameters

idx	The index, starting from 0, of the entry to retrieve from the list of switchings.

Returns: The switching at list index idx.

Exceptions

std::out_of_range If idx lies outside of the switchings list.

◆ switchings() [1/3]

const std::list< Switching > & com::bbc::libmpdpp::RepresentationBase::switchings ( ) const

inline

Get the switchings list

Returns: The switchings list.

◆ switchings() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::switchings ( const std::list< Switching > & _switchings )

inline

Set the switchings list

Parameters

_switchings The list of switchings to set as the switchings list.

Returns: This RepresentationBase.

◆ switchings() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::switchings ( std::list< Switching > && _switchings )

inline

Set the switchings list

Parameters

_switchings The list of switchings to set as the switchings list.

Returns: This RepresentationBase.

◆ switchingsAdd() [1/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::switchingsAdd ( const Switching & val )

inline

Add an entry to the switchings list

Parameters

val	The switching to add to the switchings list.

Returns: This RepresentationBase.

◆ switchingsAdd() [2/2]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::switchingsAdd ( Switching && val )

inline

Add an entry to the switchings list

Parameters

val	The switching to add to the switchings list.

Returns: This RepresentationBase.

◆ switchingsBegin() [1/2]

std::list< Switching >::iterator com::bbc::libmpdpp::RepresentationBase::switchingsBegin ( )

inline

Get an iterator referencing the start of the switchings list

Returns: An iterator referencing the start of the switchings list.

◆ switchingsBegin() [2/2]

std::list< Switching >::const_iterator com::bbc::libmpdpp::RepresentationBase::switchingsBegin ( ) const

inline

Get an iterator referencing the start of the switchings list

Returns: An iterator referencing the start of the switchings list.

◆ switchingsEnd() [1/2]

std::list< Switching >::iterator com::bbc::libmpdpp::RepresentationBase::switchingsEnd ( )

inline

Get an iterator referencing the end of the switchings list

Returns: An iterator referencing the end of the switchings list.

◆ switchingsEnd() [2/2]

std::list< Switching >::const_iterator com::bbc::libmpdpp::RepresentationBase::switchingsEnd ( ) const

inline

Get an iterator referencing the end of the switchings list

Returns: An iterator referencing the end of the switchings list.

◆ switchingsRemove() [1/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::switchingsRemove ( const std::list< Switching >::const_iterator & it )

Remove an entry to the switchings list by iterator

Parameters

it	An iterator referencing an entry from the switchings list.

Returns: This RepresentationBase.

◆ switchingsRemove() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::switchingsRemove ( const std::list< Switching >::iterator & it )

Remove an entry to the switchings list by iterator

Parameters

it	An iterator referencing an entry from the switchings list.

Returns: This RepresentationBase.

◆ switchingsRemove() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::switchingsRemove ( const Switching & val )

Remove an entry to the switchings list by value

Parameters

val	The switching to remove from the switchings list.

Returns: This RepresentationBase.

◆ tag() [1/6]

const std::optional< std::string > & com::bbc::libmpdpp::RepresentationBase::tag ( ) const

inline

Get the optional @tag attribute value

Returns: The optional @tag attribute value.

◆ tag() [2/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::tag ( const std::nullopt_t & )

inline

Unset the @tag attribute value

Returns: This RepresentationBase.

◆ tag() [3/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::tag ( const std::optional< std::string > & val )

inline

Set the @tag attribute value

Parameters

val	The value to set for the @tag attribute

Returns: This RepresentationBase.

◆ tag() [4/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::tag ( const std::string & val )

inline

Set the @tag attribute value

Parameters

val	The value to set for the @tag attribute

Returns: This RepresentationBase.

◆ tag() [5/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::tag ( std::optional< std::string > && val )

inline

Set the @tag attribute value

Parameters

val	The value to set for the @tag attribute

Returns: This RepresentationBase.

◆ tag() [6/6]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::tag ( std::string && val )

inline

Set the @tag attribute value

Parameters

val	The value to set for the @tag attribute

Returns: This RepresentationBase.

◆ width() [1/3]

const std::optional< unsigned int > & com::bbc::libmpdpp::RepresentationBase::width ( ) const

inline

Get the optional @width attribute value

Returns: The optional @width attribute value.

◆ width() [2/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::width ( const std::nullopt_t & )

inline

Unset the optional @width attribute value

Returns: This RepresentationBase.

◆ width() [3/3]

RepresentationBase & com::bbc::libmpdpp::RepresentationBase::width ( unsigned int val )

inline

Set the @width attribute value

Parameters

val	The value to set in the @width attribute.

Returns: This RepresentationBase.

The documentation for this class was generated from the following file:

libmpd++/RepresentationBase.hh

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ VideoScan

Constructor & Destructor Documentation

◆ RepresentationBase() [1/3]

◆ RepresentationBase() [2/3]

◆ RepresentationBase() [3/3]

◆ ~RepresentationBase()

Member Function Documentation

◆ audioChannelConfiguration()

◆ audioChannelConfigurations() [1/3]

◆ audioChannelConfigurations() [2/3]

◆ audioChannelConfigurations() [3/3]

◆ audioChannelConfigurationsAdd() [1/2]

◆ audioChannelConfigurationsAdd() [2/2]

◆ audioChannelConfigurationsBegin() [1/2]

◆ audioChannelConfigurationsBegin() [2/2]

◆ audioChannelConfigurationsEnd() [1/2]

◆ audioChannelConfigurationsEnd() [2/2]

◆ audioChannelConfigurationsRemove() [1/3]

◆ audioChannelConfigurationsRemove() [2/3]

◆ audioChannelConfigurationsRemove() [3/3]

◆ audioSamplingRate()

◆ audioSamplingRates() [1/3]

◆ audioSamplingRates() [2/3]

◆ audioSamplingRates() [3/3]

◆ audioSamplingRatesAdd()

◆ audioSamplingRatesBegin() [1/2]

◆ audioSamplingRatesBegin() [2/2]

◆ audioSamplingRatesEnd() [1/2]

◆ audioSamplingRatesEnd() [2/2]

◆ audioSamplingRatesRemove() [1/3]

◆ audioSamplingRatesRemove() [2/3]

◆ audioSamplingRatesRemove() [3/3]

◆ codecs() [1/6]

◆ codecs() [2/6]

◆ codecs() [3/6]

◆ codecs() [4/6]

◆ codecs() [5/6]

◆ codecs() [6/6]

◆ codingDependency() [1/5]

◆ codingDependency() [2/5]

◆ codingDependency() [3/5]

◆ codingDependency() [4/5]

◆ codingDependency() [5/5]

◆ containerProfile()

◆ containerProfiles() [1/3]

◆ containerProfiles() [2/3]

◆ containerProfiles() [3/3]

◆ containerProfilesAdd() [1/2]

◆ containerProfilesAdd() [2/2]

◆ containerProfilesBegin() [1/2]

◆ containerProfilesBegin() [2/2]

◆ containerProfilesEnd() [1/2]

◆ containerProfilesEnd() [2/2]

◆ containerProfilesRemove() [1/3]

◆ containerProfilesRemove() [2/3]

◆ containerProfilesRemove() [3/3]

◆ contentPopularityRate()

◆ contentPopularityRates() [1/3]

◆ contentPopularityRates() [2/3]

◆ contentPopularityRates() [3/3]

◆ contentPopularityRatesAdd() [1/2]

◆ contentPopularityRatesAdd() [2/2]

◆ contentPopularityRatesBegin() [1/2]

◆ contentPopularityRatesBegin() [2/2]

◆ contentPopularityRatesEnd() [1/2]

◆ contentPopularityRatesEnd() [2/2]

◆ contentPopularityRatesRemove() [1/3]

◆ contentPopularityRatesRemove() [2/3]

◆ contentPopularityRatesRemove() [3/3]

◆ contentProtection()

◆ contentProtections() [1/3]

◆ contentProtections() [2/3]

◆ contentProtections() [3/3]

◆ contentProtectionsAdd() [1/2]

◆ contentProtectionsAdd() [2/2]

◆ contentProtectionsBegin() [1/2]