ts::InputSwitcherArgs Class Reference

Transport stream input switcher command-line options. More...

Collaboration diagram for ts::InputSwitcherArgs:

Public Member Functions
	InputSwitcherArgs ()
	Constructor.
void	defineArgs (Args &args)
	Add command line option definitions in an Args. More...
void	enforceDefaults ()
	Enforce default or minimum values.
bool	loadArgs (DuckContext &duck, Args &args)
	Load arguments from command line. More...
bool	setEventUDP (const UString &destination, const UString &local, Report &report)
	Set the UDP destination for event reporting using strings. More...

Public Attributes
IPv4AddressSet	allowedRemote
	Set of allowed remotes.
UString	appName
	Application name, for help messages.
size_t	bufferedPackets
	Input buffer size in packets.
size_t	cycleCount
	Number of input cycles to execute (0 = infinite).
bool	delayedSwitch
	Delayed switch between input plugins.
UString	eventCommand
	External shell command to run on an event.
IPv4Address	eventLocalAddress
	Outgoing local interface for UDP event description.
int	eventTTL
	Time-to-live socket option for event UDP.
IPv4SocketAddress	eventUDP
	Remote UDP socket address for event description.
UString	eventUserData
	User-defined data string in event messages.
bool	fastSwitch
	Fast switch between input plugins.
size_t	firstInput
	Index of first input plugin.
PluginOptionsVector	inputs
	Input plugins descriptions.
size_t	maxInputPackets
	Maximum input packets to read at a time.
size_t	maxOutputPackets
	Maximum output packets to send at a time.
PluginOptions	output
	Output plugin description.
size_t	primaryInput
	Index of primary input plugin, NPOS if there is none.
MilliSecond	receiveTimeout
	Receive timeout before switch (0=none).
IPv4SocketAddress	remoteServer
	UDP server address for remote control.
bool	reusePort
	Reuse-port socket option.
size_t	sockBuffer
	Socket buffer size.
bool	terminate
	Terminate when one input plugin completes.

Static Public Attributes
static constexpr size_t	DEFAULT_BUFFERED_PACKETS = 512
	Default input size buffer in packets.
static constexpr size_t	DEFAULT_MAX_INPUT_PACKETS = 128
	Default maximum input packets to read at a time.
static constexpr size_t	DEFAULT_MAX_OUTPUT_PACKETS = 128
	Default maximum input packets to send at a time.
static constexpr MilliSecond	DEFAULT_RECEIVE_TIMEOUT = 2000
	Default received timeout with –primary-input.
static constexpr size_t	MIN_BUFFERED_PACKETS = 16
	Minimum input size buffer in packets.
static constexpr size_t	MIN_INPUT_PACKETS = 1
	Minimum input packets to read at a time.
static constexpr size_t	MIN_OUTPUT_PACKETS = 1
	Minimum input packets to send at a time.

Detailed Description

Transport stream input switcher command-line options.

Member Function Documentation

setEventUDP()

bool ts::InputSwitcherArgs::setEventUDP	(	const UString &	destination,
		const UString &	local,
		Report &	report
	)

Set the UDP destination for event reporting using strings.

Parameters

[in]	destination	Remote UDP socket address for event description. Empty to erase the destination.
[in]	local	Outgoing local interface for UDP event description. Can be empty.
[in,out]	report	Where to report errors.

Returns

True on success, false on failure.

defineArgs()

void ts::InputSwitcherArgs::defineArgs

(

Args &

args

)

Add command line option definitions in an Args.

Parameters

[in,out]

args

Command line arguments to update.

loadArgs()

bool ts::InputSwitcherArgs::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.

---

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

• tsInputSwitcherArgs.h