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.
 

Functions

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

Variables

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

Detailed Description

Function Documentation

◆ e2s()

def libgpac.e2s (   err)
Parameters
errgpac error code (int)
Returns
string

◆ init()

def libgpac.init (   mem_track = 0,
  profile = None 
)
Parameters
mem_track
profile
Returns

◆ close()

def libgpac.close ( )
Note
Make sure you have destroyed all associated gpac resources before calling this !
Returns

◆ set_logs()

def libgpac.set_logs (   logs,
  reset = False 
)
Note
Make sure you have destroyed all associated gpac resources before calling this !
Parameters
logs
resetif true, resets all logs to default
Returns

◆ sys_clock()

def libgpac.sys_clock ( )
Returns
clock in milliseconds

◆ sys_clock_high_res()

def libgpac.sys_clock_high_res ( )
Returns
clock in microseconds

◆ set_args()

def libgpac.set_args (   args)
Parameters
argslist of strings, the first string is ignored (considered to be the executable name)
Returns

◆ set_rmt_fun()

def libgpac.set_rmt_fun (   callback_obj)
Parameters
callback_objobject 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_send()

def libgpac.rmt_send (   text)
Parameters
texttext to send
Returns
True if success, False if no Remotery support

◆ rmt_on()

def libgpac.rmt_on ( )
Returns
True if enabled, False otherwise

◆ rmt_enable()

def libgpac.rmt_enable (   value)
Parameters
valueenable or disable sampling
Returns

◆ sleep()

def libgpac.sleep (   value)
Parameters
valuetime to sleep
Returns