ts::TSFileOutputArgs Class Reference

Transport stream file output with command-line arguments. More...

#include <tsTSFileOutputArgs.h>

Public Member Functions
	TSFileOutputArgs (Report *report, bool allow_stdout)
	Constructor.
	TSFileOutputArgs (ReporterBase *delegate, bool allow_stdout)
	Constructor.
bool	close (bool silent=false)
	Close the output file.
void	defineArgs (Args &args)
	Add command line option definitions in an Args.
bool	loadArgs (DuckContext &duck, Args &args)
	Load arguments from command line.
bool	open (AbortInterface *abort=nullptr)
	Open the output file.
bool	write (const TSPacket *buffer, const TSPacketMetadata *pkt_data, size_t packet_count, AbortInterface *abort=nullptr)
	Write packets.

Static Public Attributes
static constexpr cn::milliseconds	DEFAULT_RETRY_INTERVAL = cn::milliseconds(2000)
	Default retry interval in milliseconds.

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]	report	Where 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_stdout	If 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]	delegate	Use the report of another ReporterBase. If delegate is null, log messages are discarded.
[in]	allow_stdout	If 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]

args

Command 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]	duck	TSDuck execution context.
[in,out]	args	Command 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]

abort

An 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]

silent

If 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]	buffer	Address of packets to write.
[in]	pkt_data	Array of metadata for packets. A packet and its metadata have the same index in their respective arrays.
[in]	packet_count	Number of packets to send from buffer.
[in]	abort	An optional abort interface to detect abort requests.

Returns

True on success, false on error.

---

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

• tsTSFileOutputArgs.h