![]() |
libgpac
Documentation of the core library of GPAC
|
Data Structures | |
| class | BufferOccupancy |
| Buffer occupancy object. More... | |
| class | DASHCustomAlgorithm |
DASH custom algo Upon successful binding to the dashin filter, the object will be assigned a list member called groups, containing the declared group for the active period. More... | |
| class | DASHGroup |
| DASH group object. More... | |
| class | DASHGroupDownloadStatistics |
| DASH group current segment download statistics object. More... | |
| class | DASHGroupStatistics |
| DASH groups statistics object. More... | |
| class | DASHQualityInfo |
| DASH media quality information (Representation info) More... | |
| class | DASHSRD |
| DASH Spatial Relation Descriptor object, used for tiling. More... | |
| class | EVT_base |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_Event only common events from GPAC video ouput are mapped More... | |
| class | EVT_char |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventChar More... | |
| class | EVT_keys |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventKey More... | |
| class | EVT_mouse |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventMouse More... | |
| class | EVT_mtouch |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventMultiTouch More... | |
| class | EVT_show |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventShow More... | |
| class | EVT_size |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventSize More... | |
| class | FEVT_AttachScene |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_AttachScene More... | |
| class | FEVT_Base |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_Base More... | |
| class | FEVT_BufferRequirement |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_BufferRequirement More... | |
| class | FEVT_EncodeHints |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_EncodeHints More... | |
| class | FEVT_FileDelete |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_FileDelete More... | |
| class | FEVT_FragmentSize |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_FragmentSize More... | |
| class | FEVT_NTPRef |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_NTPRef More... | |
| class | FEVT_Play |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_Play More... | |
| class | FEVT_QualitySwitch |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_QualitySwitch More... | |
| class | FEVT_SegmentSize |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_SegmentSize More... | |
| class | FEVT_SourceSeek |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_SourceSeek More... | |
| class | FEVT_UserEvent |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_Event More... | |
| class | FEVT_VisibilityHint |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_VisibilityHint More... | |
| class | FileIO |
| FileIO object for file IO callbacks from libgpac. More... | |
| class | Filter |
| filter object More... | |
| class | FilterArg |
| filter argument object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterArgs More... | |
| class | FilterCustom |
| Base class used to create custom filters in python. More... | |
| class | FilterEvent |
| event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterEvent More... | |
| class | FilterPacket |
| filter packet object More... | |
| class | FilterPid |
| Object representing a PID of a custom filter. More... | |
| class | FilterPidStatistics |
| filter pid statistics object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterPidStatistics More... | |
| class | FilterSession |
| filter session object - see GF_FilterSession More... | |
| class | FilterStats |
| filter statistics object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterStats More... | |
| class | FilterTask |
| Task object for user callbacks from libgpac scheduler. More... | |
| class | Fraction |
| fraction object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_Fraction More... | |
| class | Fraction64 |
| large fraction object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_Fraction64 More... | |
| class | GLTextureInfo |
| OpenGL texture info. More... | |
| class | HTTPOutRequest |
| HTTP request handler object. More... | |
| class | PropData |
| filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropData More... | |
| class | PropStringList |
| filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropStringList More... | |
| class | PropVec2 |
| filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec2 More... | |
| class | PropVec2i |
| filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec2i More... | |
| class | PropVec3i |
| filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec3i More... | |
| class | PropVec4i |
| filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec4i More... | |
| class | RMTClient |
| RMTClient object representing a websocket client will be passed as parameter on rmt_ws callbacks. More... | |
| class | RMTHandler |
| RMTHandler object handling the callbacks for rmtws events. More... | |
Functions | |
| e2s (err) | |
| convert error value to string message | |
| init (mem_track=0, profile=None) | |
| initialize libgpac - see gf_sys_init | |
| close () | |
| close libgpac - see gf_sys_close | |
| set_logs (logs, reset=False) | |
| set log tools and levels - see gf_log_set_tools_levels | |
| sys_clock () | |
| get clock - see gf_sys_clock | |
| sys_clock_high_res () | |
| get high res clock - see gf_sys_clock_high_res | |
| set_args (args) | |
| set libgpac arguments - see gf_sys_set_args | |
| enable_rmtws (enable=True) | |
| enables websocket monitoring server | |
| set_rmt_handler (callback_obj) | |
| set the handler for rmt_ws | |
| sleep (value) | |
| sleep for given time in milliseconds | |
Variables | |
| bool | numpy_support |
| set to True if numpy was successfully loaded | |
| _libgpac | |
| ctypes instance of libgpac | |
| bool | _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. | |
| version | |
| libgpac version (string) | |
| copyright | |
| libgpac copyright notice (string) | |
| copyright_cite | |
| libgpac full copyright notice (string) | |
| int | GF_FS_SCHEDULER_LOCK_FREE |
| see GF_FS_SCHEDULER_LOCK_FREE | |
| int | GF_FS_SCHEDULER_LOCK |
| see GF_FS_SCHEDULER_LOCK | |
| int | GF_FS_SCHEDULER_LOCK_FREE_X |
| see GF_FS_SCHEDULER_LOCK_FREE_X | |
| int | GF_FS_SCHEDULER_LOCK_FORCE |
| see GF_FS_SCHEDULER_LOCK_FORCE | |
| int | GF_FS_SCHEDULER_DIRECT |
| see GF_FS_SCHEDULER_DIRECT | |
| int | GF_FS_FLAG_LOAD_META |
| see GF_FS_FLAG_LOAD_META | |
| int | GF_FS_FLAG_NON_BLOCKING |
| see GF_FS_FLAG_NON_BLOCKING | |
| int | GF_FS_FLAG_NO_GRAPH_CACHE |
| see GF_FS_FLAG_NO_GRAPH_CACHE | |
| int | GF_FS_FLAG_NO_REGULATION |
| see GF_FS_FLAG_NO_REGULATION | |
| int | GF_FS_FLAG_NO_PROBE |
| see GF_FS_FLAG_NO_PROBE | |
| int | GF_FS_FLAG_NO_REASSIGN |
| see GF_FS_FLAG_NO_REASSIGN | |
| int | GF_FS_FLAG_PRINT_CONNECTIONS |
| see GF_FS_FLAG_PRINT_CONNECTIONS | |
| int | GF_FS_FLAG_NO_ARG_CHECK |
| see GF_FS_FLAG_NO_ARG_CHECK | |
| int | GF_FS_FLAG_NO_RESERVOIR |
| see GF_FS_FLAG_NO_RESERVOIR | |
| int | GF_FS_FLAG_FULL_LINK |
| see GF_FS_FLAG_FULL_LINK | |
| int | GF_FS_FLAG_NO_IMPLICIT |
| see GF_FS_FLAG_NO_IMPLICIT | |
| int | GF_FS_FLAG_REQUIRE_SOURCE_ID |
| see GF_FS_FLAG_REQUIRE_SOURCE_ID | |
| int | GF_FS_FLAG_FORCE_DEFER_LINK |
| see GF_FS_FLAG_FORCE_DEFER_LINK | |
| int | GF_FS_FLAG_PREVENT_PLAY |
| see GF_FS_FLAG_PREVENT_PLAY | |
| int | GF_PROP_FORBIDDEN |
| see GF_PROP_FORBIDDEN | |
| int | GF_PROP_SINT |
| see GF_PROP_SINT | |
| int | GF_PROP_UINT |
| see GF_PROP_UINT | |
| int | GF_PROP_LSINT |
| see GF_PROP_LSINT | |
| int | GF_PROP_LUINT |
| see GF_PROP_LUINT | |
| int | GF_PROP_BOOL |
| see GF_PROP_BOOL | |
| int | GF_PROP_FRACTION |
| see GF_PROP_FRACTION | |
| int | GF_PROP_FRACTION64 |
| see GF_PROP_FRACTION64 | |
| int | GF_PROP_FLOAT |
| see GF_PROP_FLOAT | |
| int | GF_PROP_DOUBLE |
| see GF_PROP_DOUBLE | |
| int | GF_PROP_VEC2I |
| see GF_PROP_VEC2I | |
| int | GF_PROP_VEC2 |
| see GF_PROP_VEC2 | |
| int | GF_PROP_VEC3I |
| see GF_PROP_VEC3I | |
| int | GF_PROP_VEC4I |
| see GF_PROP_VEC4I | |
| int | GF_PROP_STRING |
| see GF_PROP_STRING | |
| int | GF_PROP_STRING_NO_COPY |
| see GF_PROP_STRING_NO_COPY | |
| int | GF_PROP_DATA |
| see GF_PROP_DATA | |
| int | GF_PROP_NAME |
| see GF_PROP_NAME | |
| int | GF_PROP_DATA_NO_COPY |
| see GF_PROP_DATA_NO_COPY | |
| int | GF_PROP_CONST_DATA |
| see GF_PROP_CONST_DATA | |
| int | GF_PROP_POINTER |
| see GF_PROP_POINTER | |
| int | GF_PROP_STRING_LIST |
| see GF_PROP_STRING_LIST | |
| int | GF_PROP_UINT_LIST |
| see GF_PROP_UINT_LIST | |
| int | GF_PROP_SINT_LIST |
| see GF_PROP_SINT_LIST | |
| int | GF_PROP_VEC2I_LIST |
| see GF_PROP_VEC2I_LIST | |
| int | GF_PROP_4CC |
| see GF_PROP_4CC | |
| int | GF_PROP_4CC_LIST |
| see GF_PROP_4CC_LIST | |
| int | GF_PROP_FIRST_ENUM |
| see GF_PROP_FIRST_ENUM | |
| int | GF_PROP_PIXFMT |
| see GF_PROP_PIXFMT | |
| int | GF_PROP_PCMFMT |
| see GF_PROP_PCMFMT | |
| int | GF_PROP_CICP_COL_PRIM |
| see GF_PROP_CICP_COL_PRIM | |
| int | GF_PROP_CICP_COL_TFC |
| see GF_PROP_CICP_COL_TFC | |
| int | GF_PROP_CICP_COL_MX |
| see GF_PROP_CICP_COL_MX | |
| int | GF_PROP_CICP_LAYOUT |
| see GF_PROP_CICP_LAYOUT | |
| int | GF_FEVT_PLAY |
| see GF_FEVT_PLAY | |
| int | GF_FEVT_SET_SPEED |
| see GF_FEVT_SET_SPEED | |
| int | GF_FEVT_STOP |
| see GF_FEVT_STOP | |
| int | GF_FEVT_PAUSE |
| see GF_FEVT_PAUSE | |
| int | GF_FEVT_RESUME |
| see GF_FEVT_RESUME | |
| int | GF_FEVT_SOURCE_SEEK |
| see GF_FEVT_SOURCE_SEEK | |
| int | GF_FEVT_SOURCE_SWITCH |
| see GF_FEVT_SOURCE_SWITCH | |
| int | GF_FEVT_SEGMENT_SIZE |
| see GF_FEVT_SEGMENT_SIZE | |
| int | GF_FEVT_ATTACH_SCENE |
| see GF_FEVT_ATTACH_SCENE | |
| int | GF_FEVT_RESET_SCENE |
| see GF_FEVT_RESET_SCENE | |
| int | GF_FEVT_QUALITY_SWITCH |
| see GF_FEVT_QUALITY_SWITCH | |
| int | GF_FEVT_VISIBILITY_HINT |
| see GF_FEVT_VISIBILITY_HINT | |
| int | GF_FEVT_INFO_UPDATE |
| see GF_FEVT_INFO_UPDATE | |
| int | GF_FEVT_BUFFER_REQ |
| see GF_FEVT_BUFFER_REQ | |
| int | GF_FEVT_CAPS_CHANGE |
| see GF_FEVT_CAPS_CHANGE | |
| int | GF_FEVT_CONNECT_FAIL |
| see GF_FEVT_CONNECT_FAIL | |
| int | GF_FEVT_USER |
| see GF_FEVT_USER | |
| int | GF_FEVT_PLAY_HINT |
| see GF_FEVT_PLAY_HINT | |
| int | GF_FEVT_FILE_DELETE |
| see GF_FEVT_FILE_DELETE | |
| int | GF_FS_ARG_HINT_NORMAL |
| see GF_FS_ARG_HINT_NORMAL | |
| int | GF_FS_ARG_HINT_ADVANCED |
| see GF_FS_ARG_HINT_ADVANCED | |
| int | GF_FS_ARG_HINT_EXPERT |
| see GF_FS_ARG_HINT_EXPERT | |
| int | GF_FS_ARG_HINT_HIDE |
| see GF_FS_ARG_HINT_HIDE | |
| int | GF_FS_ARG_UPDATE |
| see GF_FS_ARG_UPDATE | |
| int | GF_FS_ARG_META |
| see GF_FS_ARG_META | |
| int | GF_FS_ARG_META_ALLOC |
| see GF_FS_ARG_META_ALLOC | |
| int | GF_FS_ARG_SINK_ALIAS |
| see GF_FS_ARG_SINK_ALIAS | |
| int | GF_CAPFLAG_IN_BUNDLE |
| see GF_CAPFLAG_IN_BUNDLE | |
| int | GF_CAPFLAG_INPUT |
| see GF_CAPFLAG_INPUT | |
| int | GF_CAPFLAG_OUTPUT |
| see GF_CAPFLAG_OUTPUT | |
| int | GF_CAPFLAG_EXCLUDED |
| see GF_CAPFLAG_EXCLUDED | |
| int | GF_CAPFLAG_LOADED_FILTER |
| see GF_CAPFLAG_LOADED_FILTER | |
| int | GF_CAPFLAG_STATIC |
| see GF_CAPFLAG_STATIC | |
| int | GF_CAPFLAG_OPTIONAL |
| see GF_CAPFLAG_OPTIONAL | |
| int | GF_CAPFLAG_PRESENT |
| see GF_CAPFLAG_PRESENT | |
| int | GF_CAPFLAG_RECONFIG |
| see GF_CAPFLAG_RECONFIG | |
| tuple | GF_CAPS_INPUT |
| see GF_CAPS_INPUT | |
| tuple | GF_CAPS_INPUT_OPT |
| see GF_CAPS_INPUT_OPT | |
| tuple | GF_CAPS_INPUT_STATIC |
| see GF_CAPS_INPUT_STATIC | |
| tuple | GF_CAPS_INPUT_STATIC_OPT |
| see GF_CAPS_INPUT_STATIC_OPT | |
| tuple | GF_CAPS_INPUT_EXCLUDED |
| see GF_CAPS_INPUT_EXCLUDED | |
| tuple | GF_CAPS_INPUT_LOADED_FILTER |
| see GF_CAPS_INPUT_LOADED_FILTER | |
| tuple | GF_CAPS_OUTPUT |
| see GF_CAPS_OUTPUT | |
| tuple | GF_CAPS_OUTPUT_LOADED_FILTER |
| see GF_CAPS_OUTPUT_LOADED_FILTER | |
| tuple | GF_CAPS_OUTPUT_EXCLUDED |
| see GF_CAPS_OUTPUT_EXCLUDED | |
| tuple | GF_CAPS_OUTPUT_STATIC |
| see GF_CAPS_OUTPUT_STATIC | |
| tuple | GF_CAPS_OUTPUT_STATIC_EXCLUDED |
| see GF_CAPS_OUTPUT_STATIC_EXCLUDED | |
| tuple | GF_CAPS_INPUT_OUTPUT |
| see GF_CAPS_INPUT_OUTPUT | |
| tuple | GF_CAPS_INPUT_OUTPUT_OPT |
| see GF_CAPS_INPUT_OUTPUT_OPT | |
| int | GF_STATS_LOCAL |
| see GF_STATS_LOCAL | |
| int | GF_STATS_LOCAL_INPUTS |
| see GF_STATS_LOCAL_INPUTS | |
| int | GF_STATS_DECODER_SINK |
| see GF_STATS_DECODER_SINK | |
| int | GF_STATS_DECODER_SOURCE |
| see GF_STATS_DECODER_SOURCE | |
| int | GF_STATS_ENCODER_SINK |
| see GF_STATS_ENCODER_SINK | |
| int | GF_STATS_ENCODER_SOURCE |
| see GF_STATS_ENCODER_SOURCE | |
| int | GF_STATS_SINK |
| see GF_STATS_SINK | |
| int | GF_SCRIPT_INFO |
| see GF_SCRIPT_INFO | |
| int | GF_PENDING_PACKET |
| see GF_PENDING_PACKET | |
| int | GF_EOS |
| see GF_EOS | |
| int | GF_OK |
| see GF_OK | |
| int | GF_BAD_PARAM |
| see GF_BAD_PARAM | |
| int | GF_OUT_OF_MEM |
| see GF_OUT_OF_MEM | |
| int | GF_IO_ERR |
| see GF_IO_ERR | |
| int | GF_NOT_SUPPORTED |
| see GF_NOT_SUPPORTED | |
| int | GF_CORRUPTED_DATA |
| see GF_CORRUPTED_DATA | |
| int | GF_SCRIPT_ERROR |
| see GF_SCRIPT_ERROR | |
| int | GF_BUFFER_TOO_SMALL |
| see GF_BUFFER_TOO_SMALL | |
| int | GF_NON_COMPLIANT_BITSTREAM |
| see GF_NON_COMPLIANT_BITSTREAM | |
| int | GF_FILTER_NOT_FOUND |
| see GF_FILTER_NOT_FOUND | |
| int | GF_URL_ERROR |
| see GF_URL_ERROR | |
| int | GF_SERVICE_ERROR |
| see GF_SERVICE_ERROR | |
| int | GF_REMOTE_SERVICE_ERROR |
| see GF_REMOTE_SERVICE_ERROR | |
| int | GF_STREAM_NOT_FOUND |
| see GF_STREAM_NOT_FOUND | |
| int | GF_URL_REMOVED |
| see GF_URL_REMOVED | |
| int | GF_IP_ADDRESS_NOT_FOUND |
| see GF_IP_ADDRESS_NOT_FOUND | |
| int | GF_IP_CONNECTION_FAILURE |
| see GF_IP_CONNECTION_FAILURE | |
| int | GF_IP_NETWORK_FAILURE |
| see GF_IP_NETWORK_FAILURE | |
| int | GF_IP_CONNECTION_CLOSED |
| see GF_IP_CONNECTION_CLOSED | |
| int | GF_IP_NETWORK_EMPTY |
| see GF_IP_NETWORK_EMPTY | |
| int | GF_IP_UDP_TIMEOUT |
| see GF_IP_UDP_TIMEOUT | |
| int | GF_AUTHENTICATION_FAILURE |
| see GF_AUTHENTICATION_FAILURE | |
| int | GF_NOT_READY |
| see GF_NOT_READY | |
| int | GF_INVALID_CONFIGURATION |
| see GF_INVALID_CONFIGURATION | |
| int | GF_NOT_FOUND |
| see GF_NOT_FOUND | |
| int | GF_PROFILE_NOT_SUPPORTED |
| see GF_PROFILE_NOT_SUPPORTED | |
| int | GF_REQUIRES_NEW_INSTANCE |
| see GF_REQUIRES_NEW_INSTANCE | |
| int | GF_FILTER_NOT_SUPPORTED |
| see GF_FILTER_NOT_SUPPORTED | |
| int | GF_SETUP_ERROR = 0 |
| notification is a setup error, the filter chain was never connected | |
| int | GF_NOTIF_ERROR = 1 |
| notification is an error but keep the filter chain connected | |
| int | GF_NOTIF_ERROR_AND_DISCONNECT = 2 |
| notification is an error and disconnect the filter chain | |
| int | GF_FS_FLUSH_NONE = 0, |
| Do not flush session: everything is discarded, potentially breaking output files. | |
| int | GF_FS_FLUSH_ALL = 1 |
| Flush all pending data before closing sessions: sources will be forced into end of stream and all emitted packets will be processed. | |
| int | GF_FS_FLUSH_FAST = 2 |
| Stop session (resetting buffers) and flush pipeline. | |