TSDuck v3.46-4965
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::TSFileOutputArgs Class Reference

#include <tsTSFileOutputArgs.h>

Public Member Functions

 TSFileOutputArgs (Report *report, bool allow_stdout)
 TSFileOutputArgs (ReporterBase *delegate, bool allow_stdout)
bool close (bool silent=false)
void defineArgs (Args &args)
bool loadArgs (DuckContext &duck, Args &args)
bool open (AbortInterface *abort=nullptr)
bool write (const TSPacket *buffer, const TSPacketMetadata *pkt_data, size_t packet_count, AbortInterface *abort=nullptr)

Static Public Attributes

static constexpr cn::milliseconds DEFAULT_RETRY_INTERVAL = cn::milliseconds(2000)

Detailed Description

Transport stream file output with command-line arguments.

Constructor & Destructor Documentation

◆ TSFileOutputArgs() [1/2]

ts::TSFileOutputArgs::TSFileOutputArgs ( Report * report,
bool allow_stdout )

Constructor.

Parameters
[in]reportWhere to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.
[in]allow_stdoutIf true, the file name is optional and standard output is used by default.

◆ TSFileOutputArgs() [2/2]

ts::TSFileOutputArgs::TSFileOutputArgs ( ReporterBase * delegate,
bool allow_stdout )

Constructor.

Parameters
[in]delegateUse the report of another ReporterBase. If delegate is null, log messages are discarded.
[in]allow_stdoutIf true, the file name is optional and standard output is used by default.

Member Function Documentation

◆ defineArgs()

void ts::TSFileOutputArgs::defineArgs ( Args & args)

Add command line option definitions in an Args.

Parameters
[in,out]argsCommand line arguments to update.

◆ loadArgs()

bool ts::TSFileOutputArgs::loadArgs ( DuckContext & duck,
Args & args )

Load arguments from command line. Args error indicator is set in case of incorrect arguments.

Parameters
[in,out]duckTSDuck execution context.
[in,out]argsCommand line arguments.
Returns
True on success, false on error in argument line.

◆ open()

bool ts::TSFileOutputArgs::open ( AbortInterface * abort = nullptr)

Open the output file. All parameters where loaded from the command line by loadArgs().

Parameters
[in]abortAn optional abort interface to detect abort requests.
Returns
True on success, false on error.

◆ close()

bool ts::TSFileOutputArgs::close ( bool silent = false)

Close the output file.

Parameters
[in]silentIf true, do not report errors. This is typically useful when the object is in some error condition and closing it is necessary although it may generate additional meaningless errors.
Returns
True on success, false on error.

◆ write()

bool ts::TSFileOutputArgs::write ( const TSPacket * buffer,
const TSPacketMetadata * pkt_data,
size_t packet_count,
AbortInterface * abort = nullptr )

Write packets.

Parameters
[in]bufferAddress of packets to write.
[in]pkt_dataArray of metadata for packets. A packet and its metadata have the same index in their respective arrays.
[in]packet_countNumber of packets to send from buffer.
[in]abortAn optional abort interface to detect abort requests.
Returns
True on success, false on error.

Member Data Documentation

◆ DEFAULT_RETRY_INTERVAL

cn::milliseconds ts::TSFileOutputArgs::DEFAULT_RETRY_INTERVAL = cn::milliseconds(2000)
staticconstexpr

Default retry interval in milliseconds.


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