TVCaster XML-RPC API

Documentation of all functions of the TVCaster XML-RPC API. More...


Classes
struct	RPCDVBDeviceInfo
	Information about a DVB device. More...
struct	RPCClientInfo
	Information about an NMM client or NMM processing host. More...
struct	RPCStreamInfo
	Information about an NMM client or NMM processing host. More...
struct	RPCRecordingJob
	Information about a Codeccaster recording job. More...
struct	RPCSignalInformation
	Signal information for a channel. More...
Functions
array< RPCDVBDeviceInfo >	rpc_discoverDVBCards ()
	Discovers all DVB devices in the network.
array< RPCClientInfo >	rpc_discoverClients ()
	Discovers all NMM clients in the network.
void	rpc_addClient (in string client_mac, in string client_ip, in string client_name)
	Adds a client.
void	rpc_removeClient (in string client_mac, in string client_ip, in string client_name)
	Removes a client.
array< RPCClientInfo >	rpc_discoverProcessingHosts ()
	Discovers all NMM processing hosts in the network.
integer	rpc_createCorporateStream (string dvb_source_hostname, integer card_id, integer dvb_channel, string streaming_address, integer streaming_port, boolean use_rtp_strategy, string netsink_location, boolean discard_sdt, boolean discard_eit, boolean generate_pat, descramble_service)
	Creates a Corporate stream.
integer	rpc_startStream (integer stream_id)
	Starts a specific stream.
integer	rpc_stopStream (integer id)
	Stops a specific stream.
integer	rpc_modifyCorporateStream (integer stream_id, string dvb_source_hostname, integer card_id, integer dvb_channel, string streaming_address, integer streaming_port, boolean use_rtp_strategy, string netsink_location, boolean discard_sdt, boolean discard_eit, boolean generate_pat, boolean descramble_service)
	Modifies a Corporate stream.
integer	rpc_destroyStream (integer id)
	Destroys a specific stream.
integer	rpc_createHomeStream (string dvb_source_hostname, integer card_id, integer dvb_channel, string streaming_address, integer streaming_port, boolean use_rtp_strategy, string netsink_location, boolean discard_sdt, boolean discard_eit, boolean generate_pat, string client_id, boolean descramble_service)
	Creates a new Home stream.
array< RPCStreamInfo >	rpc_getStreams ()
	Gets information about all streams.
array< RPCDVBDeviceInfo >	rpc_getDVBCards ()
	Gets information about all DVB devices.
array< RPCClientInfo >	rpc_getClients ()
	Gets information about all NMM clients.
array< RPCClientInfo >	rpc_getProcessingHosts ()
	Gets information about all NMM processing hosts.
array< string >	rpc_getStreamingModes ()
	Get streaming modes.
array< string >	rpc_getChannelList (string dvb_host, integer card_id)
	Gets the channel list for a specific DVB device.
array< integer >	rpc_getCurrentChannels (string dvb_host, integer card_id)
	Gets the current channel list for a specific DVB device.
array< RPCSignalInformation >	rpc_getSignalInformations (string dvb_host, integer card_id)
	Get signal information for all channels.
array< string >	rpc_getClientChannelList (string client_id)
	Gets the channel list for a specific client.
integer	rpc_loadConfig (string file)
	Loads the configuration.
string	rpc_exportConfig ()
	Exports the configuration to a string.
integer	rpc_importConfig (string configuration)
	Imports the configuration from a string.
integer	rpc_updateDVBConfig (string dvb_source_hostname, integer card_id, string streaming_mode)
	Sets the streaming mode of a DVB device.
integer	rpc_resetConfig ()
	Resets the configuration.
integer	rpc_updateCardName (string dvb_source_hostname, integer card_id, string card_name)
	Sets the card name of a specific DVB device.
integer	rpc_updateChannelAssignment (string dvb_source_hostname, integer card_id, integer channel_id, string remux_location, bool parse_eit)
	Assigns a channel to a DVB device configured for Corporate Mode.
integer	rpc_updateClientConfig (string client_name, string client_ip, string client_mac)
	Updates the configuration of an NMM client in Home Mode.
integer	rpc_updateClientAssignment (string dvb_source_hostname, integer card_id, string client_id)
	Assigns a DVB device to an NMM client.
array< string >	rpc_exportChannelsConfig (string dvb_host, integer card_id)
	Exports the channel configuration of a specific DVB device.
integer	rpc_importChannelsConfig (string dvb_host, integer card_id, array< string > channels)
	Imports the channel configuration of a specific DVB device.
array< string >	rpc_exportTransponderList (string dvb_host, integer card_id, string filename)
	Exports a transponder list of a specific DVB device.
integer	rpc_importTransponderList (string dvb_host, integer card_id, array< string > transponder_list, string filename)
	Imports a transponder list of a specific DVB device.
integer	rpc_startChannelSearch (string dvb_host, integer card_id, string initial_tuning_file)
	Starts a channel search.
integer	rpc_stopChannelSearch (string dvb_host, integer card_id)
	Stops a channel search.
array< string >	rpc_getInitialTuningFiles (string dvb_host, integer card_id)
	Gets a list of initial tuning files.
integer	rpc_getSearchTransponders (string dvb_host, integer card_id)
	Gets the number of transponders used by the channel search.
integer	rpc_getSearchCompletedTransponders (string dvb_host, integer card_id)
	Gets the number of completed transponders.
integer	rpc_getNumberOfStreams ()
	Gets the number of streams.
double	rpc_getOutgoingBandwidthGbE ()
	Gets the outgoing bandwidth of the GbE (gigabit ethernet) port.
double	rpc_getOutgoingBandwidthMgmt ()
	Gets the outgoing bandwidth of the Mgmt (management) port.
double	rpc_getCPULoad ()
	Gets the CPU load.
string	rpc_getDiskUsageAll ()
	Get the disk usage of the "/" directory.
string	rpc_getDiskUsageHome ()
	Get the disk usage of the "/home" directory.
string	rpc_getDiskUsageVideo ()
	Get the disk usage of the "/home/nmm/video" directory.
double	rpc_getPercentageDiskUsageAll ()
	Get the percentage disk usage of the "/" directory in percent.
double	rpc_getPercentageDiskUsageHome ()
	Get the percentage disk usage of the "/home" directory in percent.
double	rpc_getPercentageDiskUsageVideo ()
	Get the percentage disk usage of the "/home/nmm/video" directory in percent.
integer	rpc_getTotalMemory ()
	Get the total amount of physical memory.
integer	rpc_getUsedMemory ()
	Get the used amount of physical memory.
integer	rpc_getFreeMemory ()
	Get the free amount of physical memory.
double	rpc_getPercentageMemoryUsage ()
	Get the percentage of used physical memory.
integer	rpc_getTotalSwapSpace ()
	Get the total amount of swap space.
integer	rpc_getUsedSwapSpace ()
	Get the used amount of swap space.
integer	rpc_getFreeSwapSpace ()
	Get the free amount of swap space.
double	rpc_getPercentageSwapSpaceUsage ()
	Get the percentage of used swap space.
integer	rpc_getMaxNumberOfStreams ()
	Gets the maximal recommended number of streams.
double	rpc_getMaxOutgoingBandwidth ()
	Gets the maximum recommended outgoing bandwidth.
double	rpc_getMaxCPULoad ()
	Gets the maximum recommended CPU load.
double	rpc_getMaxDiskUsage ()
	Gets the maximum recommended disk usage.
array< RPCRecordingJobInfo >	rpc_getRecordings (string recording_host)
	Gets information about recording jobs.
array< integer >	rpc_addRecording (string recording_host, string time, string command)
	Adds a new recording job.
array< integer >	rpc_deleteRecording (string recording_host, integer id)
	Deletes a recording job.
string	rpc_getTVCasterHostname ()
	Gets the host name of the TVCaster system.
integer	rpc_getTVCasterPort ()
	Gets the post number of the TVCaster system.

Detailed Description

Documentation of all functions of the TVCaster XML-RPC API.

This documentation is generated from nmm/services/tvcaster/interfaces/xmlrpc.hpp Note that the method prototypes in this file are not C++ methods, but describe the signatures of functions which can be called through the XML-RPC interface.

The following notation is used for describing data types of parameters and results of remote procedure calls: (taken from http://en.wikipedia.org/wiki/XML-RPC)

base64 : Base64-encoded binary data
boolean : Boolean logical value (0 or 1)
date_time : Date and time in ISO 8601 format
double : Double precision floating point number
integer : Whole number, integer
string : String of characters. Must follow XML encoding.
nil : Discriminated null value; an XML-RPC extension

Special types:

array type (Array of values, storing no keys). The notation array<T> is used to describe "an array of elements of type T", e.g. array<string> means "an array of strings".

struct type (Associative array). In this documentation, structs are given names and documented separately. For example, RPCDVBDeviceInfo is a struct which is returned by some functions of the XML-RPC API. The documentation of each struct describes its members with their types and names.

Function Documentation

void rpc_addClient	(	in string	client_mac,
		in string	client_ip,
		in string	client_name
	)

Adds a client.

Adds a client in cases where NMM discovery does not work or is not available, e.g. on third party devices, such as set-top boxes.

Parameters:

	client_mac	MAC of client (required)
	client_ip	IP address of client (optional; can be empty string)
	clien_name	Name of client (required)

array<integer> rpc_addRecording	(	string	recording_host,
		string	time,
		string	command
	)

Adds a new recording job.

Adds a recording job on the given recording host.

Parameters:

	recording_host	Host name of recording host
	time	Time at which recording starts
	command	Recording command

Returns:: Empty array

integer rpc_createCorporateStream	(	string	dvb_source_hostname,
		integer	card_id,
		integer	dvb_channel,
		string	streaming_address,
		integer	streaming_port,
		boolean	use_rtp_strategy,
		string	netsink_location,
		boolean	discard_sdt,
		boolean	discard_eit,
		boolean	generate_pat,
		descramble_service
	)

Creates a Corporate stream.

Creates a Corporate stream with the specified parameters.

Parameters:

	dvb_source_hostname	Host name of DVB source system
	card_id	Index of DVB device on DVB source system
	dvb_channel	Index of DVB channel
	streaming_address	Destination IP address
	streaming_port	Destination port
	use_rtp_strategy	Use RTP transport protocol (default: use UDP)
	netsink_location	Host name of network sink system
	discard_sdt	Discard SDT (default: Pass through SDT)
	discard_eit	Discard EIT (default: Pass through EIT)
	generate_pat	Generate new PAT (default: Pass through PAT)
	descramble_service	Indicates whether the service is descrambled or not

Returns:: Stream ID of created stream

integer rpc_createHomeStream	(	string	dvb_source_hostname,
		integer	card_id,
		integer	dvb_channel,
		string	streaming_address,
		integer	streaming_port,
		boolean	use_rtp_strategy,
		string	netsink_location,
		boolean	discard_sdt,
		boolean	discard_eit,
		boolean	generate_pat,
		string	client_id,
		boolean	descramble_service
	)

Creates a new Home stream.

Destroys all streams with matching client_id and creates a new Home stream with the specified parameters.

Parameters:

	dvb_source_hostname	Host name of DVB source system
	card_id	Index of DVB device on DVB source system
	dvb_channel	Index of DVB channel
	streaming_address	Destination IP address
	streaming_port	Destination port
	use_rtp_strategy	Use RTP transport protocol (default: use UDP)
	netsink_location	Host name of network sink system
	discard_sdt	Discard SDT (default: Pass through SDT)
	discard_eit	Discard EIT (default: Pass through EIT)
	generate_pat	Generate new PAT (default: Pass through PAT)
	client_id	Client ID
	descramble_service	Indicates whether the service is descrambled or not

Returns:: Stream ID of created stream

array<integer> rpc_deleteRecording	(	string	recording_host,
		integer	id
	)

Deletes a recording job.

Deletes a recording job on the given recording host.

Parameters:

	recording_host	Host name of recording host
	id	ID of recording job

Returns:: Empty array

integer rpc_destroyStream ( integer id )

Destroys a specific stream.

Destroys the stream with the given stream ID.

Parameters:

id

Stream ID of stream to destroy

Returns:: 1

array<RPCClientInfo> rpc_discoverClients ( )

Discovers all NMM clients in the network.

Discovers all NMM clients which run a serverregistry in the network.

Returns:: Array containing information about found NMM clients

array<RPCDVBDeviceInfo> rpc_discoverDVBCards ( )

Discovers all DVB devices in the network.

Discovers all DVB devices in the network as follows:

Scans for running serverregistries
Checks if IDVBDevice is available
Checks how many DVB devices are available
Gets information about each DVB device

Returns:: Array containing information about found DVB devices

array<RPCClientInfo> rpc_discoverProcessingHosts ( )

Discovers all NMM processing hosts in the network.

Searches all NMM hosts in the network which can be used for processing of specific tasks (e.g. remultiplexing)

Returns:: Array containing information about found NMM processing hosts

array<string> rpc_exportChannelsConfig	(	string	dvb_host,
		integer	card_id
	)

Exports the channel configuration of a specific DVB device.

Exports the channel configuration of the DVB device with the given card ID on the given system to a list of channel configuration strings. The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device

Returns:: Array with channel configuration strings

string rpc_exportConfig ( )

Exports the configuration to a string.

Exports the complete configuration of the TVCaster as a string.

Returns:: Exported configuration as string

array<string> rpc_exportTransponderList	(	string	dvb_host,
		integer	card_id,
		string	filename
	)

Exports a transponder list of a specific DVB device.

Exports a transponder list of the DVB device with the given card ID on the given system to a file.

The file is stored in the directory $HOME/.nmm/<DEVICE_TYPE> where <DEVICE_TYPE> is the type of the DVB device (e.g. "DVB-S2").

The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	filename	Name of file containing the transponder list

Returns:: Array with content of transponder list

array<string> rpc_getChannelList	(	string	dvb_host,
		integer	card_id
	)

Gets the channel list for a specific DVB device.

Gets the list of known channels from a DVB device on the system with the given card ID.

Parameters:

	dvb_host	Hostname of system on which DVB device is installed
	card_id	Card ID of DVB device on the given system

Returns:: Array with channel information

array<string> rpc_getClientChannelList ( string client_id )

Gets the channel list for a specific client.

Gets the list of known channels from the DVB device which is assigned to the NMM client with the the given client ID.

Parameters:

client_id

Client ID of the NMM client

Returns:: Array with channel information

Referenced by main().

array<RPCClientInfo> rpc_getClients ( )

Gets information about all NMM clients.

Gets information about all NMM clients and their current configuration.

Returns:: Array with information about all NMM clients

double rpc_getCPULoad ( )

Gets the CPU load.

This method returns the CPU load of the server

Returns:: CPU load of the server

array<integer> rpc_getCurrentChannels	(	string	dvb_host,
		integer	card_id
	)

Gets the current channel list for a specific DVB device.

Gets the list of currently available channels from a DVB device on the system with the given card ID.

Parameters:

	dvb_host	Hostname of system on which DVB device is installed
	card_id	Card ID of DVB device on the given system

Returns:: Array with channel numbers of available channels

string rpc_getDiskUsageAll ( )

Get the disk usage of the "/" directory.

This method returns the disk usage of the "/" directory.

Returns:: Disk usage of the "/" directory

string rpc_getDiskUsageHome ( )

Get the disk usage of the "/home" directory.

This method returns he disk usage of the "/home" directory.

Returns:: Disk usage of the "/home" directory

string rpc_getDiskUsageVideo ( )

Get the disk usage of the "/home/nmm/video" directory.

This method returns he disk usage of the "/home/nmm/video" directory.

Returns:: Disk usage of the "/home/nmm/video" directory

array<RPCDVBDeviceInfo> rpc_getDVBCards ( )

Gets information about all DVB devices.

Gets information all available DVB devices and their current configuration.

Returns:: Array with information about all DVB devices

Referenced by main().

integer rpc_getFreeMemory ( )

Get the free amount of physical memory.

This method returns the free amount of physical memory.

Returns:: Free amount of physical memory (in kb)

integer rpc_getFreeSwapSpace ( )

Get the free amount of swap space.

This method returns the free amount of swap space.

Returns:: Free amount of swap space (in kb)

array<string> rpc_getInitialTuningFiles	(	string	dvb_host,
		integer	card_id
	)

Gets a list of initial tuning files.

Gets a list of initial tuning files located in the directory <RESOURCE_DIR>/dvb/initial_tuning_files/<DEVICE_TYPE> for the DVB device with the given card ID on the given system, where <DEVICE_TYPE> is the type of the DVB device (e.g. "DVB-S2") and <RESOURCE_DIR> is a subdirectory of the installation directory of the TVCaster software.

The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device

Returns:: Array of file names of initial tuning files

double rpc_getMaxCPULoad ( )

Gets the maximum recommended CPU load.

This method returns the maximum recommended CPU load.

Returns:: Maximum recommended CPU load

double rpc_getMaxDiskUsage ( )

Gets the maximum recommended disk usage.

This method returns maximum recommended disk usage.

Returns:: Maximum recommended disk usage

integer rpc_getMaxNumberOfStreams ( )

Gets the maximal recommended number of streams.

This method returns the maximal recommended number of streams

Returns:: Maximum recommended number of streams

double rpc_getMaxOutgoingBandwidth ( )

Gets the maximum recommended outgoing bandwidth.

This method returns the maximum recommended outgoing bandwidth.

Returns:: Maximum recommended outgoing bandwidth

integer rpc_getNumberOfStreams ( )

Gets the number of streams.

This method returns the actual number of streams on both, GbE (gigabit ethernet) and Mgmt (management) port.

Returns:: Number of streams

double rpc_getOutgoingBandwidthGbE ( )

Gets the outgoing bandwidth of the GbE (gigabit ethernet) port.

This method returns the outgoing bandwidth of the GbE (gigabit ethernet) port in Mbps.

Returns:: Outgoing bandwidth of the GbE port in Mbps

double rpc_getOutgoingBandwidthMgmt ( )

Gets the outgoing bandwidth of the Mgmt (management) port.

This method returns the outgoing bandwidth of the Mgmt (management) port in Mbps.

Returns:: Outgoing bandwidth of the Mgmt port in Mbps

double rpc_getPercentageDiskUsageAll ( )

Get the percentage disk usage of the "/" directory in percent.

This method returns the percentage disk usage of the "/" directory.

Returns:: Percentage Disk usage of the "/" directory

double rpc_getPercentageDiskUsageHome ( )

Get the percentage disk usage of the "/home" directory in percent.

This method returns the percentage disk usage of the "/home" directory.

Returns:: Percentage Disk usage of the "/home" directory

double rpc_getPercentageDiskUsageVideo ( )

Get the percentage disk usage of the "/home/nmm/video" directory in percent.

This method returns the percentage disk usage of the "/home/nmm/video" directory.

Returns:: Percentage Disk usage of the "/home/nmm/video" directory

double rpc_getPercentageMemoryUsage ( )

Get the percentage of used physical memory.

This method returns the percentage of total physical memory used by all processes.

Returns:: Percentage of used physical memory

double rpc_getPercentageSwapSpaceUsage ( )

Get the percentage of used swap space.

This method returns the percentage of total swap space used by all processes.

Returns:: Percentage of used swap space

array<RPCClientInfo> rpc_getProcessingHosts ( )

Gets information about all NMM processing hosts.

Gets information about all NMM processing hosts and their current configuration.

Returns:: Array with information about all NMM processing hosts

array<RPCRecordingJobInfo> rpc_getRecordings ( string recording_host )

Gets information about recording jobs.

Returns an array with information about all recording jobs on the given recording host.

Parameters:

recording_host

Host name of recording host

Returns:: Array with information about recordings

integer rpc_getSearchCompletedTransponders	(	string	dvb_host,
		integer	card_id
	)

Gets the number of completed transponders.

Gets the number of transponders which have already been searched by the channel search.

The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device

Returns:: Number of transponders completed by the channel search

integer rpc_getSearchTransponders	(	string	dvb_host,
		integer	card_id
	)

Gets the number of transponders used by the channel search.

Gets the number of transponders which have been loaded from the initial tuning file and are used by the channel search.

The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device

Returns:: Number of transponders used by the channel search

array<RPCSignalInformation> rpc_getSignalInformations	(	string	dvb_host,
		integer	card_id
	)

Get signal information for all channels.

Gets the signal information for all known channels from a DVB device on the system with the given card ID.

Parameters:

	dvb_host	Hostname of system on which DVB device is installed
	card_id	Card ID of DVB device on the given system

Returns:: Array with signal information of each channel contained in channel list

array<string> rpc_getStreamingModes ( )

Get streaming modes.

Returns the names pf all available streaming modes.

Returns:: Array with names of streaming modes

array<RPCStreamInfo> rpc_getStreams ( )

Gets information about all streams.

Returns information about all currently active streams.

Returns:: Array with information about all streams

integer rpc_getTotalMemory ( )

Get the total amount of physical memory.

This method returns the total amount of physical memory.

Returns:: Total amount of physical memory (in kb)

integer rpc_getTotalSwapSpace ( )

Get the total amount of swap space.

This method returns the total amount of swap space.

Returns:: Total amount of swap space (in kb)

string rpc_getTVCasterHostname ( )

Gets the host name of the TVCaster system.

Returns the host name of the TVCaster system to which the RPC server is connected.

Returns:: Host name of TVCaster system

Referenced by main().

integer rpc_getTVCasterPort ( )

Gets the post number of the TVCaster system.

Returns the post number of the TVCaster system to which the RPC server is connected.

Returns:: Port number of TVCaster system

Referenced by main().

integer rpc_getUsedMemory ( )

Get the used amount of physical memory.

This method returns the amount of physical memory used by all processes.

Returns:: Used amount of physical memory (in kb)

integer rpc_getUsedSwapSpace ( )

Get the used amount of swap space.

This method returns the amount of swap space used by all processes.

Returns:: Used amount of swap space (in kb)

integer rpc_importChannelsConfig	(	string	dvb_host,
		integer	card_id,
		array< string >	channels
	)

Imports the channel configuration of a specific DVB device.

Imports the channel configuration of the DVB device with the given card ID on the given system from a list of channel configuration strings. The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	channels	Array with channel configuration strings

Returns:: 1

integer rpc_importConfig ( string configuration )

Imports the configuration from a string.

Imports the complete configuration of the TVCaster from a string.

Parameters:

configuration

Configuration to be imported as string

Returns:: 1

integer rpc_importTransponderList	(	string	dvb_host,
		integer	card_id,
		array< string >	transponder_list,
		string	filename
	)

Imports a transponder list of a specific DVB device.

Imports a transponder list from a file of the DVB device with the given card ID on the given system.

The file is stored in the directory $HOME/.nmm/<DEVICE_TYPE> where <DEVICE_TYPE> is the type of the DVB device (e.g. "DVB-S2").

The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	transponder_list	Array with transponder configuration strings
	filename	Name of file containing the transponder list

Returns:: 1

integer rpc_loadConfig ( string file )

Loads the configuration.

Loads the complete configuration of the TVCaster from a file and starts all streams in the configuration. If the configuration file does not exist, a new configuration is created.

Parameters:

file

Filename of the configuration file

Returns:: 1

integer rpc_modifyCorporateStream	(	integer	stream_id,
		string	dvb_source_hostname,
		integer	card_id,
		integer	dvb_channel,
		string	streaming_address,
		integer	streaming_port,
		boolean	use_rtp_strategy,
		string	netsink_location,
		boolean	discard_sdt,
		boolean	discard_eit,
		boolean	generate_pat,
		boolean	descramble_service
	)

Modifies a Corporate stream.

Modifies a Corporate stream with the parameters specified in new_stream.

Parameters:

	stream_id	Stream ID of stream to modify
	dvb_source_hostname	Host name of DVB source system
	card_id	Index of DVB device on DVB source system
	dvb_channel	Index of DVB channel
	streaming_address	Destination IP address
	streaming_port	Destination port
	use_rtp_strategy	Use RTP transport protocol (default: use UDP)
	netsink_location	Host name of network sink system
	discard_sdt	Discard SDT (default: Pass through SDT)
	discard_eit	Discard EIT (default: Pass through EIT)
	generate_pat	Generate new PAT (default: Pass through PAT)
	descramble_service	Indicates whether the service is descrambled or not

Returns:: 1

void rpc_removeClient	(	in string	client_mac,
		in string	client_ip,
		in string	client_name
	)

Removes a client.

Removes a client by the given information, which can either refer to a manually added client or a discovered NMM client.

Parameters:

	client_mac	MAC of client (required)
	client_ip	IP address of client (optional; can be empty string)
	clien_name	Name of client (required)

integer rpc_resetConfig ( )

Resets the configuration.

Terminates the TVCaster with exit code 11 to reset the configuration to defaults.

Returns:: 1

integer rpc_startChannelSearch	(	string	dvb_host,
		integer	card_id,
		string	initial_tuning_file
	)

Starts a channel search.

Starts a channel search on the DVB device with the given card ID on the given system by tuning to each transponder of the initial tuning file and parsing PAT, PMT and SDT tables.

The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	initial_tuning_file	Location of file which contains initial tuning information

Returns:: 1

integer rpc_startStream ( integer stream_id )

Starts a specific stream.

Starts the stream with the given stream ID.

Parameters:

stream_id

Stream ID of stream to start

Returns:: 1

integer rpc_stopChannelSearch	(	string	dvb_host,
		integer	card_id
	)

Stops a channel search.

Stops a running channel search on the DVB device with the given card ID on the given system.

The streaming mode of the DVB device must be set to Configure Mode.

Parameters:

	dvb_host	Host name of system where DVB device is installed
	card_id	Card ID of DVB device

Returns:: 1

integer rpc_stopStream ( integer id )

Stops a specific stream.

Stops the stream with the given stream ID.

Parameters:

id

Stream ID of stream to stop

Returns:: 1

integer rpc_updateCardName	(	string	dvb_source_hostname,
		integer	card_id,
		string	card_name
	)

Sets the card name of a specific DVB device.

Sets the card name of the DVB device with the given card ID on the given system. The card name is purely descriptive and optional.

Parameters:

	dvb_source_hostname	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	card_name	Card name to be set

Returns:: 1

integer rpc_updateChannelAssignment	(	string	dvb_source_hostname,
		integer	card_id,
		integer	channel_id,
		string	remux_location,
		bool	parse_eit
	)

Assigns a channel to a DVB device configured for Corporate Mode.

Sets the channel of a DVB device configured for Corporate Mode. This makes the channel and all other channels on the same transponder available for streaming.

Also assigns an NMM processing host to the card for remultiplexing. Typically, this is the host on which the DVB device is installed (i.e. remux_location and dvb_source_hostname are identical). However, it is possible to use any available NMM processing host.

Parameters:

	dvb_source_hostname	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	channel_id	Index of the channel in the channel list
	remux_location	Host name of NMM processing host for remultiplexing
	parse_eit	Indicates if the EIT shall be parsed or not

Returns:: 1

integer rpc_updateClientAssignment	(	string	dvb_source_hostname,
		integer	card_id,
		string	client_id
	)

Assigns a DVB device to an NMM client.

Assigns the DVB device with the given card ID on the given system to the NMM client with the given client ID. The DVB device must be configured for Home Mode.

A DVB device may be assigned to at most one client. To assign a DVB device to no client, pass "None" or an empty string as client_id .

Parameters:

	dvb_source_hostname	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	client_id	Client ID (MAC address) or "None" or ""

Returns:: 1

integer rpc_updateClientConfig	(	string	client_name,
		string	client_ip,
		string	client_mac
	)

Updates the configuration of an NMM client in Home Mode.

This method updates the configuration (client name and IP address) of the NMM client with the given client ID.

Parameters:

	client_name	New name of the client
	client_ip	New IP address of the client
	client_mac	Client ID (MAC address)

Returns:: 1

integer rpc_updateDVBConfig	(	string	dvb_source_hostname,
		integer	card_id,
		string	streaming_mode
	)

Sets the streaming mode of a DVB device.

Sets the streaming mode of the DVB device with the given card ID on the given system. The list of available streaming modes can be obtained by calling getStreamingModes().

Parameters:

	dvb_source_hostname	Host name of system where DVB device is installed
	card_id	Card ID of DVB device
	streaming_mode	Name of streaming mode to be set

Returns:: 1

TVCaster XML-RPC API

Classes

Functions

Detailed Description

Function Documentation