tsduck.InputSwitcher Class Reference

A wrapper class for C++ InputSwitcher. More...

Inheritance diagram for tsduck.InputSwitcher:

Collaboration diagram for tsduck.InputSwitcher:

Public Member Functions
	__init__ (self, report)
	Constructor.
	currentInput (self)
	Get the index of the current input plugin.
	delete (self)
	Explicitly free the underlying C++ object.
	nextInput (self)
	Switch to the next input plugin.
	previousInput (self)
	Switch to the previous input plugin.
	setInput (self, plugin_index)
	Switch to another input plugin.
	start (self)
	Start the input switcher.
	stop (self)
	Terminate the processing.
	waitForTermination (self)
	Suspend the calling thread until input switcher session is completed.

Public Attributes
	app_name
	Application name, for help messages.
	buffered_packets
	Input buffer size in packets (0=default).
	cycle_count
	Number of input cycles to execute (0 = infinite).
	delayed_switch
	Delayed switch between input plugins.
	event_command
	External shell command to run on a switching event.
	event_local_address
	Outgoing local interface for UDP event description.
	event_ttl
	Time-to-live socket option for UDP event description.
	event_udp_address
	Remote IPv4 address or host name to receive switching event JSON description.
	event_udp_port
	Remote UDP port to receive switching event JSON description.
	fast_switch
	Fast switch between input plugins.
	first_input
	Index of first input plugin.
	inputs
	Input plugins name and arguments (list of lists of strings).
	max_input_packets
	Maximum input packets to read at a time (0=default).
	max_output_packets
	Maximum input packets to send at a time (0=default).
	output
	Output plugin name and arguments (list of strings)
	primary_input
	Index of primary input plugin, negative if there is none.
	receive_timeout
	Receive timeout before switch (0=none).
	remote_server_port
	UDP server port for remote control (0=none).
	reuse_port
	Reuse-port socket option.
	sock_buffer
	Socket buffer size (0=default).
	terminate
	Terminate when one input plugin completes.

Detailed Description

A wrapper class for C++ InputSwitcher.

Constructor & Destructor Documentation

__init__()

tsduck.InputSwitcher.__init__	(		self,
			report
	)

Constructor.

Parameters

report

The tsduck.Report object to use.

Reimplemented from tsduck.PluginEventHandlerRegistry.

Member Function Documentation

delete()

tsduck.InputSwitcher.delete

(

self

)

Explicitly free the underlying C++ object.

After this call, the object becomes unusable. Most usages are unpredictable but most likely will do nothing.

Returns

None.

Reimplemented from tsduck.NativeObject.

start()

tsduck.InputSwitcher.start

(

self

)

Start the input switcher.

All properties shall have been set before calling this method.

Returns

None.

setInput()

tsduck.InputSwitcher.setInput	(		self,
			plugin_index
	)

Switch to another input plugin.

Parameters

plugin_index

Index of the new input plugin.

Returns

None.

nextInput()

tsduck.InputSwitcher.nextInput

(

self

)

Switch to the next input plugin.

Returns

None.

previousInput()

tsduck.InputSwitcher.previousInput

(

self

)

Switch to the previous input plugin.

Returns

None.

currentInput()

tsduck.InputSwitcher.currentInput

(

self

)

Get the index of the current input plugin.

Returns

The index of the current input plugin.

stop()

tsduck.InputSwitcher.stop

(

self

)

Terminate the processing.

Returns

None.

waitForTermination()

tsduck.InputSwitcher.waitForTermination

(

self

)

Suspend the calling thread until input switcher session is completed.

Returns

None.

---

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

• tsduck.py