Shaka Packager SDK
Public Member Functions | Static Public Member Functions | Friends | List of all members
shaka::MpdBuilder Class Reference

This class generates DASH MPDs (Media Presentation Descriptions). More...

#include <mpd_builder.h>

Inheritance diagram for shaka::MpdBuilder:
shaka::MockMpdBuilder

Public Member Functions

 MpdBuilder (const MpdOptions &mpd_options)
 
void AddBaseUrl (const std::string &base_url)
 
virtual PeriodGetOrCreatePeriod (double start_time_in_seconds)
 
virtual bool ToString (std::string *output)
 
void InjectClockForTesting (std::unique_ptr< Clock > clock)
 This is for testing.
 

Static Public Member Functions

static void MakePathsRelativeToMpd (const std::string &mpd_path, MediaInfo *media_info)
 

Friends

class LiveMpdBuilderTest
 
template<DashProfile profile>
class MpdBuilderTest
 

Detailed Description

This class generates DASH MPDs (Media Presentation Descriptions).

Definition at line 37 of file mpd_builder.h.

Constructor & Destructor Documentation

◆ MpdBuilder()

shaka::MpdBuilder::MpdBuilder ( const MpdOptions mpd_options)
explicit

Constructs MpdBuilder.

Parameters
mpd_optionscontains options on how this MPD should be built.

Definition at line 124 of file mpd_builder.cc.

Member Function Documentation

◆ AddBaseUrl()

void shaka::MpdBuilder::AddBaseUrl ( const std::string &  base_url)

Add <BaseURL> entry to the MPD.

Parameters
base_urlURL for <BaseURL> entry.

Definition at line 129 of file mpd_builder.cc.

◆ GetOrCreatePeriod()

Period * shaka::MpdBuilder::GetOrCreatePeriod ( double  start_time_in_seconds)
virtual

Check the existing Periods, if there is one matching the provided start_time_in_seconds, return it; otherwise a new Period is created and returned.

Parameters
start_time_in_secondsis the period start time.
Returns
the Period matching start_time_in_seconds if found; otherwise return a new Period.

Definition at line 133 of file mpd_builder.cc.

◆ MakePathsRelativeToMpd()

void shaka::MpdBuilder::MakePathsRelativeToMpd ( const std::string &  mpd_path,
MediaInfo *  media_info 
)
static

Adjusts the fields of MediaInfo so that paths are relative to the specified MPD path.

Parameters
mpd_pathis the file path of the MPD file.
media_infois the MediaInfo object to be updated with relative paths.

Definition at line 409 of file mpd_builder.cc.

◆ ToString()

bool shaka::MpdBuilder::ToString ( std::string *  output)
virtual

Writes the MPD to the given string.

Parameters
[out]outputis an output string where the MPD gets written.
Returns
true on success, false otherwise.

Definition at line 147 of file mpd_builder.cc.


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