libgpac
Documentation of the core library of GPAC
Loading...
Searching...
No Matches
python.libgpac.libgpac.Filter Class Reference

filter object

+ 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
 
 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
 
 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
 

Protected Attributes

 _filter
 

Member Function Documentation

◆ remove()

python.libgpac.libgpac.Filter.remove ( self)
Returns

◆ update()

python.libgpac.libgpac.Filter.update ( self,
name,
value,
propagate_mask = 0 )
Parameters
namename of option (string)
valuevalue of option (string)
propagate_maskflags 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 )
Note
Setting a source will force the filter session linker to run in explicit linking mode.
Parameters
fsource Filter
link_argslink options (string)
Returns

◆ set_source_restricted()

python.libgpac.libgpac.Filter.set_source_restricted ( self,
f,
link_args = None )
Parameters
fsource Filter
link_argslink options (string)
Returns

◆ insert()

python.libgpac.libgpac.Filter.insert ( self,
f,
opid = -1,
link_args = None )
Parameters
fFilter to insert
opidindex of output pid to reconnect, -1 for all pids
link_argslink options (string)
Returns
+ Here is the call graph for this function:

◆ ipid_prop()

python.libgpac.libgpac.Filter.ipid_prop ( self,
idx,
prop_name )
Parameters
idxindex of input pid
prop_namename of property
Returns
property value or None if not found

◆ ipid_enum_props()

python.libgpac.libgpac.Filter.ipid_enum_props ( self,
idx,
callback_obj )
Parameters
idxindex of input pid
callback_objcallback 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 )
Parameters
idxindex of output pid
prop_namename of property
Returns
property value or None if not found

◆ opid_enum_props()

python.libgpac.libgpac.Filter.opid_enum_props ( self,
idx,
callback_obj )
Parameters
idxindex of output pid
callback_objcallback 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 )
Parameters
idxindex of input pid
modesearch 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 )
Parameters
idxindex of output pid
modesearch 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 )
Parameters
idxindex of input PID
Returns
Filter or None if error

◆ opid_sinks()

python.libgpac.libgpac.Filter.opid_sinks ( self,
idx )
Parameters
idxindex of output PID
Returns
list of Filter

◆ all_args()

python.libgpac.libgpac.Filter.all_args ( self)
Returns
list of FilterArg

◆ get_info()

python.libgpac.libgpac.Filter.get_info ( self,
prop_name )
Parameters
prop_nameproperty to query
Returns
property value or None if not found

◆ get_statistics()

python.libgpac.libgpac.Filter.get_statistics ( self)
Returns
FilterStats object
+ Here is the call graph for this function:

◆ require_source_id()

python.libgpac.libgpac.Filter.require_source_id ( self)
Returns
+ Here is the call graph for this function:

◆ bind()

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

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
objectobject to bind
Returns