libgpac
Documentation of the core library of GPAC
libgpac core tools

Core tools for libgpac. More...

+ Collaboration diagram for libgpac core tools:

Modules

 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

def python.libgpac.libgpac.e2s (err)
 convert error value to string message More...
 
def python.libgpac.libgpac.init (mem_track=0, profile=None)
 initialize libgpac - see gf_sys_init More...
 
def python.libgpac.libgpac.close ()
 close libgpac - see gf_sys_close More...
 
def python.libgpac.libgpac.set_logs (logs, reset=False)
 set log tools and levels - see gf_log_set_tools_levels More...
 
def python.libgpac.libgpac.sys_clock ()
 get clock - see gf_sys_clock More...
 
def python.libgpac.libgpac.sys_clock_high_res ()
 get high res clock - see gf_sys_clock_high_res More...
 
def python.libgpac.libgpac.set_args (args)
 set libgpac arguments - see gf_sys_set_args More...
 
def python.libgpac.libgpac.enable_rmtws (enable=True)
 enables websocket monitoring server More...
 
def python.libgpac.libgpac.set_rmt_handler (callback_obj)
 set the handler for rmt_ws More...
 
def python.libgpac.libgpac.sleep (value)
 sleep for given time in milliseconds More...
 

Variables

bool python.libgpac.libgpac.numpy_support
 set to True if numpy was successfully loaded More...
 
 python.libgpac.libgpac._libgpac
 ctypes instance of libgpac More...
 
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. More...
 
 python.libgpac.libgpac.version
 libgpac version (string) More...
 
 python.libgpac.libgpac.copyright
 libgpac copyright notice (string) More...
 
 python.libgpac.libgpac.copyright_cite
 libgpac full copyright notice (string) More...
 

Detailed Description

Core tools for libgpac.

Function Documentation

◆ e2s()

def python.libgpac.libgpac.e2s (   err)

convert error value to string message

Parameters
errgpac error code (int)
Returns
string
+ Here is the caller graph for this function:

◆ init()

def python.libgpac.libgpac.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()

def python.libgpac.libgpac.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:
+ Here is the caller graph for this function:

◆ set_logs()

def python.libgpac.libgpac.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
resetif true, resets all logs to default
Returns
+ Here is the caller graph for this function:

◆ sys_clock()

def python.libgpac.libgpac.sys_clock ( )

get clock - see gf_sys_clock

Returns
clock in milliseconds

◆ sys_clock_high_res()

def python.libgpac.libgpac.sys_clock_high_res ( )

get high res clock - see gf_sys_clock_high_res

Returns
clock in microseconds

◆ set_args()

def python.libgpac.libgpac.set_args (   args)

set libgpac arguments - see gf_sys_set_args

Parameters
argslist of strings, the first string is ignored (considered to be the executable name)
Returns

◆ enable_rmtws()

def python.libgpac.libgpac.enable_rmtws (   enable = True)

enables websocket monitoring server

Parameters
valueTrue/False enable or disable server
+ Here is the call graph for this function:

◆ set_rmt_handler()

def python.libgpac.libgpac.set_rmt_handler (   callback_obj)

set the handler for rmt_ws

Parameters
callback_objan object of type RMTHandler implementing the desired callbacks

◆ sleep()

def python.libgpac.libgpac.sleep (   value)

sleep for given time in milliseconds

Parameters
valuetime to sleep
Returns

Variable Documentation

◆ numpy_support

bool python.libgpac.libgpac.numpy_support

set to True if numpy was successfully loaded

◆ _libgpac

python.libgpac.libgpac._libgpac
private

ctypes instance of libgpac

◆ _libgpac_abi_mismatch

bool python.libgpac.libgpac._libgpac_abi_mismatch = False
private

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)