![]() |
libgpac
Documentation of the core library of GPAC
|
Base class used to create custom filters in python.
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_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 | |
list | ipids = [] |
List of input FilterPid. | |
list | opids = [] |
List of output FilterPid. | |
int | block_enabled |
filter blocking is enabled, readonly - see gf_filter_block_enabled | |
int | output_buffer |
maximum output buffer time, readonly - see gf_filter_get_output_buffer_max | |
int | playout_buffer |
maximum plyaout buffer time, readonly - see gf_filter_get_output_buffer_max | |
int | sinks_done |
all sinks are done for this filter, readonly - see gf_filter_all_sinks_done | |
int | nb_evts_queued |
number of queued events on the filter, readonly - see gf_filter_get_num_events_queued | |
int | clock_hint_time |
clock hint value in microseconds, readonly - see gf_filter_get_clock_hint | |
int | clock_hint_mediatime |
clock hint media time as Fraction64, readonly - see gf_filter_get_clock_hint | |
int | connections_pending |
boolean indicating connections are pending on the filter, readonly - see gf_filter_connections_pending |
Additional Inherited Members | |
Static Public Attributes inherited from python.libgpac.libgpac.Filter | |
str | 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 | |
Protected Attributes inherited from python.libgpac.libgpac.Filter | |
_filter |
python.libgpac.libgpac.FilterCustom.__init__ | ( | self, | |
session, | |||
fname = "Custom", | |||
flags = 0 ) |
session | FilterSession object |
fname | name of the filter |
flags | flags for the filter |
python.libgpac.libgpac.FilterCustom.push_cap | ( | self, | |
pcode, | |||
prop, | |||
flag, | |||
priority = 0, | |||
custom_type = 0 ) |
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 |
python.libgpac.libgpac.FilterCustom.new_pid | ( | self | ) |
python.libgpac.libgpac.FilterCustom.update_status | ( | self, | |
status, | |||
percent ) |
status | status string |
percent | progress in per 10000, int |
python.libgpac.libgpac.FilterCustom.reschedule | ( | self, | |
when = 0 ) |
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 |
python.libgpac.libgpac.FilterCustom.notify_failure | ( | self, | |
err, | |||
error_type = GF_SETUP_ERROR ) |
err | the failure reason (gpac error code, int) |
error_type | the failure notification type |
python.libgpac.libgpac.FilterCustom.make_sticky | ( | self | ) |
python.libgpac.libgpac.FilterCustom.prevent_blocking | ( | self, | |
enable ) |
enable | if True, blocking prevention is enabled |
python.libgpac.libgpac.FilterCustom.block_eos | ( | self, | |
enable ) |
enable | if True, eos blocking is enabled |
python.libgpac.libgpac.FilterCustom.set_max_pids | ( | self, | |
max_pids ) |
max_pids | number of extra pids |
python.libgpac.libgpac.FilterCustom.hint_clock | ( | self, | |
clock_us, | |||
media_time ) |
clock_us | clock in microseconds |
media_time | media time as Fraction64 |