libmpd++
DASH MPD parsing and manipulation library
 
Loading...
Searching...
No Matches
com::bbc::libmpdpp::AdaptationSet Class Reference

AdaptationSet class. More...

#include <libmpd++/AdaptationSet.hh>

Inheritance diagram for com::bbc::libmpdpp::AdaptationSet:
Collaboration diagram for com::bbc::libmpdpp::AdaptationSet:

Public Types

using time_type = std::chrono::system_clock::time_point
 Date-time type.
 
using duration_type = std::chrono::microseconds
 Time duration type.
 
- Public Types inherited from com::bbc::libmpdpp::RepresentationBase
enum  VideoScan { VIDEO_SCAN_PROGRESSIVE , VIDEO_SCAN_INTERLACED , VIDEO_SCAN_UNKNOWN }
 

Public Member Functions

 AdaptationSet ()
 
 AdaptationSet (const AdaptationSet &other)
 
 AdaptationSet (AdaptationSet &&other)
 
virtual ~AdaptationSet ()
 
AdaptationSetoperator= (const AdaptationSet &other)
 
AdaptationSetoperator= (AdaptationSet &&other)
 
bool operator== (const AdaptationSet &other) const
 
bool hasId () const
 
const std::optional< unsigned int > & id () const
 
AdaptationSetid (const std::nullopt_t &)
 
AdaptationSetid (unsigned int id)
 
AdaptationSetid (const std::optional< unsigned int > &id)
 
AdaptationSetid (std::optional< unsigned int > &&id)
 
bool hasGroup () const
 
const std::optional< unsigned int > & group () const
 
AdaptationSetgroup (const std::nullopt_t &)
 
AdaptationSetgroup (unsigned int group)
 
AdaptationSetgroup (const std::optional< unsigned int > &group)
 
AdaptationSetgroup (std::optional< unsigned int > &&group)
 
bool hasLang () const
 
const std::optional< std::string > & lang () const
 
AdaptationSetlang (const std::nullopt_t &)
 
AdaptationSetlang (const std::string &lang)
 
AdaptationSetlang (std::string &&lang)
 
AdaptationSetlang (const std::optional< std::string > &lang)
 
AdaptationSetlang (std::optional< std::string > &&lang)
 
bool hasContentType () const
 
const std::optional< RFC6838ContentType > & contentType () const
 
AdaptationSetcontentType (const std::nullopt_t &)
 
AdaptationSetcontentType (const RFC6838ContentType &content_type)
 
AdaptationSetcontentType (RFC6838ContentType &&content_type)
 
AdaptationSetcontentType (const std::optional< RFC6838ContentType > &content_type)
 
AdaptationSetcontentType (std::optional< RFC6838ContentType > &&content_type)
 
bool hasPar () const
 
const std::optional< Ratio > & par () const
 
AdaptationSetpar (const std::nullopt_t &)
 
AdaptationSetpar (const Ratio &par)
 
AdaptationSetpar (Ratio &&par)
 
AdaptationSetpar (const std::optional< Ratio > &par)
 
AdaptationSetpar (std::optional< Ratio > &&par)
 
bool hasMinBandwidth () const
 
const std::optional< unsigned int > & minBandwidth () const
 
AdaptationSetminBandwidth (const std::nullopt_t &)
 
AdaptationSetminBandwidth (unsigned int min_bandwidth)
 
AdaptationSetminBandwidth (const std::optional< unsigned int > &min_bandwidth)
 
AdaptationSetminBandwidth (std::optional< unsigned int > &&min_bandwidth)
 
bool hasMaxBandwidth () const
 
const std::optional< unsigned int > & maxBandwidth () const
 
AdaptationSetmaxBandwidth (const std::nullopt_t &)
 
AdaptationSetmaxBandwidth (unsigned int max_bandwidth)
 
AdaptationSetmaxBandwidth (const std::optional< unsigned int > &max_bandwidth)
 
AdaptationSetmaxBandwidth (std::optional< unsigned int > &&max_bandwidth)
 
bool hasMinWidth () const
 
const std::optional< unsigned int > & minWidth () const
 
AdaptationSetminWidth (const std::nullopt_t &)
 
AdaptationSetminWidth (unsigned int min_width)
 
AdaptationSetminWidth (const std::optional< unsigned int > &min_width)
 
AdaptationSetminWidth (std::optional< unsigned int > &&min_width)
 
bool hasMaxWidth () const
 
const std::optional< unsigned int > & maxWidth () const
 
AdaptationSetmaxWidth (const std::nullopt_t &)
 
AdaptationSetmaxWidth (unsigned int max_width)
 
AdaptationSetmaxWidth (const std::optional< unsigned int > &max_width)
 
AdaptationSetmaxWidth (std::optional< unsigned int > &&max_width)
 
bool hasMinHeight () const
 
const std::optional< unsigned int > & minHeight () const
 
AdaptationSetminHeight (const std::nullopt_t &)
 
AdaptationSetminHeight (unsigned int min_height)
 
AdaptationSetminHeight (const std::optional< unsigned int > &min_height)
 
AdaptationSetminHeight (std::optional< unsigned int > &&min_height)
 
bool hasMaxHeight () const
 
const std::optional< unsigned int > & maxHeight () const
 
AdaptationSetmaxHeight (const std::nullopt_t &)
 
AdaptationSetmaxHeight (unsigned int max_height)
 
AdaptationSetmaxHeight (const std::optional< unsigned int > &max_height)
 
AdaptationSetmaxHeight (std::optional< unsigned int > &&max_height)
 
bool hasMinFrameRate () const
 
const std::optional< FrameRate > & minFrameRate () const
 
AdaptationSetminFrameRate (const std::nullopt_t &)
 
AdaptationSetminFrameRate (const FrameRate &min_frame_rate)
 
AdaptationSetminFrameRate (FrameRate &&min_frame_rate)
 
AdaptationSetminFrameRate (const std::optional< FrameRate > &min_frame_rate)
 
AdaptationSetminFrameRate (std::optional< FrameRate > &&min_frame_rate)
 
bool hasMaxFrameRate () const
 
const std::optional< FrameRate > & maxFrameRate () const
 
AdaptationSetmaxFrameRate (const std::nullopt_t &)
 
AdaptationSetmaxFrameRate (const FrameRate &max_frame_rate)
 
AdaptationSetmaxFrameRate (FrameRate &&max_frame_rate)
 
AdaptationSetmaxFrameRate (const std::optional< FrameRate > &max_frame_rate)
 
AdaptationSetmaxFrameRate (std::optional< FrameRate > &&max_frame_rate)
 
bool segmentAlignment () const
 
AdaptationSetsegmentAlignment (bool segment_alignment)
 
bool subsegmentAlignment () const
 
AdaptationSetsubsegmentAlignment (bool subsegment_alignment)
 
const SAPsubsegmentStartsWithSAP () const
 
AdaptationSetsubsegmentStartsWithSAP (const SAP &subsegment_starts_with_sap)
 
AdaptationSetsubsegmentStartsWithSAP (SAP &&subsegment_starts_with_sap)
 
bool hasBitstreamSwitching () const
 
const std::optional< bool > & bitstreamSwitching () const
 
AdaptationSetbitstreamSwitching (const std::nullopt_t &)
 
AdaptationSetbitstreamSwitching (bool bitstream_switching)
 
AdaptationSetbitstreamSwitching (const std::optional< bool > &bitstream_switching)
 
AdaptationSetbitstreamSwitching (std::optional< bool > &&bitstream_switching)
 
const std::list< unsigned int > & initializationSetRefs () const
 
unsigned int initializationSetRef (std::list< unsigned int >::size_type idx) const
 
bool initializationSetRefsContains (unsigned int ref) const
 
AdaptationSetinitializationSetRefAdd (unsigned int ref)
 
AdaptationSetinitializationSetRefRemove (unsigned int ref)
 
AdaptationSetinitializationSetRefs (const std::list< unsigned int > &initialization_set_refs)
 
AdaptationSetinitializationSetRefs (std::list< unsigned int > &&initialization_set_refs)
 
bool hasInitializationPrincipal () const
 
const std::optional< URI > & initializationPrincipal () const
 
AdaptationSetinitializationPrincipal (const std::nullopt_t &)
 
AdaptationSetinitializationPrincipal (const URI &initialization_principal)
 
AdaptationSetinitializationPrincipal (URI &&initialization_principal)
 
AdaptationSetinitializationPrincipal (const std::optional< URI > &initialization_principal)
 
AdaptationSetinitializationPrincipal (std::optional< URI > &&initialization_principal)
 
const std::list< Descriptor > & accessibilities () const
 
const Descriptoraccessibility (std::list< Descriptor >::size_type idx) const
 
bool accessibilitiesContains (const Descriptor &descriptor) const
 
AdaptationSetaccessibilitiesRemove (const Descriptor &accessibility)
 
const std::list< Descriptor > & roles () const
 
const Descriptorrole (std::list< Descriptor >::size_type idx) const
 
bool rolesContains (const Descriptor &descriptor) const
 
AdaptationSetrolesRemove (const Descriptor &role)
 
const std::list< Descriptor > & ratings () const
 
const Descriptorrating (std::list< Descriptor >::size_type idx) const
 
bool ratingsContains (const Descriptor &descriptor) const
 
AdaptationSetratingsRemove (const Descriptor &rating)
 
const std::list< Descriptor > & viewpoints () const
 
const Descriptorviewpoint (std::list< Descriptor >::size_type idx) const
 
bool viewpointsContains (const Descriptor &descriptor) const
 
AdaptationSetviewpointsRemove (const Descriptor &viewpoint)
 
const std::list< ContentComponent > & contentComponents () const
 
const ContentComponentcontentComponent (std::list< ContentComponent >::size_type idx) const
 
bool contentComponentsContains (const ContentComponent &content_component) const
 
AdaptationSetcontentComponentsRemove (const ContentComponent &content_component)
 
const std::list< BaseURL > & baseURLs () const
 
const BaseURLbaseURL (std::list< BaseURL >::size_type idx) const
 
bool baseURLsContains (const BaseURL &base_url) const
 
AdaptationSetbaseURLsRemove (const BaseURL &base_url)
 
std::list< BaseURLgetBaseURLs () const
 
bool hasSegmentBase () const
 
const std::optional< SegmentBase > & segmentBase () const
 
AdaptationSetsegmentBase (const std::nullopt_t &)
 
AdaptationSetsegmentBase (const SegmentBase &seg_base)
 
AdaptationSetsegmentBase (SegmentBase &&seg_base)
 
bool hasSegmentList () const
 
const std::optional< SegmentList > & segmentList () const
 
AdaptationSetsegmentList (const std::nullopt_t &)
 
AdaptationSetsegmentList (const SegmentList &seg_list)
 
AdaptationSetsegmentList (SegmentList &&seg_list)
 
bool hasSegmentTemplate () const
 
const std::optional< SegmentTemplate > & segmentTemplate () const
 
AdaptationSetsegmentTemplate (const std::nullopt_t &)
 
AdaptationSetsegmentTemplate (const SegmentTemplate &seg_template)
 
AdaptationSetsegmentTemplate (SegmentTemplate &&seg_template)
 
const std::list< Representation > & representations () const
 
const Representationrepresentation (std::list< Representation >::size_type idx) const
 
bool representationsContains (const Representation &representation) const
 
AdaptationSetrepresentationsRemove (const Representation &representation)
 
void selectAllRepresentations ()
 
void selectRepresentation (const Representation &rep, bool deselect_others=false)
 
void deselectAllRepresentations ()
 
void deselectRepresentation (const Representation &rep)
 
const std::unordered_set< const Representation * > & selectedRepresentations () const
 
std::list< SegmentAvailabilityselectedSegmentAvailability (const time_type &query_time) const
 
std::list< SegmentAvailabilityselectedInitializationSegments () const
 
MPDgetMPD ()
 
const MPDgetMPD () const
 
PeriodgetPeriod ()
 
const PeriodgetPeriod () const
 
std::list< unsignedint >::const_iterator initializationSetRefsBegin () const
 
std::list< unsignedint >::iterator initializationSetRefsBegin ()
 
std::list< unsignedint >::const_iterator initializationSetRefsEnd () const
 
std::list< unsignedint >::iterator initializationSetRefsEnd ()
 
AdaptationSetinitializationSetRefRemove (const std::list< unsigned int >::const_iterator &it)
 
AdaptationSetinitializationSetRefRemove (const std::list< unsigned int >::iterator &it)
 
std::list< Descriptor >::const_iterator accessibilitiesBegin () const
 
std::list< Descriptor >::iterator accessibilitiesBegin ()
 
std::list< Descriptor >::const_iterator accessibilitiesEnd () const
 
std::list< Descriptor >::iterator accessibilitiesEnd ()
 
AdaptationSetaccessibilitiesAdd (const Descriptor &accessibility)
 
AdaptationSetaccessibilitiesAdd (Descriptor &&accessibility)
 
AdaptationSetaccessibilitiesRemove (const std::list< Descriptor >::const_iterator &it)
 
AdaptationSetaccessibilitiesRemove (const std::list< Descriptor >::iterator &it)
 
std::list< Descriptor >::const_iterator rolesBegin () const
 
std::list< Descriptor >::iterator rolesBegin ()
 
std::list< Descriptor >::const_iterator rolesEnd () const
 
std::list< Descriptor >::iterator rolesEnd ()
 
AdaptationSetrolesAdd (const Descriptor &role)
 
AdaptationSetrolesAdd (Descriptor &&role)
 
AdaptationSetrolesRemove (const std::list< Descriptor >::const_iterator &it)
 
AdaptationSetrolesRemove (const std::list< Descriptor >::iterator &it)
 
std::list< Descriptor >::const_iterator ratingsBegin () const
 
std::list< Descriptor >::iterator ratingsBegin ()
 
std::list< Descriptor >::const_iterator ratingsEnd () const
 
std::list< Descriptor >::iterator ratingsEnd ()
 
AdaptationSetratingsAdd (const Descriptor &rating)
 
AdaptationSetratingsAdd (Descriptor &&rating)
 
AdaptationSetratingsRemove (const std::list< Descriptor >::const_iterator &it)
 
AdaptationSetratingsRemove (const std::list< Descriptor >::iterator &it)
 
std::list< Descriptor >::const_iterator viewpointsBegin () const
 
std::list< Descriptor >::iterator viewpointsBegin ()
 
std::list< Descriptor >::const_iterator viewpointsEnd () const
 
std::list< Descriptor >::iterator viewpointsEnd ()
 
AdaptationSetviewpointsAdd (const Descriptor &viewpoint)
 
AdaptationSetviewpointsAdd (Descriptor &&viewpoint)
 
AdaptationSetviewpointsRemove (const std::list< Descriptor >::const_iterator &it)
 
AdaptationSetviewpointsRemove (const std::list< Descriptor >::iterator &it)
 
std::list< ContentComponent >::const_iterator contentComponentsBegin () const
 
std::list< ContentComponent >::iterator contentComponentsBegin ()
 
std::list< ContentComponent >::const_iterator contentComponentsEnd () const
 
std::list< ContentComponent >::iterator contentComponentsEnd ()
 
AdaptationSetcontentComponentsAdd (const ContentComponent &content_component)
 
AdaptationSetcontentComponentsAdd (ContentComponent &&content_component)
 
AdaptationSetcontentComponentsRemove (const std::list< ContentComponent >::const_iterator &it)
 
AdaptationSetcontentComponentsRemove (const std::list< ContentComponent >::iterator &it)
 
std::list< BaseURL >::const_iterator baseURLsBegin () const
 
std::list< BaseURL >::iterator baseURLsBegin ()
 
std::list< BaseURL >::const_iterator baseURLsEnd () const
 
std::list< BaseURL >::iterator baseURLsEnd ()
 
AdaptationSetbaseURLsAdd (const BaseURL &base_url)
 
AdaptationSetbaseURLsAdd (BaseURL &&base_url)
 
AdaptationSetbaseURLsRemove (const std::list< BaseURL >::const_iterator &it)
 
AdaptationSetbaseURLsRemove (const std::list< BaseURL >::iterator &it)
 
AdaptationSetsegmentBase (const std::optional< SegmentBase > &seg_base)
 
AdaptationSetsegmentBase (std::optional< SegmentBase > &&seg_base)
 
AdaptationSetsegmentList (const std::optional< SegmentList > &seg_list)
 
AdaptationSetsegmentList (std::optional< SegmentList > &&seg_list)
 
AdaptationSetsegmentTemplate (const std::optional< SegmentTemplate > &seg_template)
 
AdaptationSetsegmentTemplate (std::optional< SegmentTemplate > &&seg_template)
 
std::list< Representation >::const_iterator representationsBegin () const
 
std::list< Representation >::iterator representationsBegin ()
 
std::list< Representation >::const_iterator representationsEnd () const
 
std::list< Representation >::iterator representationsEnd ()
 
AdaptationSetrepresentationsAdd (const Representation &representation)
 
AdaptationSetrepresentationsAdd (Representation &&representation)
 
AdaptationSetrepresentationsRemove (const std::list< Representation >::const_iterator &it)
 
AdaptationSetrepresentationsRemove (const std::list< Representation >::iterator &it)
 
void selectRepresentation (const std::list< Representation >::const_iterator &rep_it, bool deselect_others=false)
 
void selectRepresentation (const std::list< Representation >::iterator &rep_it, bool deselect_others=false)
 
void deselectRepresentation (const std::list< Representation >::const_iterator &rep_it)
 
void deselectRepresentation (const std::list< Representation >::iterator &rep_it)
 
- Public Member Functions inherited from com::bbc::libmpdpp::RepresentationBase
 RepresentationBase ()
 
 RepresentationBase (const RepresentationBase &to_copy)
 
 RepresentationBase (RepresentationBase &&to_move)
 
virtual ~RepresentationBase ()
 
RepresentationBaseoperator= (const RepresentationBase &to_copy)
 
RepresentationBaseoperator= (RepresentationBase &&to_move)
 
bool operator== (const RepresentationBase &to_compare) const
 
const std::list< URI > & profiles () const
 
const URIprofile (std::list< URI >::size_type idx) const
 
RepresentationBaseprofilesRemove (const URI &val)
 
bool hasWidth () const
 
const std::optional< unsigned int > & width () const
 
RepresentationBasewidth (const std::nullopt_t &)
 
RepresentationBasewidth (unsigned int val)
 
bool hasHeight () const
 
const std::optional< unsigned int > & height () const
 
RepresentationBaseheight (const std::nullopt_t &)
 
bool hasSar () const
 
const std::optional< Ratio > & sar () const
 
RepresentationBasesar (const std::nullopt_t &)
 
bool hasFrameRate () const
 
const std::optional< FrameRate > & frameRate () const
 
RepresentationBaseframeRate (const std::nullopt_t &)
 
RepresentationBaseframeRate (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
 
RepresentationBaseaudioSamplingRatesAdd (unsigned int val)
 
RepresentationBaseaudioSamplingRatesRemove (unsigned int val)
 
bool hasMimeType () const
 
const std::optional< std::string > & mimeType () const
 
RepresentationBasemimeType (const std::nullopt_t &)
 
const std::list< std::string > & segmentProfiles () const
 
const std::string & segmentProfile (std::list< std::string >::size_type idx) const
 
RepresentationBasesegmentProfilesRemove (const std::string &val)
 
bool hasCodecs () const
 
const std::optional< Codecs > & codecs () const
 
RepresentationBasecodecs (const std::nullopt_t &)
 
const std::list< std::string > & containerProfiles () const
 
const std::string & containerProfile (std::list< std::string >::size_type idx) const
 
RepresentationBasecontainerProfilesRemove (const std::string &val)
 
bool hasMaximumSAPPeriod () const
 
const std::optional< double > & maximumSAPPeriod () const
 
RepresentationBasemaximumSAPPeriod (const std::nullopt_t &)
 
bool hasStartWithSAP () const
 
const std::optional< SAP > & startWithSAP () const
 
RepresentationBasestartWithSAP (const std::nullopt_t &)
 
bool hasMaxPlayoutRate () const
 
const std::optional< double > & maxPlayoutRate () const
 
RepresentationBasemaxPlayoutRate (const std::nullopt_t &)
 
bool hasCodingDependency () const
 
const std::optional< bool > & codingDependency () const
 
RepresentationBasecodingDependency (const std::nullopt_t &)
 
bool hasScanType () const
 
const std::optional< VideoScan > & scanType () const
 
RepresentationBasescanType (const std::nullopt_t &)
 
unsigned int selectionPriority () const
 
RepresentationBaseselectionPriority (unsigned int val)
 
bool hasTag () const
 
const std::optional< std::string > & tag () const
 
RepresentationBasetag (const std::nullopt_t &)
 
const std::list< Descriptor > & framePackings () const
 
const DescriptorframePacking (std::list< Descriptor >::size_type idx) const
 
RepresentationBaseframePackingsRemove (const Descriptor &val)
 
const std::list< Descriptor > & audioChannelConfigurations () const
 
const DescriptoraudioChannelConfiguration (std::list< Descriptor >::size_type idx) const
 
RepresentationBaseaudioChannelConfigurationsRemove (const Descriptor &val)
 
const std::list< ContentProtection > & contentProtections () const
 
const ContentProtectioncontentProtection (std::list< ContentProtection >::size_type idx) const
 
RepresentationBasecontentProtectionsRemove (const ContentProtection &val)
 
bool hasOutputProtection () const
 
const std::optional< Descriptor > & outputProtection () const
 
RepresentationBaseoutputProtection (const std::nullopt_t &)
 
const std::list< Descriptor > & essentialProperties () const
 
const DescriptoressentialProperty (std::list< Descriptor >::size_type idx) const
 
RepresentationBaseessentialPropertiesRemove (const Descriptor &val)
 
const std::list< Descriptor > & supplementalProperties () const
 
const DescriptorsupplementalProperty (std::list< Descriptor >::size_type idx) const
 
RepresentationBasesupplementalPropertiesRemove (const Descriptor &val)
 
const std::list< EventStream > & inbandEventStreams () const
 
const EventStreaminbandEventStream (std::list< EventStream >::size_type idx) const
 
RepresentationBaseinbandEventStreamsRemove (const EventStream &val)
 
const std::list< Switching > & switchings () const
 
const Switchingswitching (std::list< Switching >::size_type idx) const
 
RepresentationBaseswitchingsRemove (const Switching &val)
 
const std::list< RandomAccess > & randomAccesses () const
 
const RandomAccessrandomAccess (std::list< RandomAccess >::size_type idx) const
 
RepresentationBaserandomAccessesRemove (const RandomAccess &val)
 
const std::list< Label > & groupLabels () const
 
const LabelgroupLabel (std::list< Label >::size_type idx) const
 
RepresentationBasegroupLabelsRemove (const Label &val)
 
const std::list< Label > & labels () const
 
const Labellabel (std::list< Label >::size_type idx) const
 
RepresentationBaselabelsRemove (const Label &val)
 
const std::list< ProducerReferenceTime > & producerReferenceTimes () const
 
const ProducerReferenceTime & producerReferenceTime (std::list< ProducerReferenceTime >::size_type idx) const
 
RepresentationBaseproducerReferenceTimesRemove (const ProducerReferenceTime &val)
 
const std::list< ContentPopularityRate > & contentPopularityRates () const
 
const ContentPopularityRatecontentPopularityRate (std::list< ContentPopularityRate >::size_type idx) const
 
RepresentationBasecontentPopularityRatesRemove (const ContentPopularityRate &val)
 
const std::list< Resync > & resyncs () const
 
const Resyncresync (std::list< Resync >::size_type idx) const
 
RepresentationBaseresyncsRemove (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 ()
 
RepresentationBaseprofiles (const std::list< URI > &_profiles)
 
RepresentationBaseprofiles (std::list< URI > &&_profiles)
 
RepresentationBaseprofilesAdd (const URI &val)
 
RepresentationBaseprofilesAdd (URI &&val)
 
RepresentationBaseprofilesRemove (const std::list< URI >::const_iterator &it)
 
RepresentationBaseprofilesRemove (const std::list< URI >::iterator &it)
 
RepresentationBaseheight (unsigned int val)
 
RepresentationBaseheight (const std::optional< unsigned int > &val)
 
RepresentationBaseheight (std::optional< unsigned int > &&val)
 
RepresentationBasesar (const Ratio &val)
 
RepresentationBasesar (Ratio &&val)
 
RepresentationBasesar (const std::optional< Ratio > &val)
 
RepresentationBasesar (std::optional< Ratio > &&val)
 
RepresentationBaseframeRate (const FrameRate &val)
 
RepresentationBaseframeRate (FrameRate &&val)
 
RepresentationBaseframeRate (const std::optional< FrameRate > &val)
 
RepresentationBaseframeRate (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 ()
 
RepresentationBaseaudioSamplingRates (const std::list< unsigned int > &rates)
 
RepresentationBaseaudioSamplingRates (std::list< unsigned int > &&rates)
 
RepresentationBaseaudioSamplingRatesRemove (const std::list< unsigned int >::const_iterator &it)
 
RepresentationBaseaudioSamplingRatesRemove (const std::list< unsigned int >::iterator &it)
 
RepresentationBasemimeType (const std::string &val)
 
RepresentationBasemimeType (std::string &&val)
 
RepresentationBasemimeType (const std::optional< std::string > &val)
 
RepresentationBasemimeType (std::optional< std::string > &&val)
 
RepresentationBasesegmentProfiles (const std::list< std::string > &profiles)
 
RepresentationBasesegmentProfiles (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 ()
 
RepresentationBasesegmentProfilesAdd (const std::string &val)
 
RepresentationBasesegmentProfilesAdd (std::string &&val)
 
RepresentationBasesegmentProfilesRemove (const std::list< std::string >::const_iterator &it)
 
RepresentationBasesegmentProfilesRemove (const std::list< std::string >::iterator &it)
 
RepresentationBasecodecs (const Codecs &val)
 
RepresentationBasecodecs (Codecs &&val)
 
RepresentationBasecodecs (const std::optional< Codecs > &val)
 
RepresentationBasecodecs (std::optional< Codecs > &&val)
 
RepresentationBasecontainerProfiles (const std::list< std::string > &profiles)
 
RepresentationBasecontainerProfiles (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 ()
 
RepresentationBasecontainerProfilesAdd (const std::string &val)
 
RepresentationBasecontainerProfilesAdd (std::string &&val)
 
RepresentationBasecontainerProfilesRemove (const std::list< std::string >::const_iterator &it)
 
RepresentationBasecontainerProfilesRemove (const std::list< std::string >::iterator &it)
 
RepresentationBasemaximumSAPPeriod (double val)
 
RepresentationBasemaximumSAPPeriod (const std::optional< double > &val)
 
RepresentationBasemaximumSAPPeriod (std::optional< double > &&val)
 
RepresentationBasestartWithSAP (const SAP &val)
 
RepresentationBasestartWithSAP (SAP &&val)
 
RepresentationBasestartWithSAP (const std::optional< SAP > &val)
 
RepresentationBasestartWithSAP (std::optional< SAP > &&val)
 
RepresentationBasemaxPlayoutRate (double val)
 
RepresentationBasemaxPlayoutRate (const std::optional< double > &val)
 
RepresentationBasemaxPlayoutRate (std::optional< double > &&val)
 
RepresentationBasecodingDependency (bool val)
 
RepresentationBasecodingDependency (const std::optional< bool > &val)
 
RepresentationBasecodingDependency (std::optional< bool > &&val)
 
RepresentationBasescanType (const VideoScan &val)
 
RepresentationBasescanType (VideoScan &&val)
 
RepresentationBasescanType (const std::optional< VideoScan > &val)
 
RepresentationBasescanType (std::optional< VideoScan > &&val)
 
RepresentationBasetag (const std::string &val)
 
RepresentationBasetag (std::string &&val)
 
RepresentationBasetag (const std::optional< std::string > &val)
 
RepresentationBasetag (std::optional< std::string > &&val)
 
RepresentationBaseframePackings (const std::list< Descriptor > &packings)
 
RepresentationBaseframePackings (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 ()
 
RepresentationBaseframePackingsAdd (const Descriptor &val)
 
RepresentationBaseframePackingsAdd (Descriptor &&val)
 
RepresentationBaseframePackingsRemove (const std::list< Descriptor >::const_iterator &it)
 
RepresentationBaseframePackingsRemove (const std::list< Descriptor >::iterator &it)
 
RepresentationBaseaudioChannelConfigurations (const std::list< Descriptor > &packings)
 
RepresentationBaseaudioChannelConfigurations (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 ()
 
RepresentationBaseaudioChannelConfigurationsAdd (const Descriptor &val)
 
RepresentationBaseaudioChannelConfigurationsAdd (Descriptor &&val)
 
RepresentationBaseaudioChannelConfigurationsRemove (const std::list< Descriptor >::const_iterator &it)
 
RepresentationBaseaudioChannelConfigurationsRemove (const std::list< Descriptor >::iterator &it)
 
RepresentationBasecontentProtections (const std::list< ContentProtection > &protections)
 
RepresentationBasecontentProtections (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 ()
 
RepresentationBasecontentProtectionsAdd (const ContentProtection &val)
 
RepresentationBasecontentProtectionsAdd (ContentProtection &&val)
 
RepresentationBasecontentProtectionsRemove (const std::list< ContentProtection >::const_iterator &it)
 
RepresentationBasecontentProtectionsRemove (const std::list< ContentProtection >::iterator &it)
 
RepresentationBaseoutputProtection (const Descriptor &val)
 
RepresentationBaseoutputProtection (Descriptor &&val)
 
RepresentationBaseoutputProtection (const std::optional< Descriptor > &val)
 
RepresentationBaseoutputProtection (std::optional< Descriptor > &&val)
 
RepresentationBaseessentialProperties (const std::list< Descriptor > &properties)
 
RepresentationBaseessentialProperties (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 ()
 
RepresentationBaseessentialPropertiesAdd (const Descriptor &val)
 
RepresentationBaseessentialPropertiesAdd (Descriptor &&val)
 
RepresentationBaseessentialPropertiesRemove (const std::list< Descriptor >::const_iterator &it)
 
RepresentationBaseessentialPropertiesRemove (const std::list< Descriptor >::iterator &it)
 
RepresentationBasesupplementalProperties (const std::list< Descriptor > &properties)
 
RepresentationBasesupplementalProperties (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 ()
 
RepresentationBasesupplementalPropertiesAdd (const Descriptor &val)
 
RepresentationBasesupplementalPropertiesAdd (Descriptor &&val)
 
RepresentationBasesupplementalPropertiesRemove (const std::list< Descriptor >::const_iterator &it)
 
RepresentationBasesupplementalPropertiesRemove (const std::list< Descriptor >::iterator &it)
 
RepresentationBaseinbandEventStreams (const std::list< EventStream > &streams)
 
RepresentationBaseinbandEventStreams (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 ()
 
RepresentationBaseinbandEventStreamsAdd (const EventStream &val)
 
RepresentationBaseinbandEventStreamsAdd (EventStream &&val)
 
RepresentationBaseinbandEventStreamsRemove (const std::list< EventStream >::const_iterator &it)
 
RepresentationBaseinbandEventStreamsRemove (const std::list< EventStream >::iterator &it)
 
RepresentationBaseswitchings (const std::list< Switching > &_switchings)
 
RepresentationBaseswitchings (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 ()
 
RepresentationBaseswitchingsAdd (const Switching &val)
 
RepresentationBaseswitchingsAdd (Switching &&val)
 
RepresentationBaseswitchingsRemove (const std::list< Switching >::const_iterator &it)
 
RepresentationBaseswitchingsRemove (const std::list< Switching >::iterator &it)
 
RepresentationBaserandomAccesses (const std::list< RandomAccess > &accesses)
 
RepresentationBaserandomAccesses (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 ()
 
RepresentationBaserandomAccessesAdd (const RandomAccess &val)
 
RepresentationBaserandomAccessesAdd (RandomAccess &&val)
 
RepresentationBaserandomAccessesRemove (const std::list< RandomAccess >::const_iterator &it)
 
RepresentationBaserandomAccessesRemove (const std::list< RandomAccess >::iterator &it)
 
RepresentationBasegroupLabels (const std::list< Label > &labels)
 
RepresentationBasegroupLabels (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 ()
 
RepresentationBasegroupLabelsAdd (const Label &val)
 
RepresentationBasegroupLabelsAdd (Label &&val)
 
RepresentationBasegroupLabelsRemove (const std::list< Label >::const_iterator &it)
 
RepresentationBasegroupLabelsRemove (const std::list< Label >::iterator &it)
 
RepresentationBaselabels (const std::list< Label > &_labels)
 
RepresentationBaselabels (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 ()
 
RepresentationBaselabelsAdd (const Label &val)
 
RepresentationBaselabelsAdd (Label &&val)
 
RepresentationBaselabelsRemove (const std::list< Label >::const_iterator &it)
 
RepresentationBaselabelsRemove (const std::list< Label >::iterator &it)
 
RepresentationBaseproducerReferenceTimes (const std::list< ProducerReferenceTime > &times)
 
RepresentationBaseproducerReferenceTimes (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 ()
 
RepresentationBaseproducerReferenceTimesAdd (const ProducerReferenceTime &val)
 
RepresentationBaseproducerReferenceTimesAdd (ProducerReferenceTime &&val)
 
RepresentationBaseproducerReferenceTimesRemove (const std::list< ProducerReferenceTime >::const_iterator &it)
 
RepresentationBaseproducerReferenceTimesRemove (const std::list< ProducerReferenceTime >::iterator &it)
 
RepresentationBasecontentPopularityRates (const std::list< ContentPopularityRate > &rates)
 
RepresentationBasecontentPopularityRates (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 ()
 
RepresentationBasecontentPopularityRatesAdd (const ContentPopularityRate &val)
 
RepresentationBasecontentPopularityRatesAdd (ContentPopularityRate &&val)
 
RepresentationBasecontentPopularityRatesRemove (const std::list< ContentPopularityRate >::const_iterator &it)
 
RepresentationBasecontentPopularityRatesRemove (const std::list< ContentPopularityRate >::iterator &it)
 
RepresentationBaseresyncs (const std::list< Resync > &_resyncs)
 
RepresentationBaseresyncs (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 ()
 
RepresentationBaseresyncsAdd (const Resync &val)
 
RepresentationBaseresyncsAdd (Resync &&val)
 
RepresentationBaseresyncsRemove (const std::list< Resync >::const_iterator &it)
 
RepresentationBaseresyncsRemove (const std::list< Resync >::iterator &it)
 

Detailed Description

AdaptationSet class.

This is the container for the AdaptationSet element from an MPD, and follows the AdaptationSetType from the DASH MPD XML schema found in ISO 23009-1:2022 Clause 5.3.3.3.

The AdaptationSet also allows the application to mark child Representations as "selected". The selected set of Representations can then be queried to find out the availability of the next media segments or to find the initialization segments associated with those representations.

Member Typedef Documentation

◆ duration_type

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

Time duration type.

◆ time_type

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

Date-time type.

Constructor & Destructor Documentation

◆ AdaptationSet() [1/3]

com::bbc::libmpdpp::AdaptationSet::AdaptationSet ( )

Default constructor

Creates an empty AdaptationSet object which can be attached to a Period.

◆ AdaptationSet() [2/3]

com::bbc::libmpdpp::AdaptationSet::AdaptationSet ( const AdaptationSet & other)

Copy constructor

Creates a new AdaptationSet object which is a copy of other.

Parameters
otherThe AdaptationSet object to copy.

◆ AdaptationSet() [3/3]

com::bbc::libmpdpp::AdaptationSet::AdaptationSet ( AdaptationSet && other)

Move constructor

Creates a new AdaptationSet object which transfers the resources from other.

Parameters
otherThe AdaptationSet object to move.

◆ ~AdaptationSet()

virtual com::bbc::libmpdpp::AdaptationSet::~AdaptationSet ( )
inlinevirtual

Destructor

Member Function Documentation

◆ accessibilities()

const std::list< Descriptor > & com::bbc::libmpdpp::AdaptationSet::accessibilities ( ) const
inline

Get the list of Accessibility child elements

Returns
The list of Accessibility child Descriptor elements

◆ accessibilitiesAdd() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::accessibilitiesAdd ( const Descriptor & accessibility)

Add a Descriptor to the Accessibility elements

Parameters
accessibilityThe Accessibility Descriptor to add to the list of Accessibility elements.
Returns
This AdaptationSet.

◆ accessibilitiesAdd() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::accessibilitiesAdd ( Descriptor && accessibility)

Add a Descriptor to the Accessibility elements

Parameters
accessibilityThe Accessibility Descriptor to add to the list of Accessibility elements.
Returns
This AdaptationSet.

◆ accessibilitiesBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::accessibilitiesBegin ( )
inline

Get the start of Accessibility elements list iterator

Returns
An iterator pointing to the start of the Accessibility elements list.

◆ accessibilitiesBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::accessibilitiesBegin ( ) const
inline

Get the start of Accessibility elements list iterator

Returns
An iterator pointing to the start of the Accessibility elements list.

◆ accessibilitiesContains()

bool com::bbc::libmpdpp::AdaptationSet::accessibilitiesContains ( const Descriptor & descriptor) const

Check if an Accessibility Descriptor is in the list

Parameters
descriptorThe Accessibility Descriptor to look for.
Returns
true if a Descriptor with the same value as descriptor is found, otherwise false.

◆ accessibilitiesEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::accessibilitiesEnd ( )
inline

Get the end of Accessibility elements list iterator

Returns
An iterator pointing to the end of the Accessibility elements list.

◆ accessibilitiesEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::accessibilitiesEnd ( ) const
inline

Get the end of Accessibility elements list iterator

Returns
An iterator pointing to the end of the Accessibility elements list.

◆ accessibilitiesRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::accessibilitiesRemove ( const Descriptor & accessibility)

Remove an Accessibility Descriptor from the Accessibility elements

If the Descriptor accessibility exists in the Accessibility elements, remove it from the list.

Parameters
accessibilityThe Accessibility Descriptor to remove from the list of Accessibility elements.
Returns
This AdaptationSet.

◆ accessibilitiesRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::accessibilitiesRemove ( const std::list< Descriptor >::const_iterator & it)

Remove an Accessibility Descriptor from the Accessibility elements

Removes the Accessibility Descriptor, referenced by the iterator it, from the list of Accessibility elements.

Parameters
itAn iterator referencing an entry in the Accessibility elements list.
Returns
This AdaptationSet.
See also
accessibilitiesBegin()
accessibilitiesEnd()

◆ accessibilitiesRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::accessibilitiesRemove ( const std::list< Descriptor >::iterator & it)

Remove an Accessibility Descriptor from the Accessibility elements

Removes the Accessibility Descriptor, referenced by the iterator it, from the list of Accessibility elements.

Parameters
itAn iterator referencing an entry in the Accessibility elements list.
Returns
This AdaptationSet.
See also
accessibilitiesBegin()
accessibilitiesEnd()

◆ accessibility()

const Descriptor & com::bbc::libmpdpp::AdaptationSet::accessibility ( std::list< Descriptor >::size_type idx) const

Get an Accessibility element

Gets the Accessibility Descriptor element at index idx in the Accessibility elements list.

Parameters
idxThe index of the element to fetch.
Returns
The Accessibility Descriptor at index idx.
Exceptions
std::out_of_rangeIf idx is beyond the end of the list.

◆ baseURL()

const BaseURL & com::bbc::libmpdpp::AdaptationSet::baseURL ( std::list< BaseURL >::size_type idx) const

Get an BaseURL element

Gets the BaseURL element at index idx in the BaseURL elements list.

Parameters
idxThe index of the element to fetch.
Returns
The BaseURL at index idx.
Exceptions
std::out_of_rangeIf idx is beyond the end of the list.

◆ baseURLs()

const std::list< BaseURL > & com::bbc::libmpdpp::AdaptationSet::baseURLs ( ) const
inline

Get the list of BaseURL child elements

Returns
The list of BaseURL child elements

◆ baseURLsAdd() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::baseURLsAdd ( BaseURL && base_url)

Add a BaseURL to the BaseURL elements

Parameters
base_urlThe BaseURL to add to the list of BaseURL elements.
Returns
This AdaptationSet.

◆ baseURLsAdd() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::baseURLsAdd ( const BaseURL & base_url)

Add a BaseURL to the BaseURL elements

Parameters
base_urlThe BaseURL to add to the list of BaseURL elements.
Returns
This AdaptationSet.

◆ baseURLsBegin() [1/2]

std::list< BaseURL >::iterator com::bbc::libmpdpp::AdaptationSet::baseURLsBegin ( )
inline

Get the start of BaseURL elements list iterator

Returns
An iterator pointing to the start of the BaseURL elements list.

◆ baseURLsBegin() [2/2]

std::list< BaseURL >::const_iterator com::bbc::libmpdpp::AdaptationSet::baseURLsBegin ( ) const
inline

Get the start of BaseURL elements list iterator

Returns
An iterator pointing to the start of the BaseURL elements list.

◆ baseURLsContains()

bool com::bbc::libmpdpp::AdaptationSet::baseURLsContains ( const BaseURL & base_url) const

Check if a BaseURL is in the list

Parameters
base_urlThe BaseURL to look for.
Returns
true if a BaseURL with the same value as base_url is found, otherwise false.

◆ baseURLsEnd() [1/2]

std::list< BaseURL >::iterator com::bbc::libmpdpp::AdaptationSet::baseURLsEnd ( )
inline

Get the end of BaseURL elements list iterator

Returns
An iterator pointing to the end of the BaseURL elements list.

◆ baseURLsEnd() [2/2]

std::list< BaseURL >::const_iterator com::bbc::libmpdpp::AdaptationSet::baseURLsEnd ( ) const
inline

Get the end of BaseURL elements list iterator

Returns
An iterator pointing to the end of the BaseURL elements list.

◆ baseURLsRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::baseURLsRemove ( const BaseURL & base_url)

Remove a BaseURL from the BaseURL elements

If the BaseURL base_url exists in the BaseURL elements, remove it from the list.

Parameters
base_urlThe BaseURL to remove from the list of BaseURL elements.
Returns
This AdaptationSet.

◆ baseURLsRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::baseURLsRemove ( const std::list< BaseURL >::const_iterator & it)

Remove a BaseURL from the BaseURL elements

Removes the BaseURL, referenced by the iterator it, from the list of BaseURL elements.

Parameters
itAn iterator referencing an entry in the BaseURL elements list.
Returns
This AdaptationSet.
See also
baseURLsBegin()
baseURLsEnd()

◆ baseURLsRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::baseURLsRemove ( const std::list< BaseURL >::iterator & it)

Remove a BaseURL from the BaseURL elements

Removes the BaseURL, referenced by the iterator it, from the list of BaseURL elements.

Parameters
itAn iterator referencing an entry in the BaseURL elements list.
Returns
This AdaptationSet.
See also
baseURLsBegin()
baseURLsEnd()

◆ bitstreamSwitching() [1/5]

const std::optional< bool > & com::bbc::libmpdpp::AdaptationSet::bitstreamSwitching ( ) const
inline

Get the optional @bitstreamSwitching attribute value

Returns
The optional bitstream switching flag.

◆ bitstreamSwitching() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::bitstreamSwitching ( bool bitstream_switching)
inline

Set the @bitstreamSwitching attribute value

Parameters
bitstream_switchingThe bitstream switching flag value to set in the @bitstreamSwitching attribute.
Returns
This AdaptationSet.

◆ bitstreamSwitching() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::bitstreamSwitching ( const std::nullopt_t & )
inline

Unset the @bitstreamSwitching attribute value

Returns
This AdaptationSet.

◆ bitstreamSwitching() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::bitstreamSwitching ( const std::optional< bool > & bitstream_switching)
inline

Set the @bitstreamSwitching attribute value (optional value copy)

Copy the optional bitstream_switching into the value of the @bitstreamSwitching attribute.

Parameters
bitstream_switchingThe optional bitstream switching flag to copy into the @bitstreamSwitching attribute.
Returns
This AdaptationSet.

◆ bitstreamSwitching() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::bitstreamSwitching ( std::optional< bool > && bitstream_switching)
inline

Set the @bitstreamSwitching attribute value (optional value move)

Move the optional bitstream_switching into the @bitstreamSwitching attribute.

Parameters
bitstream_switchingThe optional bitstream switching flag to move into the @bitstreamSwitching attribute.
Returns
This AdaptationSet.

◆ contentComponent()

const ContentComponent & com::bbc::libmpdpp::AdaptationSet::contentComponent ( std::list< ContentComponent >::size_type idx) const

Get an ContentComponent element

Gets the ContentComponent element at index idx in the ContentComponent elements list.

Parameters
idxThe index of the element to fetch.
Returns
The ContentComponent at index idx.
Exceptions
std::out_of_rangeIf idx is beyond the end of the list.

◆ contentComponents()

const std::list< ContentComponent > & com::bbc::libmpdpp::AdaptationSet::contentComponents ( ) const
inline

Get the list of ContentComponent child elements

Returns
The list of ContentComponent child elements

◆ contentComponentsAdd() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentComponentsAdd ( const ContentComponent & content_component)

Add a ContentComponent to the ContentComponent elements

Parameters
content_componentThe ContentComponent to add to the list of ContentComponent elements.
Returns
This AdaptationSet.

◆ contentComponentsAdd() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentComponentsAdd ( ContentComponent && content_component)

Add a ContentComponent to the ContentComponent elements

Parameters
content_componentThe ContentComponent to add to the list of ContentComponent elements.
Returns
This AdaptationSet.

◆ contentComponentsBegin() [1/2]

std::list< ContentComponent >::iterator com::bbc::libmpdpp::AdaptationSet::contentComponentsBegin ( )
inline

Get the start of ContentComponent elements list iterator

Returns
An iterator pointing to the start of the ContentComponent elements list.

◆ contentComponentsBegin() [2/2]

std::list< ContentComponent >::const_iterator com::bbc::libmpdpp::AdaptationSet::contentComponentsBegin ( ) const
inline

Get the start of ContentComponent elements list iterator

Returns
An iterator pointing to the start of the ContentComponent elements list.

◆ contentComponentsContains()

bool com::bbc::libmpdpp::AdaptationSet::contentComponentsContains ( const ContentComponent & content_component) const

Check if a ContentComponent is in the list

Parameters
content_componentThe ContentComponent to look for.
Returns
true if a ContentComponent with the same value as content_component is found, otherwise false.

◆ contentComponentsEnd() [1/2]

std::list< ContentComponent >::iterator com::bbc::libmpdpp::AdaptationSet::contentComponentsEnd ( )
inline

Get the end of ContentComponent elements list iterator

Returns
An iterator pointing to the end of the ContentComponent elements list.

◆ contentComponentsEnd() [2/2]

std::list< ContentComponent >::const_iterator com::bbc::libmpdpp::AdaptationSet::contentComponentsEnd ( ) const
inline

Get the end of ContentComponent elements list iterator

Returns
An iterator pointing to the end of the ContentComponent elements list.

◆ contentComponentsRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentComponentsRemove ( const ContentComponent & content_component)

Remove a ContentComponent from the ContentComponent elements

If the ContentComponent content_component exists in the ContentComponent elements, remove it from the list.

Parameters
content_componentThe ContentComponent to remove from the list of ContentComponent elements.
Returns
This AdaptationSet.

◆ contentComponentsRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentComponentsRemove ( const std::list< ContentComponent >::const_iterator & it)

Remove a ContentComponent from the ContentComponent elements

Removes the ContentComponent, referenced by the iterator it, from the list of ContentComponent elements.

Parameters
itAn iterator referencing an entry in the ContentComponent elements list.
Returns
This AdaptationSet.
See also
contentComponentsBegin()
contentComponentsEnd()

◆ contentComponentsRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentComponentsRemove ( const std::list< ContentComponent >::iterator & it)

Remove a ContentComponent from the ContentComponent elements

Removes the ContentComponent, referenced by the iterator it, from the list of ContentComponent elements.

Parameters
itAn iterator referencing an entry in the ContentComponent elements list.
Returns
This AdaptationSet.
See also
contentComponentsBegin()
contentComponentsEnd()

◆ contentType() [1/6]

const std::optional< RFC6838ContentType > & com::bbc::libmpdpp::AdaptationSet::contentType ( ) const
inline

Get the optional @contentType attribute value

Returns
The optional RFC6838 content type.

◆ contentType() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentType ( const RFC6838ContentType & content_type)
inline

Set the @contentType attribute value (copy)

Set the @contentType attribute to a copy of the content_type value.

Parameters
content_typeThe RFC6838 content type to set the @contentType attribute to.
Returns
This AdaptationSet.

◆ contentType() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentType ( const std::nullopt_t & )
inline

Unset the @contentType attribute value

Removes any value currently set for the @contentType attribute.

Returns
This AdaptationSet.

◆ contentType() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentType ( const std::optional< RFC6838ContentType > & content_type)
inline

Set the @contentType attribute value (optional value copy)

Copy the optional value from content_type to the @contentType attribute.

Parameters
content_typeThe optional RFC6838 content type value to copy into the @contentType attribute.
Returns
This AdaptationSet.

◆ contentType() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentType ( RFC6838ContentType && content_type)
inline

Set the @contentType attribute value (move)

Move the RFC6838 content type value, content_type, into the @contentType attribute.

Parameters
content_typeThe RFC6838 content type to move to the @contentType attribute.
Returns
This AdaptationSet.

◆ contentType() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::contentType ( std::optional< RFC6838ContentType > && content_type)
inline

Set the @contentType attribute value (optional value move)

Move the optional value from content_type into the @contentType attribute.

Parameters
content_typeThe optional RFC6838 content type value to move into the @contentType attribute.
Returns
This AdaptationSet.

◆ deselectAllRepresentations()

void com::bbc::libmpdpp::AdaptationSet::deselectAllRepresentations ( )

◆ deselectRepresentation() [1/3]

void com::bbc::libmpdpp::AdaptationSet::deselectRepresentation ( const Representation & rep)

Deselect a Representation

This will remove the Representation, rep, from the set of selected Representation objects.

Parameters
repThe Representation to remove from the set of selected Representation objects.
See also
selectAllRepresentations()
selectRepresentation()
deselectAllRepresentations()
selectedSegmentAvailability()
selectedInitializationSegments()

◆ deselectRepresentation() [2/3]

void com::bbc::libmpdpp::AdaptationSet::deselectRepresentation ( const std::list< Representation >::const_iterator & rep_it)

Deselect a Representation

This will remove the Representation, referenced by the rep_it iterator, from the set of selected Representation objects.

Parameters
rep_itThe iterator referencing the Representation to remove.
See also
selectAllRepresentations()
selectRepresentation()
deselectAllRepresentations()
selectedSegmentAvailability()
selectedInitializationSegments()

◆ deselectRepresentation() [3/3]

void com::bbc::libmpdpp::AdaptationSet::deselectRepresentation ( const std::list< Representation >::iterator & rep_it)

Deselect a Representation

This will remove the Representation, referenced by the rep_it iterator, from the set of selected Representation objects.

Parameters
rep_itThe iterator referencing the Representation to remove.
See also
selectAllRepresentations()
selectRepresentation()
deselectAllRepresentations()
selectedSegmentAvailability()
selectedInitializationSegments()

◆ getBaseURLs()

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

Get the list of BaseURL entries that apply for this AdaptationSet

Returns
A list of BaseURL entries from this AdaptationSet merged with entries from the Period and MPD.

◆ getMPD() [1/2]

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

Get the MPD this AdaptationSet is attached to

Returns
A pointer to the MPD that this AdaptationSet is attached to (via the parent Period) or nullptr if this object is not attached to an MPD.

◆ getMPD() [2/2]

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

Get the MPD this AdaptationSet is attached to

Returns
A pointer to the MPD that this AdaptationSet is attached to (via the parent Period) or nullptr if this object is not attached to an MPD.

◆ getPeriod() [1/2]

Period * com::bbc::libmpdpp::AdaptationSet::getPeriod ( )
inline

Get the Period this AdaptationSet is attached to

Returns
A pointer to the Period that this AdaptationSet is attached to or nullptr if this object is not attached to a Period.

◆ getPeriod() [2/2]

const Period * com::bbc::libmpdpp::AdaptationSet::getPeriod ( ) const
inline

Get the Period this AdaptationSet is attached to

Returns
A pointer to the Period that this AdaptationSet is attached to or nullptr if this object is not attached to a Period.

◆ group() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::group ( ) const
inline

Get the optional @group attribute value

Returns
The optional group number.

◆ group() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::group ( const std::nullopt_t & )
inline

Unset the @group attribute value

Returns
This AdaptationSet.

◆ group() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::group ( const std::optional< unsigned int > & group)
inline

Set the @group attribute value

Parameters
groupThe optional group number to copy to this AdaptationSet.
Returns
This AdaptationSet.

◆ group() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::group ( std::optional< unsigned int > && group)
inline

Set the @group attribute value

Parameters
groupThe optional group number to move to this AdaptationSet.
Returns
This AdaptationSet.

◆ group() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::group ( unsigned int group)
inline

Set the @group attribute value

Parameters
groupThe group number to assign this AdaptationSet.
Returns
This AdaptationSet.

◆ hasBitstreamSwitching()

bool com::bbc::libmpdpp::AdaptationSet::hasBitstreamSwitching ( ) const
inline

Check if the @bitstreamSwitching attribute is set

Returns
true if the @bitstreamSwitching attribute has a value, otherwise false.

◆ hasContentType()

bool com::bbc::libmpdpp::AdaptationSet::hasContentType ( ) const
inline

Check if the @contentType attribute is set

Returns
true if the @contentType attribute has a value, otherwise false.

◆ hasGroup()

bool com::bbc::libmpdpp::AdaptationSet::hasGroup ( ) const
inline

Check if the @group attribute is set

Returns
true if the @group attribute has a value, otherwise false.

◆ hasId()

bool com::bbc::libmpdpp::AdaptationSet::hasId ( ) const
inline

Check if the @id attribute is set

Returns
true if the @id attribute has a value, otherwise false.

◆ hasInitializationPrincipal()

bool com::bbc::libmpdpp::AdaptationSet::hasInitializationPrincipal ( ) const
inline

Check if the @initializationPrincipal attribute is set

Returns
true if the @initializationPrincipal attribute has a value, otherwise false.

◆ hasLang()

bool com::bbc::libmpdpp::AdaptationSet::hasLang ( ) const
inline

Check if the @lang attribute is set

Returns
true if the @lang attribute has a value, otherwise false.

◆ hasMaxBandwidth()

bool com::bbc::libmpdpp::AdaptationSet::hasMaxBandwidth ( ) const
inline

Check if the @maxBandwidth attribute is set

Returns
true if the @maxBandwidth attribute has a value, otherwise false.

◆ hasMaxFrameRate()

bool com::bbc::libmpdpp::AdaptationSet::hasMaxFrameRate ( ) const
inline

Check if the @maxFrameRate attribute is set

Returns
true if the @maxFrameRate attribute has a value, otherwise false.

◆ hasMaxHeight()

bool com::bbc::libmpdpp::AdaptationSet::hasMaxHeight ( ) const
inline

Check if the @maxHeight attribute is set

Returns
true if the @maxHeight attribute has a value, otherwise false.

◆ hasMaxWidth()

bool com::bbc::libmpdpp::AdaptationSet::hasMaxWidth ( ) const
inline

Check if the @maxWidth attribute is set

Returns
true if the @maxWidth attribute has a value, otherwise false.

◆ hasMinBandwidth()

bool com::bbc::libmpdpp::AdaptationSet::hasMinBandwidth ( ) const
inline

Check if the @minBandwidth attribute is set

Returns
true if the @minBandwidth attribute has a value, otherwise false.

◆ hasMinFrameRate()

bool com::bbc::libmpdpp::AdaptationSet::hasMinFrameRate ( ) const
inline

Check if the @minFrameRate attribute is set

Returns
true if the @minFrameRate attribute has a value, otherwise false.

◆ hasMinHeight()

bool com::bbc::libmpdpp::AdaptationSet::hasMinHeight ( ) const
inline

Check if the @minHeight attribute is set

Returns
true if the @minHeight attribute has a value, otherwise false.

◆ hasMinWidth()

bool com::bbc::libmpdpp::AdaptationSet::hasMinWidth ( ) const
inline

Check if the @minWidth attribute is set

Returns
true if the @minWidth attribute has a value, otherwise false.

◆ hasPar()

bool com::bbc::libmpdpp::AdaptationSet::hasPar ( ) const
inline

Check if the @par attribute is set

Returns
true if the @par attribute has a value, otherwise false.

◆ hasSegmentBase()

bool com::bbc::libmpdpp::AdaptationSet::hasSegmentBase ( ) const
inline

Check if a SegmentBase element is present

Returns
true if a SegmentBase has been set, otherwise false.

◆ hasSegmentList()

bool com::bbc::libmpdpp::AdaptationSet::hasSegmentList ( ) const
inline

Check if a SegmentList element is present

Returns
true if a SegmentList has been set, otherwise false.

◆ hasSegmentTemplate()

bool com::bbc::libmpdpp::AdaptationSet::hasSegmentTemplate ( ) const
inline

Check if a SegmentTemplate element is present

Returns
true if a SegmentTemplate has been set, otherwise false.

◆ id() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::id ( ) const
inline

Get the optional @id attribute value

Returns
The optional id number.

◆ id() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::id ( const std::nullopt_t & )
inline

Unset the @id attribute value

Returns
This AdaptationSet.

◆ id() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::id ( const std::optional< unsigned int > & id)
inline

Set the @id attribute value

Parameters
idAn optional number to copy into the @id attribute value.
Returns
This AdaptationSet.

◆ id() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::id ( std::optional< unsigned int > && id)
inline

Set the @id attribute value

Parameters
idAn optional number to move into the @id attribute value.
Returns
This AdaptationSet.

◆ id() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::id ( unsigned int id)
inline

Set the @id attribute value

Parameters
idThe number to assign this AdaptationSet.
Returns
This AdaptationSet.

◆ initializationPrincipal() [1/6]

const std::optional< URI > & com::bbc::libmpdpp::AdaptationSet::initializationPrincipal ( ) const
inline

Get the optional @initializationPrincipal attribute value

Returns
The optional Initialization Principle URL.

◆ initializationPrincipal() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationPrincipal ( const std::nullopt_t & )
inline

Unset the @initializationPrincipal attribute value

Returns
This AdaptationSet.

◆ initializationPrincipal() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationPrincipal ( const std::optional< URI > & initialization_principal)
inline

Set the @initializationPrincipal attribute value (optional value copy)

Copy the optional initialization_principal into the value of the @initializationPrincipal attribute.

Parameters
initialization_principalThe optional Initialization Principle URL to copy into the @initializationPrincipal attribute.
Returns
This AdaptationSet.

◆ initializationPrincipal() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationPrincipal ( const URI & initialization_principal)
inline

Set the @initializationPrincipal attribute value (copy)

Parameters
initialization_principalThe Initialization Principle URL to set for the @initializationPrincipal attribute.
Returns
This AdaptationSet.

◆ initializationPrincipal() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationPrincipal ( std::optional< URI > && initialization_principal)
inline

Set the @initializationPrincipal attribute value (optional value move)

Move the optional initialization_principal into the value of the @initializationPrincipal attribute.

Parameters
initialization_principalThe optional Initialization Principle URL to move into the @initializationPrincipal attribute.
Returns
This AdaptationSet.

◆ initializationPrincipal() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationPrincipal ( URI && initialization_principal)
inline

Set the @initializationPrincipal attribute value (move)

Parameters
initialization_principalThe Initialization Principle URL to move into the @initializationPrincipal attribute.
Returns
This AdaptationSet.

◆ initializationSetRef()

unsigned int com::bbc::libmpdpp::AdaptationSet::initializationSetRef ( std::list< unsigned int >::size_type idx) const
inline

Get the Initialization Set reference at the given list index

Parameters
idxThe list index of the Initialization Set reference to retrieve.
Returns
The Initialization Set reference at the list index idx.
Exceptions
std::out_of_rangeif idx is after the end of the Initialization Set reference list.

◆ initializationSetRefAdd()

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationSetRefAdd ( unsigned int ref)
inline

Add an Initialization Set reference to the list of Initialization Set references

Parameters
refThe Initialization Set reference value to add.
Returns
This AdaptationSet.

◆ initializationSetRefRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationSetRefRemove ( const std::list< unsigned int >::const_iterator & it)
inline

Remove an Initialization Set reference from the list of Initialization Set references (by iterator)

Parameters
itAn iterator pointing to an entry in the list of Initialization Set references.
Returns
This AdaptationSet.
See also
initializationSetRefsBegin()
initializationSetRefsEnd()

◆ initializationSetRefRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationSetRefRemove ( const std::list< unsigned int >::iterator & it)
inline

Remove an Initialization Set reference from the list of Initialization Set references (by iterator)

Parameters
itAn iterator pointing to an entry in the list of Initialization Set references.
Returns
This AdaptationSet.
See also
initializationSetRefsBegin()
initializationSetRefsEnd()

◆ initializationSetRefRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationSetRefRemove ( unsigned int ref)
inline

Remove an Initialization Set reference from the list of Initialization Set references (by value)

Parameters
refThe Initialization Set reference value to remove from the list of Initialization Set references.
Returns
This AdaptationSet.

◆ initializationSetRefs() [1/3]

const std::list< unsigned int > & com::bbc::libmpdpp::AdaptationSet::initializationSetRefs ( ) const
inline

Get the list of Initialization Set references from the @initializationSetRefs attribute value

Returns
The list of Initialization Set references.

◆ initializationSetRefs() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationSetRefs ( const std::list< unsigned int > & initialization_set_refs)
inline

Set the list of Initialization Set references (copy)

Set the list of Initialization Set references to a copy of the list in initialization_set_refs. This replaces the current list.

Parameters
initialization_set_refsA list of Initialization Set references to copy into this list of Initialization Set references.
Returns
This AdaptationSet.

◆ initializationSetRefs() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::initializationSetRefs ( std::list< unsigned int > && initialization_set_refs)
inline

Set the list of Initialization Set references (move)

Replace the list of Initialization Set references with the list from initialization_set_refs.

Parameters
initialization_set_refsA list of Initialization Set references to move into this list of Initialization Set references.
Returns
This AdaptationSet.

◆ initializationSetRefsBegin() [1/2]

std::list< unsignedint >::iterator com::bbc::libmpdpp::AdaptationSet::initializationSetRefsBegin ( )
inline

Get an iterator pointing to the start of the Initialization Set references list

Returns
An iterator pointing to the start of the Initialization Set references list.

◆ initializationSetRefsBegin() [2/2]

std::list< unsignedint >::const_iterator com::bbc::libmpdpp::AdaptationSet::initializationSetRefsBegin ( ) const
inline

Get an iterator pointing to the start of the Initialization Set references list

Returns
An iterator pointing to the start of the Initialization Set references list.

◆ initializationSetRefsContains()

bool com::bbc::libmpdpp::AdaptationSet::initializationSetRefsContains ( unsigned int ref) const
inline

Check if the Initialization Set reference list contains a given reference value

Parameters
refThe reference value to check.
Returns
true if the Initialization Set reference list contains the value of ref, otherwise false.

◆ initializationSetRefsEnd() [1/2]

std::list< unsignedint >::iterator com::bbc::libmpdpp::AdaptationSet::initializationSetRefsEnd ( )
inline

Get an iterator pointing to the end of the Initialization Set references list

Returns
An iterator pointing to the start of the Initialization Set references list.

◆ initializationSetRefsEnd() [2/2]

std::list< unsignedint >::const_iterator com::bbc::libmpdpp::AdaptationSet::initializationSetRefsEnd ( ) const
inline

Get an iterator pointing to the end of the Initialization Set references list

Returns
An iterator pointing to the start of the Initialization Set references list.

◆ lang() [1/6]

const std::optional< std::string > & com::bbc::libmpdpp::AdaptationSet::lang ( ) const
inline

Get the optional @lang attribute value

Returns
The optional language identifier.

◆ lang() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::lang ( const std::nullopt_t & )
inline

Unset the @lang attribute value

Returns
This AdaptationSet.

◆ lang() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::lang ( const std::optional< std::string > & lang)
inline

Set the @lang attribute value (optional value copy)

Copy the optional lang value as the setting for the @lang attribute.

Parameters
langThe optional language identifier to set the @lang attribute to.
Returns
This AdaptationSet.

◆ lang() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::lang ( const std::string & lang)
inline

Set the @lang attribute value (copy)

Copies the lang value into the @lang attribute.

Parameters
langThe language identifier to set the @lang attribute to.
Returns
This AdaptationSet.

◆ lang() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::lang ( std::optional< std::string > && lang)
inline

Set the @lang attribute value (optional value move)

Move the optional lang value as the setting for the @lang attribute.

Parameters
langThe optional language identifier to set the @lang attribute to.
Returns
This AdaptationSet.

◆ lang() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::lang ( std::string && lang)
inline

Set the @lang attribute value (move)

Move the lang value into the @lang attribute.

Parameters
langThe language identifier to set the @lang attribute to.
Returns
This AdaptationSet.

◆ maxBandwidth() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::maxBandwidth ( ) const
inline

Get the optional @maxBandwidth attribute value

Returns
The optional maximum bandwidth.

◆ maxBandwidth() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxBandwidth ( const std::nullopt_t & )
inline

Unset the @maxBandwidth attribute value

Returns
This AdaptationSet.

◆ maxBandwidth() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxBandwidth ( const std::optional< unsigned int > & max_bandwidth)
inline

Set the @maxBandwidth attribute value (optional value copy)

Copy the optional max_bandwidth into the value of the @maxBandwidth attribute.

Parameters
max_bandwidthThe optional maximum bandwidth to copy into the @maxBandwidth attribute.
Returns
This AdaptationSet.

◆ maxBandwidth() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxBandwidth ( std::optional< unsigned int > && max_bandwidth)
inline

Set the @maxBandwidth attribute value (optional value move)

Move the optional max_bandwidth into the @maxBandwidth attribute.

Parameters
max_bandwidthThe optional maximum bandwidth to move into the @maxBandwidth attribute.
Returns
This AdaptationSet.

◆ maxBandwidth() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxBandwidth ( unsigned int max_bandwidth)
inline

Set the @maxBandwidth attribute value

Parameters
max_bandwidthThe maximum bandwidth value to set for the @maxBandwidth attribute.
Returns
This AdaptationSet.

◆ maxFrameRate() [1/6]

const std::optional< FrameRate > & com::bbc::libmpdpp::AdaptationSet::maxFrameRate ( ) const
inline

Get the optional @maxFrameRate attribute value

Returns
The optional maximum video frame rate.

◆ maxFrameRate() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxFrameRate ( const FrameRate & max_frame_rate)
inline

Set the @maxFrameRate attribute value (copy)

Copy the max_frame_rate value into the @maxFrameRate attribute.

Parameters
max_frame_rateThe maximum video frame rate to copy into the @maxFrameRate attribute.
Returns
This AdaptationSet.

◆ maxFrameRate() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxFrameRate ( const std::nullopt_t & )
inline

Unset the @maxFrameRate attribute value

Returns
This AdaptationSet.

◆ maxFrameRate() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxFrameRate ( const std::optional< FrameRate > & max_frame_rate)
inline

Set the @maxFrameRate attribute value (optional value copy)

Copy the optional max_frame_rate into the value of the @maxFrameRate attribute.

Parameters
max_frame_rateThe optional maximum video frame rate to copy into the @maxFrameRate attribute.
Returns
This AdaptationSet.

◆ maxFrameRate() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxFrameRate ( FrameRate && max_frame_rate)
inline

Set the @maxFrameRate attribute value (move)

Move the max_frame_rate value into the @maxFrameRate attribute.

Parameters
max_frame_rateThe maximum video frame rate to move into the @maxFrameRate attribute.
Returns
This AdaptationSet.

◆ maxFrameRate() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxFrameRate ( std::optional< FrameRate > && max_frame_rate)
inline

Set the @maxFrameRate attribute value (optional value move)

Move the optional max_frame_rate into the @maxFrameRate attribute.

Parameters
max_frame_rateThe optional maximum video frame rate to move into the @maxFrameRate attribute.
Returns
This AdaptationSet.

◆ maxHeight() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::maxHeight ( ) const
inline

Get the optional @maxHeight attribute value

Returns
The optional maximum video height.

◆ maxHeight() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxHeight ( const std::nullopt_t & )
inline

Unset the @maxHeight attribute value

Returns
This AdaptationSet.

◆ maxHeight() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxHeight ( const std::optional< unsigned int > & max_height)
inline

Set the @maxHeight attribute value (optional value copy)

Copy the optional max_height into the value of the @maxHeight attribute.

Parameters
max_heightThe optional maximum video height to copy into the @maxHeight attribute.
Returns
This AdaptationSet.

◆ maxHeight() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxHeight ( std::optional< unsigned int > && max_height)
inline

Set the @maxHeight attribute value (optional value move)

Move the optional max_height into the @maxHeight attribute.

Parameters
max_heightThe optional maximum video height to move into the @maxHeight attribute.
Returns
This AdaptationSet.

◆ maxHeight() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxHeight ( unsigned int max_height)
inline

Set the @maxHeight attribute value

Parameters
max_heightThe maximum video height value to set for the @maxHeight attribute.
Returns
This AdaptationSet.

◆ maxWidth() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::maxWidth ( ) const
inline

Get the optional @maxWidth attribute value

Returns
The optional maximum video width.

◆ maxWidth() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxWidth ( const std::nullopt_t & )
inline

Unset the @maxWidth attribute value

Returns
This AdaptationSet.

◆ maxWidth() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxWidth ( const std::optional< unsigned int > & max_width)
inline

Set the @maxWidth attribute value (optional value copy)

Copy the optional max_width into the value of the @maxWidth attribute.

Parameters
max_widthThe optional maximum video width to copy into the @maxWidth attribute.
Returns
This AdaptationSet.

◆ maxWidth() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxWidth ( std::optional< unsigned int > && max_width)
inline

Set the @maxWidth attribute value (optional value move)

Move the optional max_width into the @maxWidth attribute.

Parameters
max_widthThe optional maximum video width to move into the @maxWidth attribute.
Returns
This AdaptationSet.

◆ maxWidth() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::maxWidth ( unsigned int max_width)
inline

Set the @maxWidth attribute value

Parameters
max_widthThe maximum video width value to set for the @maxWidth attribute.
Returns
This AdaptationSet.

◆ minBandwidth() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::minBandwidth ( ) const
inline

Get the optional @minBandwidth attribute value

Returns
The optional minimum bandwidth.

◆ minBandwidth() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minBandwidth ( const std::nullopt_t & )
inline

Unset the @minBandwidth attribute value

Returns
This AdaptationSet.

◆ minBandwidth() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minBandwidth ( const std::optional< unsigned int > & min_bandwidth)
inline

Set the @minBandwidth attribute value (optional value copy)

Copy the optional min_bandwidth into the value of the @minBandwidth attribute.

Parameters
min_bandwidthThe optional minimum bandwidth to copy into the @minBandwidth attribute.
Returns
This AdaptationSet.

◆ minBandwidth() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minBandwidth ( std::optional< unsigned int > && min_bandwidth)
inline

Set the @minBandwidth attribute value (optional value move)

Move the optional min_bandwidth into the @minBandwidth attribute.

Parameters
min_bandwidthThe optional minimum bandwidth to move into the @minBandwidth attribute.
Returns
This AdaptationSet.

◆ minBandwidth() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minBandwidth ( unsigned int min_bandwidth)
inline

Set the @minBandwidth attribute value

Parameters
min_bandwidthThe minimum bandwidth value to set for the @minBandwidth attribute.
Returns
This AdaptationSet.

◆ minFrameRate() [1/6]

const std::optional< FrameRate > & com::bbc::libmpdpp::AdaptationSet::minFrameRate ( ) const
inline

Get the optional @minFrameRate attribute value

Returns
The optional minimum video frame rate.

◆ minFrameRate() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minFrameRate ( const FrameRate & min_frame_rate)
inline

Set the @minFrameRate attribute value (copy)

Copy the min_frame_rate value into the @minFrameRate attribute.

Parameters
min_frame_rateThe minimum video frame rate to copy into the @minFrameRate attribute.
Returns
This AdaptationSet.

◆ minFrameRate() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minFrameRate ( const std::nullopt_t & )
inline

Unset the @minFrameRate attribute value

Returns
This AdaptationSet.

◆ minFrameRate() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minFrameRate ( const std::optional< FrameRate > & min_frame_rate)
inline

Set the @minFrameRate attribute value (optional value copy)

Copy the optional min_frame_rate into the value of the @minFrameRate attribute.

Parameters
min_frame_rateThe optional minimum video frame rate to copy into the @minFrameRate attribute.
Returns
This AdaptationSet.

◆ minFrameRate() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minFrameRate ( FrameRate && min_frame_rate)
inline

Set the @minFrameRate attribute value (move)

Move the min_frame_rate value into the @minFrameRate attribute.

Parameters
min_frame_rateThe minimum video frame rate to move into the @minFrameRate attribute.
Returns
This AdaptationSet.

◆ minFrameRate() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minFrameRate ( std::optional< FrameRate > && min_frame_rate)
inline

Set the @minFrameRate attribute value (optional value move)

Move the optional min_frame_rate into the @minFrameRate attribute.

Parameters
min_frame_rateThe optional minimum video frame rate to move into the @minFrameRate attribute.
Returns
This AdaptationSet.

◆ minHeight() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::minHeight ( ) const
inline

Get the optional @minHeight attribute value

Returns
The optional minimum video height.

◆ minHeight() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minHeight ( const std::nullopt_t & )
inline

Unset the @minHeight attribute value

Returns
This AdaptationSet.

◆ minHeight() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minHeight ( const std::optional< unsigned int > & min_height)
inline

Set the @minHeight attribute value (optional value copy)

Copy the optional min_height into the value of the @minHeight attribute.

Parameters
min_heightThe optional minimum video height to copy into the @minHeight attribute.
Returns
This AdaptationSet.

◆ minHeight() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minHeight ( std::optional< unsigned int > && min_height)
inline

Set the @minHeight attribute value (optional value move)

Move the optional min_height into the @minHeight attribute.

Parameters
min_heightThe optional minimum video height to move into the @minHeight attribute.
Returns
This AdaptationSet.

◆ minHeight() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minHeight ( unsigned int min_height)
inline

Set the @minHeight attribute value

Parameters
min_heightThe minimum video height value to set for the @minHeight attribute.
Returns
This AdaptationSet.

◆ minWidth() [1/5]

const std::optional< unsigned int > & com::bbc::libmpdpp::AdaptationSet::minWidth ( ) const
inline

Get the optional @minWidth attribute value

Returns
The optional minimum video width.

◆ minWidth() [2/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minWidth ( const std::nullopt_t & )
inline

Unset the @minWidth attribute value

Returns
This AdaptationSet.

◆ minWidth() [3/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minWidth ( const std::optional< unsigned int > & min_width)
inline

Set the @minWidth attribute value (optional value copy)

Copy the optional min_width into the value of the @minWidth attribute.

Parameters
min_widthThe optional minimum video width to copy into the @minWidth attribute.
Returns
This AdaptationSet.

◆ minWidth() [4/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minWidth ( std::optional< unsigned int > && min_width)
inline

Set the @minWidth attribute value (optional value move)

Move the optional min_width into the @minWidth attribute.

Parameters
min_widthThe optional minimum video width to move into the @minWidth attribute.
Returns
This AdaptationSet.

◆ minWidth() [5/5]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::minWidth ( unsigned int min_width)
inline

Set the @minWidth attribute value

Parameters
min_widthThe minimum video width value to set for the @minWidth attribute.
Returns
This AdaptationSet.

◆ operator=() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::operator= ( AdaptationSet && other)

Move operator

Transfers the resources from other into this AdaptationSet object.

Parameters
otherThe AdaptationSet object to move.
Returns
This AdaptationSet object.

◆ operator=() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::operator= ( const AdaptationSet & other)

Copy operator

Copies the values from other into this AdaptationSet object.

Parameters
otherThe AdaptationSet object to copy.
Returns
This AdaptationSet object.

◆ operator==()

bool com::bbc::libmpdpp::AdaptationSet::operator== ( const AdaptationSet & other) const

Equality operator

Compare the value of this AdaptationSet to other.

Parameters
otherThe AdaptationSet object to compare this object to.
Returns
true if this AdaptationSet object contains the same values as other, otherwise false.

◆ par() [1/6]

const std::optional< Ratio > & com::bbc::libmpdpp::AdaptationSet::par ( ) const
inline

Get the optional @par attribute value

Returns
The optional picture aspect ratio.

◆ par() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::par ( const Ratio & par)
inline

Set the @par attribute value (copy)

Copy the Ratio par as the value of the @par attribute.

Parameters
parThe picture aspect ratio to copy into the @par attribute.
Returns
This AdaptationSet.

◆ par() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::par ( const std::nullopt_t & )
inline

Unset the @par attribute value

Returns
This AdaptationSet.

◆ par() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::par ( const std::optional< Ratio > & par)
inline

Set the @par attribute value (optional value copy)

Copy the optional Ratio par into the value of the @par attribute.

Parameters
parThe optional picture aspect ratio to copy into the @par attribute.
Returns
This AdaptationSet.

◆ par() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::par ( Ratio && par)
inline

Set the @par attribute value (move)

Move the Ratio par into the value of the @par attribute.

Parameters
parThe picture aspect ratio to move into the @par attribute.
Returns
This AdaptationSet.

◆ par() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::par ( std::optional< Ratio > && par)
inline

Set the @par attribute value (optional value move)

Move the optional Ratio par into the value of the @par attribute.

Parameters
parThe optional picture aspect ratio to move into the @par attribute.
Returns
This AdaptationSet.

◆ rating()

const Descriptor & com::bbc::libmpdpp::AdaptationSet::rating ( std::list< Descriptor >::size_type idx) const

Get an Rating element

Gets the Rating Descriptor element at index idx in the Rating elements list.

Parameters
idxThe index of the element to fetch.
Returns
The Rating Descriptor at index idx.
Exceptions
std::out_of_rangeIf idx is beyond the end of the list.

◆ ratings()

const std::list< Descriptor > & com::bbc::libmpdpp::AdaptationSet::ratings ( ) const
inline

Get the list of Rating child elements

Returns
The list of Rating child Descriptor elements

◆ ratingsAdd() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::ratingsAdd ( const Descriptor & rating)

Add a Descriptor to the Rating elements

Parameters
ratingThe Rating Descriptor to add to the list of Rating elements.
Returns
This AdaptationSet.

◆ ratingsAdd() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::ratingsAdd ( Descriptor && rating)

Add a Descriptor to the Rating elements

Parameters
ratingThe Rating Descriptor to add to the list of Rating elements.
Returns
This AdaptationSet.

◆ ratingsBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::ratingsBegin ( )
inline

Get the start of Rating elements list iterator

Returns
An iterator pointing to the start of the Rating elements list.

◆ ratingsBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::ratingsBegin ( ) const
inline

Get the start of Rating elements list iterator

Returns
An iterator pointing to the start of the Rating elements list.

◆ ratingsContains()

bool com::bbc::libmpdpp::AdaptationSet::ratingsContains ( const Descriptor & descriptor) const

Check if a Rating Descriptor is in the list

Parameters
descriptorThe Rating Descriptor to look for.
Returns
true if a Descriptor with the same value as descriptor is found, otherwise false.

◆ ratingsEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::ratingsEnd ( )
inline

Get the end of Rating elements list iterator

Returns
An iterator pointing to the end of the Rating elements list.

◆ ratingsEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::ratingsEnd ( ) const
inline

Get the end of Rating elements list iterator

Returns
An iterator pointing to the end of the Rating elements list.

◆ ratingsRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::ratingsRemove ( const Descriptor & rating)

Remove a Rating Descriptor from the Rating elements

If the Descriptor rating exists in the Rating elements, remove it from the list.

Parameters
ratingThe Rating Descriptor to remove from the list of Rating elements.
Returns
This AdaptationSet.

◆ ratingsRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::ratingsRemove ( const std::list< Descriptor >::const_iterator & it)

Remove a Rating Descriptor from the Rating elements

Removes the Rating Descriptor, referenced by the iterator it, from the list of Rating elements.

Parameters
itAn iterator referencing an entry in the Rating elements list.
Returns
This AdaptationSet.
See also
ratingsBegin()
ratingsEnd()

◆ ratingsRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::ratingsRemove ( const std::list< Descriptor >::iterator & it)

Remove a Rating Descriptor from the Rating elements

Removes the Rating Descriptor, referenced by the iterator it, from the list of Rating elements.

Parameters
itAn iterator referencing an entry in the Rating elements list.
Returns
This AdaptationSet.
See also
ratingsBegin()
ratingsEnd()

◆ representation()

const Representation & com::bbc::libmpdpp::AdaptationSet::representation ( std::list< Representation >::size_type idx) const

Get an Representation element

Gets the Representation element at index idx in the Representation elements list.

Parameters
idxThe index of the element to fetch.
Returns
The Representation at index idx.
Exceptions
std::out_of_rangeIf idx is beyond the end of the list.

◆ representations()

const std::list< Representation > & com::bbc::libmpdpp::AdaptationSet::representations ( ) const
inline

Get the list of Representation child elements

Returns
The list of Representation child elements

◆ representationsAdd() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::representationsAdd ( const Representation & representation)

Add a Representation to the Representation elements

Parameters
representationThe Representation to add to the list of Representation elements.
Returns
This AdaptationSet.

◆ representationsAdd() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::representationsAdd ( Representation && representation)

Add a Representation to the Representation elements

Parameters
representationThe Representation to add to the list of Representation elements.
Returns
This AdaptationSet.

◆ representationsBegin() [1/2]

std::list< Representation >::iterator com::bbc::libmpdpp::AdaptationSet::representationsBegin ( )
inline

Get the start of Representation elements list iterator

Returns
An iterator pointing to the start of the Representation elements list.

◆ representationsBegin() [2/2]

std::list< Representation >::const_iterator com::bbc::libmpdpp::AdaptationSet::representationsBegin ( ) const
inline

Get the start of Representation elements list iterator

Returns
An iterator pointing to the start of the Representation elements list.

◆ representationsContains()

bool com::bbc::libmpdpp::AdaptationSet::representationsContains ( const Representation & representation) const

Check if a Representation is in the list

Parameters
representationThe Representation to look for.
Returns
true if a Representation with the same value as representation is found, otherwise false.

◆ representationsEnd() [1/2]

std::list< Representation >::iterator com::bbc::libmpdpp::AdaptationSet::representationsEnd ( )
inline

Get the end of Representation elements list iterator

Returns
An iterator pointing to the end of the Representation elements list.

◆ representationsEnd() [2/2]

std::list< Representation >::const_iterator com::bbc::libmpdpp::AdaptationSet::representationsEnd ( ) const
inline

Get the end of Representation elements list iterator

Returns
An iterator pointing to the end of the Representation elements list.

◆ representationsRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::representationsRemove ( const Representation & representation)

Remove a Representation from the Representation elements

If the Representation representation exists in the Representation elements, remove it from the list.

Parameters
representationThe Representation to remove from the list of Representation elements.
Returns
This AdaptationSet.

◆ representationsRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::representationsRemove ( const std::list< Representation >::const_iterator & it)

Remove a Representation from the Representation elements

Removes the Representation, referenced by the iterator it, from the list of Representation elements.

Parameters
itAn iterator referencing an entry in the Representation elements list.
Returns
This AdaptationSet.
See also
representationsBegin()
representationsEnd()

◆ representationsRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::representationsRemove ( const std::list< Representation >::iterator & it)

Remove a Representation from the Representation elements

Removes the Representation, referenced by the iterator it, from the list of Representation elements.

Parameters
itAn iterator referencing an entry in the Representation elements list.
Returns
This AdaptationSet.
See also
representationsBegin()
representationsEnd()

◆ role()

const Descriptor & com::bbc::libmpdpp::AdaptationSet::role ( std::list< Descriptor >::size_type idx) const

Get an Role element

Gets the Role Descriptor element at index idx in the Role elements list.

Parameters
idxThe index of the element to fetch.
Returns
The Role Descriptor at index idx.
Exceptions
std::out_of_rangeIf idx is beyond the end of the list.

◆ roles()

const std::list< Descriptor > & com::bbc::libmpdpp::AdaptationSet::roles ( ) const
inline

Get the list of Role child elements

Returns
The list of Role child Descriptor elements

◆ rolesAdd() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::rolesAdd ( const Descriptor & role)

Add a Descriptor to the Role elements

Parameters
roleThe Role Descriptor to add to the list of Role elements.
Returns
This AdaptationSet.

◆ rolesAdd() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::rolesAdd ( Descriptor && role)

Add a Descriptor to the Role elements

Parameters
roleThe Role Descriptor to add to the list of Role elements.
Returns
This AdaptationSet.

◆ rolesBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::rolesBegin ( )
inline

Get the start of Role elements list iterator

Returns
An iterator pointing to the start of the Role elements list.

◆ rolesBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::rolesBegin ( ) const
inline

Get the start of Role elements list iterator

Returns
An iterator pointing to the start of the Role elements list.

◆ rolesContains()

bool com::bbc::libmpdpp::AdaptationSet::rolesContains ( const Descriptor & descriptor) const

Check if a Role Descriptor is in the list

Parameters
descriptorThe Role Descriptor to look for.
Returns
true if a Descriptor with the same value as descriptor is found, otherwise false.

◆ rolesEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::rolesEnd ( )
inline

Get the end of Role elements list iterator

Returns
An iterator pointing to the end of the Role elements list.

◆ rolesEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::rolesEnd ( ) const
inline

Get the end of Role elements list iterator

Returns
An iterator pointing to the end of the Role elements list.

◆ rolesRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::rolesRemove ( const Descriptor & role)

Remove a Role Descriptor from the Role elements

If the Descriptor role exists in the Role elements, remove it from the list.

Parameters
roleThe Role Descriptor to remove from the list of Role elements.
Returns
This AdaptationSet.

◆ rolesRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::rolesRemove ( const std::list< Descriptor >::const_iterator & it)

Remove a Role Descriptor from the Role elements

Removes the Role Descriptor, referenced by the iterator it, from the list of Role elements.

Parameters
itAn iterator referencing an entry in the Role elements list.
Returns
This AdaptationSet.
See also
rolesBegin()
rolesEnd()

◆ rolesRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::rolesRemove ( const std::list< Descriptor >::iterator & it)

Remove a Role Descriptor from the Role elements

Removes the Role Descriptor, referenced by the iterator it, from the list of Role elements.

Parameters
itAn iterator referencing an entry in the Role elements list.
Returns
This AdaptationSet.
See also
rolesBegin()
rolesEnd()

◆ segmentAlignment() [1/2]

bool com::bbc::libmpdpp::AdaptationSet::segmentAlignment ( ) const
inline

Get the @segmentAlignment attribute value

This indicates that all segments in child Representations align without overlap.

Returns
The segment alignment flag.

◆ segmentAlignment() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentAlignment ( bool segment_alignment)
inline

Set the @segmentAlignment attribute value

This indicates that all segments in child Representation entries align without overlap. The default for this attribute is false, therefore setting this value to false will omit it from any XML output.

Parameters
segment_alignmentThe value to set the segment alignment flag (@segmentAlignment attribute) to.
Returns
This AdaptationSet.

◆ segmentBase() [1/6]

const std::optional< SegmentBase > & com::bbc::libmpdpp::AdaptationSet::segmentBase ( ) const
inline

Get the optional SegmentBase

Returns
The optional SegmentBase for this AdaptationSet.

◆ segmentBase() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentBase ( const SegmentBase & seg_base)
inline

Set the SegmentBase

Copy the SegmentBase from seg_base as the SegmentBase for this AdaptationSet.

Parameters
seg_baseThe SegmentBase to set on this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentBase() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentBase ( const std::nullopt_t & )
inline

Unset the optional SegmentBase

Removes the SegmentBase element from this AdaptationSet.

Returns
This AdaptationSet.

◆ segmentBase() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentBase ( const std::optional< SegmentBase > & seg_base)
inline

Set the SegmentBase

Set the SegmentBase of this AdaptationSet to seg_base.

Parameters
seg_baseThe SegmentBase to set in this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentBase() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentBase ( SegmentBase && seg_base)
inline

Set the SegmentBase

Move the value of SegmentBase seg_base as the SegmentBase for this AdaptationSet.

Parameters
seg_baseThe SegmentBase to set on this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentBase() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentBase ( std::optional< SegmentBase > && seg_base)
inline

Set the SegmentBase

Set the SegmentBase of this AdaptationSet to seg_base.

Parameters
seg_baseThe SegmentBase to set in this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentList() [1/6]

const std::optional< SegmentList > & com::bbc::libmpdpp::AdaptationSet::segmentList ( ) const
inline

Get the optional SegmentList

Returns
The optional SegmentList for this AdaptationSet.

◆ segmentList() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentList ( const SegmentList & seg_list)
inline

Set the SegmentList

Copy the SegmentList from seg_list as the SegmentList for this AdaptationSet.

Parameters
seg_listThe SegmentList to set on this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentList() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentList ( const std::nullopt_t & )
inline

Unset the optional SegmentList

Removes the SegmentList element from this AdaptationSet.

Returns
This AdaptationSet.

◆ segmentList() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentList ( const std::optional< SegmentList > & seg_list)
inline

Set the SegmentList

Set the SegmentList of this AdaptationSet to seg_list.

Parameters
seg_listThe SegmentList to set in this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentList() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentList ( SegmentList && seg_list)
inline

Set the SegmentList

Move the value of SegmentList seg_list as the SegmentList for this AdaptationSet.

Parameters
seg_listThe SegmentList to set on this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentList() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentList ( std::optional< SegmentList > && seg_list)
inline

Set the SegmentList

Set the SegmentList of this AdaptationSet to seg_list.

Parameters
seg_listThe SegmentList to set in this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentTemplate() [1/6]

const std::optional< SegmentTemplate > & com::bbc::libmpdpp::AdaptationSet::segmentTemplate ( ) const
inline

Get the optional SegmentTemplate

Returns
The optional SegmentTemplate for this AdaptationSet.

◆ segmentTemplate() [2/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentTemplate ( const SegmentTemplate & seg_template)
inline

Set the SegmentTemplate

Copy the SegmentTemplate from seg_template as the SegmentTemplate for this AdaptationSet.

Parameters
seg_templateThe SegmentTemplate to set on this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentTemplate() [3/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentTemplate ( const std::nullopt_t & )
inline

Unset the optional SegmentTemplate

Removes the SegmentTemplate element from this AdaptationSet.

Returns
This AdaptationSet.

◆ segmentTemplate() [4/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentTemplate ( const std::optional< SegmentTemplate > & seg_template)
inline

Set the SegmentTemplate

Set the SegmentTemplate of this AdaptationSet to seg_template.

Parameters
seg_templateThe SegmentTemplate to set in this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentTemplate() [5/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentTemplate ( SegmentTemplate && seg_template)
inline

Set the SegmentTemplate

Move the value of SegmentTemplate seg_template as the SegmentTemplate for this AdaptationSet.

Parameters
seg_templateThe SegmentTemplate to set on this AdaptationSet.
Returns
This AdaptationSet.

◆ segmentTemplate() [6/6]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::segmentTemplate ( std::optional< SegmentTemplate > && seg_template)
inline

Set the SegmentTemplate

Set the SegmentTemplate of this AdaptationSet to seg_template.

Parameters
seg_templateThe SegmentTemplate to set in this AdaptationSet.
Returns
This AdaptationSet.

◆ selectAllRepresentations()

void com::bbc::libmpdpp::AdaptationSet::selectAllRepresentations ( )

Mark all Representations as selected

This will mark all child Represtation objects as selected for this AdaptationSet.

See also
selectRepresentation()
deselectAllRepresentations()
deselectRepresentation()
selectedSegmentAvailability()
selectedInitializationSegments()

◆ selectedInitializationSegments()

std::list< SegmentAvailability > com::bbc::libmpdpp::AdaptationSet::selectedInitializationSegments ( ) const

Get the list of initialization segment availability metadata for all selected Representation objects

This obtains a list of initialization segment availability metadata, for all currently selected Representation objects. The returned list will be empty if there are no initialization segments for the selected Representations.

Returns
A list of initialization segment availability metadata.

◆ selectedRepresentations()

const std::unordered_set< const Representation * > & com::bbc::libmpdpp::AdaptationSet::selectedRepresentations ( ) const
inline

Get the set of selected Representation objects

Returns
The set of selected Representation objects.

◆ selectedSegmentAvailability()

std::list< SegmentAvailability > com::bbc::libmpdpp::AdaptationSet::selectedSegmentAvailability ( const time_type & query_time) const

Get the list of media segment availability metadata for all selected Representation objects

This obtains a list of media segment availability metadata, for all currently selected Representation objects, for media segments available on or after query_time. The returned list will be empty if there are no media segments on or after query_time available in the parent Period associated with this AdaptationSet, i.e. the query_time is after the end of the Period or after the MPD/@pvailabilityEndTime.

Parameters
query_timeThe time to find media segments at or after from the selected Representation objects.
Returns
A list of media segment availability metadata.

◆ selectRepresentation() [1/3]

void com::bbc::libmpdpp::AdaptationSet::selectRepresentation ( const Representation & rep,
bool deselect_others = false )

Mark a Representation as selected

Parameters
repThe Representation to add to the list of selected Representation objects.
deselect_otherstrue if other representations already selected should be deselected.
See also
selectAllRepresentations()
deselectAllRepresentations()
deselectRepresentation()
selectedSegmentAvailability()
selectedInitializationSegments()

◆ selectRepresentation() [2/3]

void com::bbc::libmpdpp::AdaptationSet::selectRepresentation ( const std::list< Representation >::const_iterator & rep_it,
bool deselect_others = false )

Mark a Representation as selected

Parameters
rep_itThe iterator for the Representation to add to the list of selected Representation objects.
deselect_otherstrue if other representations, that are already selected, should be deselected.
See also
representationsBegin()
representationsEnd()
selectAllRepresentations()
deselectAllRepresentations()
deselectRepresentation()
selectedSegmentAvailability()
selectedInitializationSegments()

◆ selectRepresentation() [3/3]

void com::bbc::libmpdpp::AdaptationSet::selectRepresentation ( const std::list< Representation >::iterator & rep_it,
bool deselect_others = false )

Mark a Representation as selected

Parameters
rep_itThe iterator for the Representation to add to the list of selected Representation objects.
deselect_otherstrue if other representations, that are already selected, should be deselected.
See also
representationsBegin()
representationsEnd()
selectAllRepresentations()
deselectAllRepresentations()
deselectRepresentation()
selectedSegmentAvailability()
selectedInitializationSegments()

◆ subsegmentAlignment() [1/2]

bool com::bbc::libmpdpp::AdaptationSet::subsegmentAlignment ( ) const
inline

Get the @subsegmentAlignment attribute value

This indicates that all subsegments in child Representations align without overlap.

Returns
The subsegment alignment flag.

◆ subsegmentAlignment() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::subsegmentAlignment ( bool subsegment_alignment)
inline

Set the @subsegmentAlignment attribute value

This indicates that all subsegments in child Representation entries align without overlap. The default for this attribute is false, therefore setting this value to false will omit it from any XML output.

Parameters
subsegment_alignmentThe value to set the segment alignment flag (@subsegmentAlignment attribute) to.
Returns
This AdaptationSet.

◆ subsegmentStartsWithSAP() [1/3]

const SAP & com::bbc::libmpdpp::AdaptationSet::subsegmentStartsWithSAP ( ) const
inline

Get the @subsegmentStartsWithSAP attribute value

Returns
The @subsegmentStartsWithSAP attribute value.

◆ subsegmentStartsWithSAP() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::subsegmentStartsWithSAP ( const SAP & subsegment_starts_with_sap)
inline

Set the @subsegmentStartsWithSAP attribute value (copy)

The default for this value is 0, therefore setting this to 0 will cause it to be omitted from any XML output.

Parameters
subsegment_starts_with_sapThe subsegment start with SAP value to copy to the @subsegmentStartsWithSAP attribute.
Returns
This AdaptationSet.

◆ subsegmentStartsWithSAP() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::subsegmentStartsWithSAP ( SAP && subsegment_starts_with_sap)
inline

Set the @subsegmentStartsWithSAP attribute value (move)

The default for this value is 0, therefore setting this to 0 will cause it to be omitted from any XML output.

Parameters
subsegment_starts_with_sapThe subsegment start with SAP value to move to the @subsegmentStartsWithSAP attribute.
Returns
This AdaptationSet.

◆ viewpoint()

const Descriptor & com::bbc::libmpdpp::AdaptationSet::viewpoint ( std::list< Descriptor >::size_type idx) const

Get an Viewpoint element

Gets the Viewpoint Descriptor element at index idx in the Viewpoint elements list.

Parameters
idxThe index of the element to fetch.
Returns
The Viewpoint Descriptor at index idx.
Exceptions
std::out_of_rangeIf idx is beyond the end of the list.

◆ viewpoints()

const std::list< Descriptor > & com::bbc::libmpdpp::AdaptationSet::viewpoints ( ) const
inline

Get the list of Viewpoint child elements

Returns
The list of Viewpoint child Descriptor elements

◆ viewpointsAdd() [1/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::viewpointsAdd ( const Descriptor & viewpoint)

Add a Descriptor to the Viewpoint elements

Parameters
viewpointThe Viewpoint Descriptor to add to the list of Viewpoint elements.
Returns
This AdaptationSet.

◆ viewpointsAdd() [2/2]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::viewpointsAdd ( Descriptor && viewpoint)

Add a Descriptor to the Viewpoint elements

Parameters
viewpointThe Viewpoint Descriptor to add to the list of Viewpoint elements.
Returns
This AdaptationSet.

◆ viewpointsBegin() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::viewpointsBegin ( )
inline

Get the start of Viewpoint elements list iterator

Returns
An iterator pointing to the start of the Viewpoint elements list.

◆ viewpointsBegin() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::viewpointsBegin ( ) const
inline

Get the start of Viewpoint elements list iterator

Returns
An iterator pointing to the start of the Viewpoint elements list.

◆ viewpointsContains()

bool com::bbc::libmpdpp::AdaptationSet::viewpointsContains ( const Descriptor & descriptor) const

Check if a Viewpoint Descriptor is in the list

Parameters
descriptorThe Viewpoint Descriptor to look for.
Returns
true if a Descriptor with the same value as descriptor is found, otherwise false.

◆ viewpointsEnd() [1/2]

std::list< Descriptor >::iterator com::bbc::libmpdpp::AdaptationSet::viewpointsEnd ( )
inline

Get the end of Viewpoint elements list iterator

Returns
An iterator pointing to the end of the Viewpoint elements list.

◆ viewpointsEnd() [2/2]

std::list< Descriptor >::const_iterator com::bbc::libmpdpp::AdaptationSet::viewpointsEnd ( ) const
inline

Get the end of Viewpoint elements list iterator

Returns
An iterator pointing to the end of the Viewpoint elements list.

◆ viewpointsRemove() [1/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::viewpointsRemove ( const Descriptor & viewpoint)

Remove a Viewpoint Descriptor from the Viewpoint elements

If the Descriptor viewpoint exists in the Viewpoint elements, remove it from the list.

Parameters
viewpointThe Viewpoint Descriptor to remove from the list of Viewpoint elements.
Returns
This AdaptationSet.

◆ viewpointsRemove() [2/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::viewpointsRemove ( const std::list< Descriptor >::const_iterator & it)

Remove a Viewpoint Descriptor from the Viewpoint elements

Removes the Viewpoint Descriptor, referenced by the iterator it, from the list of Viewpoint elements.

Parameters
itAn iterator referencing an entry in the Viewpoint elements list.
Returns
This AdaptationSet.
See also
viewpointsBegin()
viewpointsEnd()

◆ viewpointsRemove() [3/3]

AdaptationSet & com::bbc::libmpdpp::AdaptationSet::viewpointsRemove ( const std::list< Descriptor >::iterator & it)

Remove a Viewpoint Descriptor from the Viewpoint elements

Removes the Viewpoint Descriptor, referenced by the iterator it, from the list of Viewpoint elements.

Parameters
itAn iterator referencing an entry in the Viewpoint elements list.
Returns
This AdaptationSet.
See also
viewpointsBegin()
viewpointsEnd()

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