python.libgpac.libgpac.FilterCustom Class Reference

Base class used to create custom filters in python. More...

Inheritance diagram for python.libgpac.libgpac.FilterCustom:

Collaboration diagram for python.libgpac.libgpac.FilterCustom:

Public Member Functions
	__init__ (self, session, fname="Custom", flags=0)
	constructor, see gf_fs_new_filter
	push_cap (self, pcode, prop, flag, priority=0, custom_type=0)
	push a capability in the current capability bundle - see gf_filter_push_caps
	new_pid (self)
	create a new output pid for this filter - see gf_filter_pid_new
	update_status (self, status, percent)
	update filter status - see gf_filter_update_status
	reschedule (self, when=0)
	reschedule the filter after a given delay - see gf_filter_ask_rt_reschedule and gf_filter_post_process_task
	notify_failure (self, err, error_type=GF_SETUP_ERROR)
	notify an internal failure of the filter has happend - see gf_filter_notification_failure and gf_filter_setup_failure
	make_sticky (self)
	make the filter sticky - see gf_filter_make_sticky
	prevent_blocking (self, enable)
	prevent blocking on the filter - see gf_filter_prevent_blocking
	block_eos (self, enable)
	block eos signaling on the filter - see gf_filter_block_eos
	set_max_pids (self, max_pids)
	set maximum number of extra pids accepted by this filter - see gf_filter_set_max_extra_input_pids
	hint_clock (self, clock_us, media_time)
	set clock hint - see gf_filter_hint_single_clock
Public Member Functions inherited from python.libgpac.libgpac.Filter
	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

Data Fields
	ipids
	List of input FilterPid.
	opids
	List of output FilterPid.
	block_enabled
	filter blocking is enabled, readonly - see gf_filter_block_enabled
	output_buffer
	maximum output buffer time, readonly - see gf_filter_get_output_buffer_max
	playout_buffer
	maximum plyaout buffer time, readonly - see gf_filter_get_output_buffer_max
	sinks_done
	all sinks are done for this filter, readonly - see gf_filter_all_sinks_done
	nb_evts_queued
	number of queued events on the filter, readonly - see gf_filter_get_num_events_queued
	clock_hint_time
	clock hint value in microseconds, readonly - see gf_filter_get_clock_hint
	clock_hint_mediatime
	clock hint media time as Fraction64, readonly - see gf_filter_get_clock_hint
	connections_pending
	boolean indicating connections are pending on the filter, readonly - see gf_filter_connections_pending

Protected Attributes
	_filter
Protected Attributes inherited from python.libgpac.libgpac.Filter
	_filter

Additional Inherited Members
Static Public Attributes inherited from python.libgpac.libgpac.Filter
	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

Detailed Description

Base class used to create custom filters in python.

Constructor & Destructor Documentation

__init__()

python.libgpac.libgpac.FilterCustom.__init__	(		self,
			session,
			fname = "Custom",
			flags = 0
	)

constructor, see gf_fs_new_filter

Parameters

session	FilterSession object
fname	name of the filter
flags	flags for the filter

Here is the call graph for this function:

Member Function Documentation

push_cap()

python.libgpac.libgpac.FilterCustom.push_cap	(		self,
			pcode,
			prop,
			flag,
			priority = 0,
			custom_type = 0
	)

push a capability in the current capability bundle - see gf_filter_push_caps

Parameters

pcode	capability name (property type)
prop	capability value
flag	capability flags (input, output, etc)
priority	capability priority
custom_type	type of property if user-defined property. If not set and user-defined, property is a string

Returns

Here is the call graph for this function:

new_pid()

python.libgpac.libgpac.FilterCustom.new_pid

(

self

)

create a new output pid for this filter - see gf_filter_pid_new

Returns

FilterPid object

update_status()

python.libgpac.libgpac.FilterCustom.update_status	(		self,
			status,
			percent
	)

update filter status - see gf_filter_update_status

Parameters

status	status string
percent	progress in per 10000, int

Returns

reschedule()

python.libgpac.libgpac.FilterCustom.reschedule	(		self,
			when = 0
	)

reschedule the filter after a given delay - see gf_filter_ask_rt_reschedule and gf_filter_post_process_task

Parameters

when	delay in microseconds, negative value will just post a process task. A value of 0 will mark filter as active even if no packet was dropped/sent

Returns

notify_failure()

python.libgpac.libgpac.FilterCustom.notify_failure	(		self,
			err,
			error_type = GF_SETUP_ERROR
	)

notify an internal failure of the filter has happend - see gf_filter_notification_failure and gf_filter_setup_failure

Parameters

err	the failure reason (gpac error code, int)
error_type	the failure notification type

Returns

make_sticky()

python.libgpac.libgpac.FilterCustom.make_sticky

(

self

)

make the filter sticky - see gf_filter_make_sticky

Returns

prevent_blocking()

python.libgpac.libgpac.FilterCustom.prevent_blocking	(		self,
			enable
	)

prevent blocking on the filter - see gf_filter_prevent_blocking

Parameters

enable

if True, blocking prevention is enabled

Returns

block_eos()

python.libgpac.libgpac.FilterCustom.block_eos	(		self,
			enable
	)

block eos signaling on the filter - see gf_filter_block_eos

Parameters

enable

if True, eos blocking is enabled

Returns

set_max_pids()

python.libgpac.libgpac.FilterCustom.set_max_pids	(		self,
			max_pids
	)

set maximum number of extra pids accepted by this filter - see gf_filter_set_max_extra_input_pids

Parameters

max_pids

number of extra pids

Returns

hint_clock()

python.libgpac.libgpac.FilterCustom.hint_clock	(		self,
			clock_us,
			media_time
	)

set clock hint - see gf_filter_hint_single_clock

Parameters

clock_us	clock in microseconds
media_time	media time as Fraction64

Returns

Field Documentation

_filter

python.libgpac.libgpac.FilterCustom._filter

protected

ipids

python.libgpac.libgpac.FilterCustom.ipids

List of input FilterPid.

opids

python.libgpac.libgpac.FilterCustom.opids

List of output FilterPid.

block_enabled

python.libgpac.libgpac.FilterCustom.block_enabled

filter blocking is enabled, readonly - see gf_filter_block_enabled

output_buffer

python.libgpac.libgpac.FilterCustom.output_buffer

maximum output buffer time, readonly - see gf_filter_get_output_buffer_max

playout_buffer

python.libgpac.libgpac.FilterCustom.playout_buffer

maximum plyaout buffer time, readonly - see gf_filter_get_output_buffer_max

sinks_done

python.libgpac.libgpac.FilterCustom.sinks_done

all sinks are done for this filter, readonly - see gf_filter_all_sinks_done

nb_evts_queued

python.libgpac.libgpac.FilterCustom.nb_evts_queued

number of queued events on the filter, readonly - see gf_filter_get_num_events_queued

clock_hint_time

python.libgpac.libgpac.FilterCustom.clock_hint_time

clock hint value in microseconds, readonly - see gf_filter_get_clock_hint

clock_hint_mediatime

python.libgpac.libgpac.FilterCustom.clock_hint_mediatime

clock hint media time as Fraction64, readonly - see gf_filter_get_clock_hint

connections_pending

python.libgpac.libgpac.FilterCustom.connections_pending

boolean indicating connections are pending on the filter, readonly - see gf_filter_connections_pending