libgpac
Documentation of the core library of GPAC
JS FilterSession API

JavaScript API for FilterSession. More...

+ Collaboration diagram for JS FilterSession API:

Data Structures

interface  JSFilterSession
 JSFilterSession API. More...
 
interface  JSFSFilter
 JSFSFilter API. More...
 
interface  JSFSFilterArg
 

Functions

void print (DOMString log)
 
void print (long log_level, DOMString log_str)
 

Variables

attribute JSFilterSession session
 

Detailed Description

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

Errors are handled through exceptions.


Data Structure Documentation

◆ JSFSFilterArg

interface JSFSFilterArg

Object describing a filter argument

Data Fields
attribute DOMString name

name

attribute FilterProperty value

value

optional attribute DOMString desc

textual description

optional attribute DOMString min_max_enum

min/max/enum value or null

optional attribute DOMString default

default value or null

optional attribute boolean update

argument can be updated

optional attribute DOMString hint

indicate the UI level of the argument - string can be undefined, "advanced" or "expert"

Function Documentation

◆ print() [1/2]

void print ( DOMString  log)

global context function for printing

Parameters
logthe string to write

◆ print() [2/2]

void print ( long  log_level,
DOMString  log_str 
)

global context function for printing

Parameters
log_levelthe log level to use: GF_LOG_DEBUG, GF_LOG_INFO, GF_LOG_WARNING, GF_LOG_ERROR. The special value -2 means print as gf_sys_format_help without highlight, the special value -1 means print as gf_sys_format_help with hightlight of first)
log_strthe string to write

Variable Documentation

◆ session

attribute JSFilterSession session

global context property representing the one and only JSFilterSession object attached to the loaded script