python.libgpac.libgpac.Filter Class Reference

filter object More...

Inheritance diagram for python.libgpac.libgpac.Filter:

Public Member Functions
	remove (self)
	remove this filter - see gf_filter_remove
	update (self, name, value, propagate_mask=0)
	send option update to this filter - see gf_fs_send_update
	set_source (self, f, link_args=None)
	set a given filter as source for this filter - see gf_filter_set_source
	set_source_restricted (self, f, link_args=None)
	set a given filter as restricted source for this filter - see gf_filter_set_source_restricted
	insert (self, f, opid=-1, link_args=None)
	insert a given filter after this filter - see gf_filter_set_source and gf_filter_reconnect_output
	reconnect (self, opid=-1)
	reconnect the filter output - see gf_filter_set_source and gf_filter_reconnect_output
	ipid_prop (self, idx, prop_name)
	get an input pid property by name
	ipid_enum_props (self, idx, callback_obj)
	enumerate an input pid properties
	opid_prop (self, idx, prop_name)
	get an output pid property by name
	opid_enum_props (self, idx, callback_obj)
	enumerate an output pid properties
	ipid_stats (self, idx, mode=0)
	Gets the statistics of an input pid of filter - see gf_filter_pid_get_statistics.
	opid_stats (self, idx, mode=0)
	Gets the statistics of an output pid of filter - see gf_filter_pid_get_statistics.
	ipid_source (self, idx)
	gets the filter at the source of an input pid
	opid_sinks (self, idx)
	gets the list of destination filters of an output pid
	all_args (self)
	gets all defined options / arguments for a filter
	get_arg_value (self, arg_name)
	gets the current value of an argument of the filter - see gf_filter_get_arg
	all_args_value (self)
	gets all arguments of filter with type, description, and value as a python dict
	get_info (self, prop_name)
	gets a property info on a filter - see gf_filter_get_info and gf_filter_get_info_str
	get_statistics (self)
	Gets the statistics of a filter - see gf_filter_get_stats.
	require_source_id (self)
	enforces sourceID to be present for output pids of this filter - see gf_filter_require_source_id
	probe_link (self, opid_idx, name)
	Resolves link from given output pid of filter to a filter description.
	get_destinations (self, opid_idx)
	Gets all possible destination filter for this filter or one of its output PID - see gf_filter_get_possible_destinations.
	bind (self, object)
	binds a given object to the filter

Static Public Attributes
	name
	name of the filter, readonly - see gf_filter_get_name
	ID
	ID of the filter, readonly - see gf_filter_get_id.
	nb_ipid
	number of input pids for that filter, readonly - see gf_filter_get_ipid_count
	nb_opid
	number of output pids for that filter, readonly - see gf_filter_get_opid_count
	status
	status string for some filters, readonly - see gf_filter_get_status
	bytes_done
	bytes processed, readonly - see gf_filter_get_bytes_done

Protected Attributes
	_filter

Detailed Description

filter object

Member Function Documentation

remove()

python.libgpac.libgpac.Filter.remove

(

self

)

remove this filter - see gf_filter_remove

Returns

update()

python.libgpac.libgpac.Filter.update	(		self,
			name,
			value,
			propagate_mask = 0
	)

send option update to this filter - see gf_fs_send_update

Parameters

name	name of option (string)
value	value of option (string)
propagate_mask	flags indicating if updates must be send to up-chain filters (2), down-chain filters (1), both (3) or only on filter (0)

Returns

set_source()

python.libgpac.libgpac.Filter.set_source	(		self,
			f,
			link_args = None
	)

set a given filter as source for this filter - see gf_filter_set_source

Note

Setting a source will force the filter session linker to run in explicit linking mode.

Parameters

f	source Filter
link_args	link options (string)

Returns

set_source_restricted()

python.libgpac.libgpac.Filter.set_source_restricted	(		self,
			f,
			link_args = None
	)

set a given filter as restricted source for this filter - see gf_filter_set_source_restricted

Parameters

f	source Filter
link_args	link options (string)

Returns

insert()

python.libgpac.libgpac.Filter.insert	(		self,
			f,
			opid = -1,
			link_args = None
	)

insert a given filter after this filter - see gf_filter_set_source and gf_filter_reconnect_output

Parameters

f	Filter to insert
opid	index of output pid to reconnect, -1 for all pids
link_args	link options (string)

Returns

Here is the call graph for this function:

reconnect()

python.libgpac.libgpac.Filter.reconnect	(		self,
			opid = -1
	)

reconnect the filter output - see gf_filter_set_source and gf_filter_reconnect_output

Parameters

opid	index of output pid to reconnect, -1 for all pids

Returns

Here is the call graph for this function:

ipid_prop()

python.libgpac.libgpac.Filter.ipid_prop	(		self,
			idx,
			prop_name
	)

get an input pid property by name

Parameters

idx	index of input pid
prop_name	name of property

Returns

property value or None if not found

ipid_enum_props()

python.libgpac.libgpac.Filter.ipid_enum_props	(		self,
			idx,
			callback_obj
	)

enumerate an input pid properties

Parameters

idx	index of input pid
callback_obj	callback object to use, must have a 'on_prop_enum' method defined taking two parameters, prop_name(string) and propval(property value)

Returns

opid_prop()

python.libgpac.libgpac.Filter.opid_prop	(		self,
			idx,
			prop_name
	)

get an output pid property by name

Parameters

idx	index of output pid
prop_name	name of property

Returns

property value or None if not found

opid_enum_props()

python.libgpac.libgpac.Filter.opid_enum_props	(		self,
			idx,
			callback_obj
	)

enumerate an output pid properties

Parameters

idx	index of output pid
callback_obj	callback object to use, must have a 'on_prop_enum' method defined taking two parameters, prop_name(string) and propval(property value)

Returns

ipid_stats()

python.libgpac.libgpac.Filter.ipid_stats	(		self,
			idx,
			mode = 0
	)

Gets the statistics of an input pid of filter - see gf_filter_pid_get_statistics.

Parameters

idx	index of input pid
mode	search mode for stats cf GF_FilterPidStatsLocation

Returns

FilterPidStatistics object

Here is the call graph for this function:

opid_stats()

python.libgpac.libgpac.Filter.opid_stats	(		self,
			idx,
			mode = 0
	)

Gets the statistics of an output pid of filter - see gf_filter_pid_get_statistics.

Parameters

idx	index of output pid
mode	search mode for stats cf GF_FilterPidStatsLocation

Returns

FilterPidStatistics object

Here is the call graph for this function:

ipid_source()

python.libgpac.libgpac.Filter.ipid_source	(		self,
			idx
	)

gets the filter at the source of an input pid

Parameters

idx	index of input PID

Returns

Filter or None if error

opid_sinks()

python.libgpac.libgpac.Filter.opid_sinks	(		self,
			idx
	)

gets the list of destination filters of an output pid

Parameters

idx	index of output PID

Returns

list of Filter

all_args()

python.libgpac.libgpac.Filter.all_args

(

self

)

gets all defined options / arguments for a filter

Returns

list of FilterArg

Here is the caller graph for this function:

get_arg_value()

python.libgpac.libgpac.Filter.get_arg_value	(		self,
			arg_name
	)

gets the current value of an argument of the filter - see gf_filter_get_arg

Parameters

arg_name

name of argument (as python str)

Returns

argument value or None if not found

Here is the caller graph for this function:

all_args_value()

python.libgpac.libgpac.Filter.all_args_value

(

self

)

gets all arguments of filter with type, description, and value as a python dict

Returns

array of dictionnary structure containing arguments details

Here is the call graph for this function:

get_info()

python.libgpac.libgpac.Filter.get_info	(		self,
			prop_name
	)

gets a property info on a filter - see gf_filter_get_info and gf_filter_get_info_str

Parameters

prop_name

property to query

Returns

property value or None if not found

get_statistics()

python.libgpac.libgpac.Filter.get_statistics

(

self

)

Gets the statistics of a filter - see gf_filter_get_stats.

Returns

FilterStats object

Here is the call graph for this function:

require_source_id()

python.libgpac.libgpac.Filter.require_source_id

(

self

)

enforces sourceID to be present for output pids of this filter - see gf_filter_require_source_id

Returns

probe_link()

python.libgpac.libgpac.Filter.probe_link	(		self,
			opid_idx,
			name
	)

Resolves link from given output pid of filter to a filter description.

The described filter is not loaded in the graph - see gf_filter_probe_link

Parameters

opid_idx	0-based index of the output pid
name	filter description to link to - this can be any filter description

Returns

None if no possible link or a list containing the filters in the resolved chain from current filter to destination

get_destinations()

python.libgpac.libgpac.Filter.get_destinations	(		self,
			opid_idx
	)

Gets all possible destination filter for this filter or one of its output PID - see gf_filter_get_possible_destinations.

Parameters

opid_idx

0-based index of the output pid, use -1 to check all output pids

Returns

None if no possible connections to known filter, or a list containing all possible direct connections

Here is the call graph for this function:

bind()

python.libgpac.libgpac.Filter.bind	(		self,
			object
	)

binds a given object to the filter

Binds the given object to the underlying filter for callbacks override - only supported by DASH demuxer for the current time

For DASH, the object must derive from or implement the methods of the DASHCustomAlgorithm class:

Parameters

object

object to bind

Returns

Here is the call graph for this function:

Field Documentation

name

python.libgpac.libgpac.Filter.name

static

name of the filter, readonly - see gf_filter_get_name

ID

python.libgpac.libgpac.Filter.ID

static

ID of the filter, readonly - see gf_filter_get_id.

nb_ipid

python.libgpac.libgpac.Filter.nb_ipid

static

number of input pids for that filter, readonly - see gf_filter_get_ipid_count

nb_opid

python.libgpac.libgpac.Filter.nb_opid

static

number of output pids for that filter, readonly - see gf_filter_get_opid_count

status

python.libgpac.libgpac.Filter.status

static

status string for some filters, readonly - see gf_filter_get_status

bytes_done

python.libgpac.libgpac.Filter.bytes_done

static

bytes processed, readonly - see gf_filter_get_bytes_done

_filter

python.libgpac.libgpac.Filter._filter

protected