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.

Data Structures
class	python.libgpac.libgpac.RMTClient
	RMTClient object representing a websocket client will be passed as parameter on rmt_ws callbacks. More...
class	python.libgpac.libgpac.RMTHandler
	RMTHandler object handling the callbacks for rmtws events. More...

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.enable_rmtws (enable=True)
	enables websocket monitoring server
	python.libgpac.libgpac.enable_userws (enable=True)
	enables the user websocket server
	python.libgpac.libgpac.set_rmt_handler (callback_obj)
	set the handler for rmt_ws
	python.libgpac.libgpac.set_userws_handler (callback_obj)
	set the handler for the user websocket server
	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

Core tools for libgpac.

Function Documentation

e2s()

e2s

(

err

)

convert error value to string message

Parameters

err	gpac error code (int)

Returns

string

Here is the call graph for this function:

Here is the caller graph for this function:

init()

init	(		mem_track = 0,
			profile = None )

initialize libgpac - see gf_sys_init

Parameters

mem_track
profile

Returns

Here is the call graph for this function:

close()

close

(

)

close libgpac - see gf_sys_close

Note

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

Returns

Here is the call graph for this function:

set_logs()

set_logs	(		logs,
			reset = False )

set log tools and levels - see gf_log_set_tools_levels

Note

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

Parameters

logs
reset	if true, resets all logs to default

Returns

Here is the caller graph for this function:

sys_clock()

sys_clock

(

)

get clock - see gf_sys_clock

Returns

clock in milliseconds

sys_clock_high_res()

sys_clock_high_res

(

)

get high res clock - see gf_sys_clock_high_res

Returns

clock in microseconds

set_args()

set_args

(

args

)

set libgpac arguments - see gf_sys_set_args

Parameters

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

Returns

enable_rmtws()

enable_rmtws

(

enable = True

)

enables websocket monitoring server

Parameters

enable

True/False enable or disable server

enable_userws()

enable_userws

(

enable = True

)

enables the user websocket server

Parameters

enable

True/False enable or disable server

Here is the call graph for this function:

set_rmt_handler()

set_rmt_handler

(

callback_obj

)

set the handler for rmt_ws

Parameters

callback_obj

an object of type RMTHandler implementing the desired callbacks

set_userws_handler()

set_userws_handler

(

callback_obj

)

set the handler for the user websocket server

Parameters

callback_obj

an object of type RMTHandler implementing the desired callbacks

sleep()

sleep

(

value

)

sleep for given time in milliseconds

Parameters

value

time to sleep

Returns

Variable Documentation

numpy_support

bool numpy_support

set to True if numpy was successfully loaded

_libgpac

python.libgpac.libgpac._libgpac

protected

ctypes instance of libgpac

_libgpac_abi_mismatch

bool python.libgpac.libgpac._libgpac_abi_mismatch = False

protected

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.

version

python.libgpac.libgpac.version

libgpac version (string)

copyright

python.libgpac.libgpac.copyright

libgpac copyright notice (string)

copyright_cite

python.libgpac.libgpac.copyright_cite

libgpac full copyright notice (string)