TSDuck Version 3.32-2820 (TSDuck - The MPEG Transport Stream Toolkit)
ts::FileNameRateList Class Reference

Specialized list of file names and an associated repetition rates. More...

Inheritance diagram for ts::FileNameRateList:
Collaboration diagram for ts::FileNameRateList:

Public Types

typedef std::list< FileNameRateSuperClass
 Reference to the superclass.
 

Public Member Functions

 FileNameRateList ()
 Default constructor.
 
 FileNameRateList (const FileNameRateList &other)
 Copy constructor. More...
 
bool getArgs (Args &args, const UChar *option_name=nullptr, MilliSecond default_rate=0)
 Decode a list of parameters containing a list of file names with optional repetition rates in milliseconds. More...
 
size_t scanFiles (size_t retry=1, Report &report=(*(static_cast< ts::Report * >(ts::NullReport::Instance()))))
 Scan the files for update. More...
 

Detailed Description

Specialized list of file names and an associated repetition rates.

This is typically used to handle section files to inject into transport streams.

Constructor & Destructor Documentation

◆ FileNameRateList()

ts::FileNameRateList::FileNameRateList ( const FileNameRateList other)
inline

Copy constructor.

Parameters
[in]otherOther instance to copy.

Member Function Documentation

◆ getArgs()

bool ts::FileNameRateList::getArgs ( Args args,
const UChar option_name = nullptr,
MilliSecond  default_rate = 0 
)

Decode a list of parameters containing a list of file names with optional repetition rates in milliseconds.

Parameters
[in,out]argsInstance of ts::Args containing the command line parameters.
[in]option_nameThe long name of an option. All values of this option are fetched. Each value must be a string "name[=value]" where value is an optional repetition rate in milliseconds.
[in]default_rateDefault repetition rate for files without repetition rate.
Returns
True on success. On error, set error state in args and return false.

◆ scanFiles()

size_t ts::FileNameRateList::scanFiles ( size_t  retry = 1,
Report report = (*(static_cast< ts::Report * >(ts::NullReport::Instance()))) 
)

Scan the files for update.

Update the modification dates of the files.

Parameters
[in]retryNumber of allowed retry in case of error when using the file.
[in]reportWhere to report a verbose message when a file changed.
Returns
Number of files which changed.

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