GPAC module exports

Exported symbols for GPAC NodeJS. More...

Data Structures
interface	_RMTClient

Functions
void	init (unsigned long mem_track=0, DOMString profile=null)
DOMString	e2s (long err)
void	set_logs (DOMString logs, boolean reset=false)
unsigned long	sys_clock ()
unsigned long long	sys_clock_high_res ()
void	set_args (Array args)
void	enable_rmtws (boolean enable)
void	enable_userws (bool enable)
boolean	on_event (_FilterEvent evt)

Variables
optional attribute function	rmt_on_new_client
optional attribute function	userws_on_new_client
attribute readonly DOMString	version
attribute readonly DOMString	copyright
attribute readonly DOMString	copyright_cite
attribute readonly unsigned long	abi_major
attribute readonly unsigned long	abi_minor
attribute readonly unsigned long	abi_micro
attribute _FilterSession	FilterSession
attribute _FilterEvent	FilterEvent
attribute _FileIO	FileIO

Detailed Description

Exported symbols for GPAC NodeJS.

This section documents the JavaScript API used to query the filter session.

Unless explictly stated, errors are handled through exceptions.

All constants from GPAC are exported in the module object (e.g. use gpac.GF_Err ...)

The API is very close to the GPAC python bindings.

Function Documentation

init()

void init	(	unsigned long	mem_track = 0,
		DOMString	profile = null )

initialize libgpac - see gf_sys_init

When loading the module, libgpac is innitialized with no memory tracking and the default profile. Use this function only if you need to change these settings. This must be called before any other calls to gpac.

Parameters

mem_track	mem tracker mode
profile	profile name, null for default

e2s()

DOMString e2s

(

long

err

)

convert error value to string message

Parameters

err	gpac error code (int)

Returns

string

set_logs()

void set_logs	(	DOMString	logs,
		boolean	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

sys_clock()

unsigned long sys_clock

(

)

get clock - see gf_sys_clock

Returns

clock in milliseconds

sys_clock_high_res()

unsigned long long sys_clock_high_res

(

)

get high res clock - see gf_sys_clock_high_res

Returns

clock in microseconds

set_args()

void set_args

(

Array

args

)

set libgpac arguments - see gf_sys_set_args

Parameters

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

enable_rmtws()

void enable_rmtws

(

boolean

enable

)

enables websocket monitoring server - see gf_sys_enable_rmtws

define the rmt_on_new_client attribute to set callbacks

Parameters

enable

enable or disable server

enable_userws()

void enable_userws

(

bool

enable

)

enables user websocket server - see gf_sys_enable_userws

define the userws_on_new_client attribute to set callbacks

Parameters

enable

(default: true) will enable the server if true, stop it if false

on_event()

boolean on_event

(

_FilterEvent

evt

)

GPAC event proc callback, initially set to null

Parameters

evt	the user event being dispatched

Returns

true to cancel the event

Variable Documentation

rmt_on_new_client

optional attribute function rmt_on_new_client

set the callback function when new clients connect to the monitoring websocket server the function shall take one parameter of type _RMTClient

userws_on_new_client

optional attribute function userws_on_new_client

set the callback function when new clients connect to the user websocket server the function shall take one parameter of type _RMTClient

version

attribute readonly DOMString version

libgpac version

copyright

attribute readonly DOMString copyright

libgpac copyright notice

copyright_cite

attribute readonly DOMString copyright_cite

libgpac full copyright notice

abi_major

attribute readonly unsigned long abi_major

libgpac major ABI - see gf_gpac_abi_major

abi_minor

attribute readonly unsigned long abi_minor

libgpac minor ABI - see gf_gpac_abi_minor

abi_micro

attribute readonly unsigned long abi_micro

libgpac micro ABI - see gf_gpac_abi_micro

FilterSession

attribute _FilterSession FilterSession

filter session constructor

FilterEvent

attribute _FilterEvent FilterEvent

filter session constructor

FileIO

attribute _FileIO FileIO

FileIO constructor