#include <libmpd++/Representation.hh>

Inheritance diagram for com::bbc::libmpdpp::Representation:

Collaboration diagram for com::bbc::libmpdpp::Representation:

Public Types
using	time_type = std::chrono::system_clock::time_point
	The type used to represent date-time values in this class.

using	duration_type = std::chrono::microseconds
	The type used to represent duration values in this class.

Public Types inherited from com::bbc::libmpdpp::RepresentationBase
enum	VideoScan { VIDEO_SCAN_PROGRESSIVE , VIDEO_SCAN_INTERLACED , VIDEO_SCAN_UNKNOWN }

Public Member Functions
	Representation ()

	Representation (const Representation &to_copy)

	Representation (Representation &&to_move)

virtual	~Representation ()

Representation &	operator= (const Representation &to_copy)

Representation &	operator= (Representation &&to_move)

bool	operator== (const Representation &to_compare) const

const std::string &	id () const

Representation &	id (const std::string &id)

Representation &	id (std::string &&id)

unsigned int	bandwidth () const

Representation &	bandwidth (unsigned int bandwidth)

bool	hasQualityRanking () const

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

Representation &	qualityRanking (const std::nullopt_t &)

Representation &	qualityRanking (unsigned int qual_rank)

Representation &	qualityRanking (const std::optional< unsigned int > &qual_rank)

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

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

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

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

URI	getMediaURL (unsigned long segment_number) const

URI	getMediaURL (time_type segment_time) const

URI	getInitializationURL () const

std::list< BaseURL >	getBaseURLs () const

bool	isSelected () const

SegmentAvailability	segmentAvailability (const time_type &query_time) const

SegmentAvailability	initialisationSegmentAvailability () const


MPD *	getMPD ()

const MPD *	getMPD () const


Period *	getPeriod ()

const Period *	getPeriod () const


AdaptationSet *	getAdaptationSet ()

const AdaptationSet *	getAdaptationSet () const

Public Member Functions inherited from com::bbc::libmpdpp::RepresentationBase
	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

Representation class

This is the container for Representation elements from an MPD and follows the schema description of RepresentationType from ISO 23009-1:2022 Clause 5.3.5.3.

Member Typedef Documentation

◆ duration_type

using com::bbc::libmpdpp::Representation::duration_type = std::chrono::microseconds

The type used to represent duration values in this class.

◆ time_type

using com::bbc::libmpdpp::Representation::time_type = std::chrono::system_clock::time_point

The type used to represent date-time values in this class.

Constructor & Destructor Documentation

◆ Representation() [1/3]

com::bbc::libmpdpp::Representation::Representation ( )

Default constructor

Create an empty Representation object

◆ Representation() [2/3]

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

Copy constructor

Create a new Representation as a copy of to_copy.

Parameters

to_copy The Representation object to copy into the new Representation.

◆ Representation() [3/3]

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

Move constructor

Create a new Representation using the values and resources of to_move.

Parameters

to_move The Representation object take the values and resources from to create the new Representation.

◆ ~Representation()

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

inlinevirtual

Destructor

Member Function Documentation

◆ associationId()

const std::list< std::string > & com::bbc::libmpdpp::Representation::associationId ( ) const

inline

◆ associationType()

const std::list< std::string > & com::bbc::libmpdpp::Representation::associationType ( ) const

inline

◆ bandwidth() [1/2]

unsigned int com::bbc::libmpdpp::Representation::bandwidth ( ) const

inline

◆ bandwidth() [2/2]

Representation & com::bbc::libmpdpp::Representation::bandwidth ( unsigned int bandwidth )

inline

◆ dependencyId()

const std::list< std::string > & com::bbc::libmpdpp::Representation::dependencyId ( ) const

inline

◆ getAdaptationSet() [1/2]

AdaptationSet * com::bbc::libmpdpp::Representation::getAdaptationSet ( )

inline

Get the AdaptationSet this Representation is attached to

Gets the AdaptationSet object that this Representation is a child of. If the Representation has not been added to an AdaptationSet then nullptr is returned.

Returns: The AdaptationSet this Representation is part of or nullptr.

◆ getAdaptationSet() [2/2]

const AdaptationSet * com::bbc::libmpdpp::Representation::getAdaptationSet ( ) const

inline

Get the AdaptationSet this Representation is attached to

Gets the AdaptationSet object that this Representation is a child of. If the Representation has not been added to an AdaptationSet then nullptr is returned.

Returns: The AdaptationSet this Representation is part of or nullptr.

◆ getBaseURLs()

std::list< BaseURL > com::bbc::libmpdpp::Representation::getBaseURLs ( ) const

Get the list of relevant BaseURLs

Get the list of relevant BaseURLs, resolved to absolute URLs when possible.

Returns: A list of resolves BaseURLs that apply at for this Representation.

◆ getInitializationURL()

URI com::bbc::libmpdpp::Representation::getInitializationURL ( ) const

Get initialisation segment URL

Get the initialisation segment URL.

Returns: The initialisation segment URL or an empty URL if no segment information is available.

◆ getMediaURL() [1/2]

URI com::bbc::libmpdpp::Representation::getMediaURL ( time_type segment_time ) const

Get media URL

Get the media URL for a given segment_number.

Parameters

segment_time The segment time to fetch the URL for.

Returns: The media segment URL or an empty URL if the segment is unknown.

◆ getMediaURL() [2/2]

URI com::bbc::libmpdpp::Representation::getMediaURL ( unsigned long segment_number ) const

Get media URL

Get the media URL for a given segment_number.

Parameters

segment_number The segment number to fetch the URL for.

Returns: The media segment URL or an empty URL if the segment is unknown.

◆ getMPD() [1/2]

MPD * com::bbc::libmpdpp::Representation::getMPD ( )

Get the MPD this Representation is attached to

Gets the MPD object this Representation is attached to. This is the equivalent of:

getAdaptationSet() ? getAdaptationSet()->getMPD() : nullptr

com::bbc::libmpdpp::AdaptationSet::getMPD

MPD * getMPD()

com::bbc::libmpdpp::Representation::getAdaptationSet

AdaptationSet * getAdaptationSet()

Definition Representation.hh:170

Returns: The MPD this Representation is part of or nullptr

◆ getMPD() [2/2]

const MPD * com::bbc::libmpdpp::Representation::getMPD ( ) const

Get the MPD this Representation is attached to

Gets the MPD object this Representation is attached to. This is the equivalent of:

getAdaptationSet() ? getAdaptationSet()->getMPD() : nullptr

Returns: The MPD this Representation is part of or nullptr

◆ getPeriod() [1/2]

Period * com::bbc::libmpdpp::Representation::getPeriod ( )

Get the Period this Representation is attached to

Gets the Period object this Representation is attached to. This is the equivalent of:

getAdaptationSet() ? getAdaptationSet()->getPeriod() : nullptr

com::bbc::libmpdpp::AdaptationSet::getPeriod

Period * getPeriod()

Definition AdaptationSet.hh:141

Returns: The Period this Representation is part of or nullptr.

◆ getPeriod() [2/2]

const Period * com::bbc::libmpdpp::Representation::getPeriod ( ) const

Get the Period this Representation is attached to

Gets the Period object this Representation is attached to. This is the equivalent of:

getAdaptationSet() ? getAdaptationSet()->getPeriod() : nullptr

Returns: The Period this Representation is part of or nullptr.

◆ hasQualityRanking()

bool com::bbc::libmpdpp::Representation::hasQualityRanking ( ) const

inline

◆ id() [1/3]

const std::string & com::bbc::libmpdpp::Representation::id ( ) const

inline

◆ id() [2/3]

Representation & com::bbc::libmpdpp::Representation::id ( const std::string & id )

inline

◆ id() [3/3]

Representation & com::bbc::libmpdpp::Representation::id ( std::string && id )

inline

◆ initialisationSegmentAvailability()

SegmentAvailability com::bbc::libmpdpp::Representation::initialisationSegmentAvailability ( ) const

Get the segment availability information of the initialisation segment

This returns the full segment availability information for the initialisation segment. If no initialization segment is available then the SegmentAvailability object returned will have an empty URL.

Returns: The SegmentAvailability for the initialisation segment or an empty SegmentAvailability if no initialisation segment is available.

◆ isSelected()

bool com::bbc::libmpdpp::Representation::isSelected ( ) const

Is this Representation selected by its AdaptationSet?

Returns: true if the Representation is selected in its AdaptationSet.

◆ mediaStreamStructureId()

const std::list< std::string > & com::bbc::libmpdpp::Representation::mediaStreamStructureId ( ) const

inline

◆ operator=() [1/2]

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

Copy operator

Make this Representation a copy of to_copy.

Parameters

to_copy The Representation object to copy into this Representation.

Returns: This Representation.

◆ operator=() [2/2]

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

Move operator

Make this Representation a copy of to_move by moving the values and resources.

Parameters

to_move The Representation object to move into this Representation.

Returns: This Representation.

◆ operator==()

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

Equality operator

Check if to_compare contains the same value as this Representation.

Parameters

to_compare The other Representation to compare to this Representation.

Returns: true if the values match, otherwise false.

◆ qualityRanking() [1/4]

const std::optional< unsigned int > & com::bbc::libmpdpp::Representation::qualityRanking ( ) const

inline

◆ qualityRanking() [2/4]

Representation & com::bbc::libmpdpp::Representation::qualityRanking ( const std::nullopt_t & )

inline

◆ qualityRanking() [3/4]

Representation & com::bbc::libmpdpp::Representation::qualityRanking ( const std::optional< unsigned int > & qual_rank )

inline

◆ qualityRanking() [4/4]

Representation & com::bbc::libmpdpp::Representation::qualityRanking ( unsigned int qual_rank )

inline

◆ segmentAvailability()

SegmentAvailability com::bbc::libmpdpp::Representation::segmentAvailability ( const time_type & query_time ) const

Get the full segment availability information

This returns the full segment availability information for the first segment on or after the query_time provided.

If no segment is available then the SegmentAvailability object returned will have an empty URL.

Parameters

query_time The system wallclock time we are querying for.

Returns: The SegmentAvailability for the next available segment or an empty SegmentAvailability if no segment is available.

The documentation for this class was generated from the following file:

libmpd++/Representation.hh

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ duration_type

◆ time_type

Constructor & Destructor Documentation

◆ Representation() [1/3]

◆ Representation() [2/3]

◆ Representation() [3/3]

◆ ~Representation()

Member Function Documentation

◆ associationId()

◆ associationType()

◆ bandwidth() [1/2]

◆ bandwidth() [2/2]

◆ dependencyId()

◆ getAdaptationSet() [1/2]

◆ getAdaptationSet() [2/2]

◆ getBaseURLs()

◆ getInitializationURL()

◆ getMediaURL() [1/2]

◆ getMediaURL() [2/2]

◆ getMPD() [1/2]

◆ getMPD() [2/2]

◆ getPeriod() [1/2]

◆ getPeriod() [2/2]

◆ hasQualityRanking()

◆ id() [1/3]

◆ id() [2/3]

◆ id() [3/3]

◆ initialisationSegmentAvailability()

◆ isSelected()

◆ mediaStreamStructureId()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ qualityRanking() [1/4]

◆ qualityRanking() [2/4]

◆ qualityRanking() [3/4]

◆ qualityRanking() [4/4]

◆ segmentAvailability()