libgpac core tools

Core tools for libgpac. More...

Collaboration diagram for libgpac core tools:

Topics
	Structure Wrappers
	Python Structures.
	libgpac core tools
	FileIO tools for libgpac.

Functions
	python.libgpac.libgpac.e2s (err)
	convert error value to string message
	python.libgpac.libgpac.init (mem_track=0, profile=None)
	initialize libgpac - see gf_sys_init
	python.libgpac.libgpac.close ()
	close libgpac - see gf_sys_close
	python.libgpac.libgpac.set_logs (logs, reset=False)
	set log tools and levels - see gf_log_set_tools_levels
	python.libgpac.libgpac.sys_clock ()
	get clock - see gf_sys_clock
	python.libgpac.libgpac.sys_clock_high_res ()
	get high res clock - see gf_sys_clock_high_res
	python.libgpac.libgpac.set_args (args)
	set libgpac arguments - see gf_sys_set_args
	python.libgpac.libgpac.set_rmt_fun (callback_obj)
	set profiler (Remotery) callback - see gf_sys_profiler_set_callback
	python.libgpac.libgpac.rmt_log (text)
	send message to profiler (Remotery) - see gf_sys_profiler_log
	python.libgpac.libgpac.rmt_send (text)
	send message to profiler (Remotery) - see gf_sys_profiler_send
	python.libgpac.libgpac.rmt_on ()
	check if profiler (Remotery) sampling is enabled - see gf_sys_profiler_sampling_enabled
	python.libgpac.libgpac.rmt_enable (value)
	enable or disable sampling in profiler (Remotery) - see gf_sys_profiler_enable_sampling
	python.libgpac.libgpac.sleep (value)
	sleep for given time in milliseconds

Variables
bool	python.libgpac.libgpac.numpy_support
	set to True if numpy was successfully loaded
	python.libgpac.libgpac._libgpac
	ctypes instance of libgpac
bool	python.libgpac.libgpac._libgpac_abi_mismatch = False
	Set to true if mismatch was detected between the ABI version the Python wrapper was designed and the libgpac shared library ABI version A warning is thrown if mismatched, but it is left up to the pythin script to decide whether it still wants to use libgpac wrapper.
	python.libgpac.libgpac.version
	libgpac version (string)
	python.libgpac.libgpac.copyright
	libgpac copyright notice (string)
	python.libgpac.libgpac.copyright_cite
	libgpac full copyright notice (string)

Detailed Description

Function Documentation

e2s()

e2s

(

err

)

Parameters

err	gpac error code (int)

Returns

string

Here is the caller graph for this function:

init()

init	(		mem_track = 0,
			profile = None )

Parameters

mem_track
profile

Returns

close()

close

(

)

Note

Make sure you have destroyed all associated gpac resources before calling this !

Returns

set_logs()

set_logs	(		logs,
			reset = False )

Note

Make sure you have destroyed all associated gpac resources before calling this !

Parameters

logs
reset	if true, resets all logs to default

Returns

sys_clock()

sys_clock

(

)

Returns

clock in milliseconds

sys_clock_high_res()

sys_clock_high_res

(

)

Returns

clock in microseconds

set_args()

set_args

(

args

)

Parameters

args	list of strings, the first string is ignored (considered to be the executable name)

Returns

set_rmt_fun()

set_rmt_fun

(

callback_obj

)

Parameters

callback_obj

object to call back, must have a method on_rmt_event taking a single string parameter

Returns

True if success, False if no Remotery support

rmt_log()

rmt_log

(

text

)

Parameters

text	text to send

Returns

True if success, False if no Remotery support

rmt_send()

rmt_send

(

text

)

Parameters

text	text to send

Returns

True if success, False if no Remotery support

rmt_on()

rmt_on

(

)

Returns

True if enabled, False otherwise

rmt_enable()

rmt_enable

(

value

)

Parameters

value

enable or disable sampling

Returns

sleep()

sleep

(

value

)

Parameters

value

time to sleep

Returns