 |
libgpac
Documentation of the core library of GPAC
|
|
libgpac
Documentation of the core library of GPAC
|
Event system used by GPAC playback. More...
Collaboration diagram for Event System:Data Structures | |
| struct | GF_EventMouse |
| struct | GF_EventMultiTouch |
| struct | GF_EventKey |
| struct | GF_EventChar |
| struct | GF_EventSize |
| struct | GF_EventVideoSetup |
| struct | GF_EventShow |
| struct | GF_EventCursor |
| struct | GF_EventCaption |
| struct | GF_EventMove |
| struct | GF_EventDuration |
| struct | GF_EventNavigate |
| struct | GF_EventProgress |
| struct | GF_EventConnect |
| struct | GF_EventAddonConnect |
| struct | GF_EventAuthorize |
| struct | GF_EventSysColors |
| struct | GF_EventMutation |
| struct | GF_EventOpenFile |
| struct | GF_EventOrientationSensor |
| struct | GF_EventGPS |
| struct | GF_EventSensorRequest |
| struct | GF_EventClipboard |
| union | GF_Event |
| union | GF_EventProgress.__unnamed36__ |
This section documents the event structures used by thethe compositor, input modules and output rendering modules for communication.
| struct GF_EventMouse |
| struct GF_EventMultiTouch |
| struct GF_EventKey |
| struct GF_EventChar |
| struct GF_EventSize |
Window resize event event proc return value: ignored
| Data Fields | ||
|---|---|---|
| u8 | type | |
| u32 | width | |
| u32 | height | |
| GF_DisplayOrientationType | orientation | |
| u32 | window_id | |
| struct GF_EventVideoSetup |
| struct GF_EventShow |
| struct GF_EventCursor |
| struct GF_EventCaption |
Window caption event event proc return value: ignored
| Data Fields | ||
|---|---|---|
| u8 | type | |
| const char * | caption | |
| struct GF_EventMove |
| struct GF_EventDuration |
| struct GF_EventNavigate |
Hyperlink navigation event event proc return value: 0 if URL not supported, 1 if accepted (it is the user responsibility to load the url) YOU SHALL NOT DIRECTLY OPEN THE NEW URL IN THE EVENT PROC, THIS WOULD DEADLOCK THE COMPOSITOR
| Data Fields | ||
|---|---|---|
| u8 | type | |
| const char * | to_url | |
| u32 | param_count | |
| const char ** | parameters | |
| struct GF_EventMessage |
| struct GF_EventProgress |
Progress event event proc return value: ignored
| Data Fields | ||
|---|---|---|
| u8 | type | |
| const char * | service | |
| u32 | progress_type | |
| u32 | done | |
| u32 | total | |
| union GF_EventProgress | __unnamed__ | |
| struct GF_EventConnect |
| struct GF_EventAddonConnect |
Addon connection notification event event proc return value: 1 to indicate the compositor should attempt a default layout for this addon, 0: nothing will be done
| Data Fields | ||
|---|---|---|
| u8 | type | |
| const char * | addon_url | |
| const char * | mime_type | |
| struct GF_EventSysColors |
System desktop colors and window decoration event event proc return value: 1 if info has been completed, 0 otherwise
| Data Fields | ||
|---|---|---|
| u8 | type |
GF_EVENT_SYS_COLORS |
| u32 | sys_colors[28] |
ARGB colors, in order: ActiveBorder, ActiveCaption, AppWorkspace, Background, ButtonFace, ButtonHighlight, ButtonShadow, ButtonText, CaptionText, GrayText, Highlight, HighlightText, InactiveBorder, InactiveCaption, InactiveCaptionText, InfoBackground, InfoText, Menu, MenuText, Scrollbar, ThreeDDarkShadow, ThreeDFace, ThreeDHighlight, ThreeDLightShadow, ThreeDShadow, Window, WindowFrame, WindowText |
| struct GF_EventMutation |
| struct GF_EventOpenFile |
| struct GF_EventOrientationSensor |
| struct GF_EventGPS |
| struct GF_EventSensorRequest |
| struct GF_EventClipboard |
| union GF_Event |
Event object
Collaboration diagram for GF_Event:| Data Fields | ||
|---|---|---|
| u8 | type | |
| GF_EventMouse | mouse | |
| GF_EventMultiTouch | mtouch | |
| GF_EventKey | key | |
| GF_EventChar | character | |
| GF_EventOrientationSensor | sensor | |
| GF_EventGPS | gps | |
| GF_EventSize | size | |
| GF_EventShow | show | |
| GF_EventDuration | duration | |
| GF_EventNavigate | navigate | |
| GF_EventMessage | message | |
| GF_EventProgress | progress | |
| GF_EventConnect | connect | |
| GF_EventCaption | caption | |
| GF_EventCursor | cursor | |
| GF_EventAuthorize | auth | |
| GF_EventSysColors | sys_cols | |
| GF_EventMove | move | |
| GF_EventVideoSetup | setup | |
| GF_EventMutation | mutation | |
| GF_EventOpenFile | open_file | |
| GF_EventAddonConnect | addon_connect | |
| GF_EventSensorRequest | activate_sensor | |
| GF_EventClipboard | clipboard | |
Display orientation
| enum GF_EventType |
GPAC Event types
Event for which DOM event name is none are not exposed to DOM Event for which no DOM event name is given use the default DOM event name If the associated struct in \ref GF_Event is not indicated, no structure is used
| Enumerator | |
|---|---|
| GF_EVENT_CLICK | mouse click event associated struct: GF_EventMouse DOM Event: "click"" |
| GF_EVENT_MOUSEUP | mouse up event associated struct: GF_EventMouse DOM Event: "mouseup" |
| GF_EVENT_MOUSEDOWN | mouse down event associated struct: GF_EventMouse DOM Event: "mousedown" |
| GF_EVENT_MOUSEMOVE | mouse move event associated struct: GF_EventMouse DOM Event: "mousemove" |
| GF_EVENT_LAST_MOUSE_COORDS | |
| GF_EVENT_MOUSEWHEEL | mouse wheel event associated struct: GF_EventMouse DOM Event: "wheel" |
| GF_EVENT_MULTITOUCH | mouse multitouch event associated struct: GF_EventMultiTouch DOM Event: none |
| GF_EVENT_LAST_MOUSE | |
| GF_EVENT_FIRST_KEY | |
| GF_EVENT_KEYUP | keyup event associated struct: GF_EventKey DOM Event: "keyup" |
| GF_EVENT_KEYDOWN | keydown event associated struct: GF_EventKey DOM Event: "keydown", "keypress", "accesskey" |
| GF_EVENT_LONGKEYPRESS | long keypress event associated struct: GF_EventKey DOM Event: "longaccesskey" |
| GF_EVENT_TEXTINPUT | character input event associated struct: GF_EventChar DOM Event: "textInput" |
| GF_EVENT_FIRST_INTERNAL | |
| GF_EVENT_UNKNOWN | unknown event - GPAC internal |
| GF_EVENT_DBLCLICK | same as mousedown, generated internally by GPAC (not by video modules) but sent to GUI associated struct: GF_EventMouse DOM Event: "dblclick" |
| GF_EVENT_SCENE_ATTACHED | scene attached event, dispatched when the root node of a scene is loaded and attached to the window or parent object (animation, inline, ...) associated struct: none DOM Event: "gpac_scene_attached" |
| GF_EVENT_SIZE | window size changed event - indicate new w & h in .x end .y fields of event.
|
| GF_EVENT_SCENE_SIZE | signals the scene size (if indicated in scene) upon connection (sent to the user event proc only) if scene size hasn't changed (seeking or other) this event is not sent associated struct: GF_EventSize DOM Event: "gpac_scene_size" |
| GF_EVENT_SHOWHIDE | window show/hide (minimized or other). associated struct: GF_EventShow DOM Event: "gpac_show_hide" |
| GF_EVENT_SET_CURSOR | set mouse cursor associated struct: GF_EventCursor DOM Event: "gpac_set_cursor" |
| GF_EVENT_SET_CAPTION | set window caption associated struct: GF_EventCaption DOM Event: "gpac_set_caption" |
| GF_EVENT_MOVE | move window event associated struct: GF_EventMove DOM Event: "gpac_move" |
| GF_EVENT_REFRESH | window needs repaint refresh - (whenever needed, eg restore, hide->show, background refresh, paint) DOM Event: "gpac_refresh" |
| GF_EVENT_QUIT | app or window is being closed - a window ID value of 0 indicates global program close event associated struct: GF_EventShow DOM Event: "gpac_quit" |
| GF_EVENT_VIDEO_SETUP | video output setup message:
associated struct: GF_EventVideoSetup DOM Event: none |
| GF_EVENT_SET_GL | set current GL context for the calling thread DOM Event: none |
| GF_EVENT_SET_ORIENTATION | set display orientation - value is given by GF_EventSize orientation field associated struct: GF_EventSize DOM Event: none |
| GF_EVENT_SYS_COLORS | queries the list of system colors - only exchanged between compositor/vout and video output module associated struct: GF_EventSysColors DOM Event: none |
| GF_EVENT_PASTE_TEXT | indicates text has been pasted - from video output module to compositor/vout only associated struct: GF_EventClipboard DOM Event: none |
| GF_EVENT_COPY_TEXT | queries for text to be copied - from video output module to compositor/vout only associated struct: GF_EventClipboard DOM Event: none |
| GF_EVENT_CONNECT | root URL connected / disconnected event associated struct: GF_EventConnect DOM Event: "gpac_on_connect" |
| GF_EVENT_DURATION | duration of root URL presentation associated struct: GF_EventDuration DOM Event: "gpac_on_duration" |
| GF_EVENT_EOS | End of scene playback event DOM Event: "gpac_eos" |
| GF_EVENT_AUTHORIZATION | user and pass query event associated struct: GF_EventAuthorize DOM Event: "gpac_authorization" |
| GF_EVENT_NAVIGATE | user app should load or jump to the given URL associated struct: GF_EventNavigate DOM Event: "gpac_navigate" |
| GF_EVENT_NAVIGATE_INFO | indicates the link or its description under the mouse pointer associated struct: GF_EventNavigate DOM Event: "gpac_navigate_info" |
| GF_EVENT_MESSAGE | message from the compositor associated struct: GF_EventMessage DOM Event: "gpac_on_message" |
| GF_EVENT_PROGRESS | progress message from the compositor associated struct: GF_EventProgress DOM Event: "gpac_on_progress" |
| GF_EVENT_VIEWPOINTS | indicates viewpoint list has changed DOM Event: "gpac_viewpoints_changed" |
| GF_EVENT_STREAMLIST | indicates stream list has changed - no struct associated - only used when no scene info is present DOM Event: "gpac_streamlist_changed" |
| GF_EVENT_METADATA | indicates a change in associated metadata - not implemented |
| GF_EVENT_DROPFILE | indicates a list of file paths has been dropped on window associated struct: GF_EventOpenFile DOM Event: none |
| GF_EVENT_TEXT_EDITING_START | signal text editing is starting - only sent from compositor/vout to video output module, to show virtual keyboard DOM Event: none |
| GF_EVENT_TEXT_EDITING_END | signal text editing is done - only sent from compositor/vout to video output module, to hide virtual keyboard DOM Event: none |
| GF_EVENT_QUALITY_SWITCHED | quality change is detected by compositor DOM Event: "gpac_quality_switch" |
| GF_EVENT_TIMESHIFT_DEPTH | timeshift depth changed event DOM Event: "gpac_timeshift_depth_changed" |
| GF_EVENT_TIMESHIFT_UPDATE | position in timeshift buffer changed event DOM Event: "gpac_timeshift_update" |
| GF_EVENT_TIMESHIFT_OVERFLOW | position overflows the timeshift buffer event DOM Event: "gpac_timeshift_overflow" |
| GF_EVENT_TIMESHIFT_UNDERRUN | position underruns the timeshift bufferevent (eg fast forward / seek in the future) DOM Event: "gpac_timeshift_underrun" |
| GF_EVENT_ADDON_DETECTED | main addon (injected from active URL) detected DOM Event: "gpac_addon_found" |
| GF_EVENT_MAIN_ADDON_STATE | main addon (injected from active URL) detected DOM Event: "gpac_main_addon_state" |
| GF_EVENT_CODEC_SLOW | codec running too slow event DOM Event: "gpac_codec_slow" |
| GF_EVENT_CODEC_OK | codec running ok event (only sent after a codec too slow) DOM Event: "gpac_codec_ok" |
| GF_EVENT_SENSOR_REQUEST | sensor request event (send to app) DOM Event: none |
| GF_EVENT_SENSOR_ORIENTATION | orientation (yaw pitch roll) changed event (send by app) associated struct: GF_EventOrientationSensor DOM Event: none |
| GF_EVENT_SENSOR_GPS | GPS location changed event (send by app) associated struct: GF_EventGPS DOM Event: none |
| GF_EVENT_LAST_INTERNAL | |
| GF_EVENT_FIRST_DOM | |
| GF_EVENT_VP_RESIZE | viewport resize event, dispatched when viewport of a scene is being modified attached to the window or parent object associated struct: none DOM Event: "gpac_vp_changed" |
| GF_EVENT_TEXTSELECT | text is being selected |
| GF_EVENT_MOUSEOVER | mouse over node event |
| GF_EVENT_MOUSEOUT | mouse out node event |
| GF_EVENT_FOCUSIN | node focus in event |
| GF_EVENT_FOCUSOUT | node focus out event |
| GF_EVENT_ACTIVATE | node activate event |
| GF_EVENT_CHANGE | node focus change event - not implemented |
| GF_EVENT_FOCUS | focus received event - not implemented |
| GF_EVENT_BLUR | focus lost event - not implemented |
| GF_EVENT_LOAD | document load event, also used for XHR |
| GF_EVENT_UNLOAD | document unload event |
| GF_EVENT_ABORT | document abort event, also used for XHR |
| GF_EVENT_ERROR | document error event, also used for XHR |
| GF_EVENT_RESIZE | document resize event |
| GF_EVENT_SCROLL | document scroll event |
| GF_EVENT_ZOOM | document zoom event |
| GF_EVENT_BEGIN | fake SMIL begin event - it is NEVER fired, only used in SMIL begin parsing |
| GF_EVENT_BEGIN_EVENT | SMIL begin event |
| GF_EVENT_END | fake SMIL end event - it is NEVER fired, only used in SMIL end parsing |
| GF_EVENT_END_EVENT | SMIL end event |
| GF_EVENT_REPEAT | fake SMIL repeat event, it is NEVER fired, only used in SMIL repeat |
| GF_EVENT_REPEAT_EVENT | SMIL repeat event |
| GF_EVENT_TREE_MODIFIED | tree modified mutation event |
| GF_EVENT_NODE_INSERTED | node modified mutation event |
| GF_EVENT_NODE_REMOVED | node removed mutation event |
| GF_EVENT_NODE_INSERTED_DOC | node inserted in doc mutation event - not implemented |
| GF_EVENT_NODE_REMOVED_DOC | node removed from doc mutation event - not implemented |
| GF_EVENT_ATTR_MODIFIED | attribute modified mutation event |
| GF_EVENT_CHAR_DATA_MODIFIED | text data modified mutation event - not implemented |
| GF_EVENT_NODE_NAME_CHANGED | node name modified mutation event - not implemented |
| GF_EVENT_ATTR_NAME_CHANGED | attribute name modified mutation event - not implemented |
| GF_EVENT_DCCI_PROP_CHANGE | DCCI property of node modified - not implemented |
| GF_EVENT_ACTIVATED | LASeR activated event |
| GF_EVENT_DEACTIVATED | LASeR deactivated event |
| GF_EVENT_PAUSE | SMIL and HTML media pause trigger event |
| GF_EVENT_PAUSED_EVENT | SMIL and HTML media pause notification event |
| GF_EVENT_PLAY | SMIL and HTML media PLAY event |
| GF_EVENT_REPEAT_KEY | repeat key event |
| GF_EVENT_RESUME_EVENT | SMIL resumed event |
| GF_EVENT_SHORT_ACCESSKEY | short access key event |
| GF_EVENT_EXECUTION_TIME | pseudo-event only used in LASeR coding, solved to SMIL scene clock when parsing |
| GF_EVENT_MEDIA_SETUP_BEGIN | HTML5 media setup being event - GPAC internal |
| GF_EVENT_MEDIA_SETUP_DONE | HTML5 media setup done event - GPAC internal |
| GF_EVENT_MEDIA_LOAD_START | HTML5 media load statr event - also used in XHR |
| GF_EVENT_MEDIA_LOAD_DONE | HTML5 media load done event - also used in XHR |
| GF_EVENT_MEDIA_PROGRESS | HTML5 media progress event - also used in XHR |
| GF_EVENT_MEDIA_SUSPEND | HTML5 media suspend event - not implemented |
| GF_EVENT_MEDIA_EMPTIED | HTML5 media emptied event - not implemented |
| GF_EVENT_MEDIA_STALLED | HTML5 media stalled event - not implemented |
| GF_EVENT_MEDIA_LOADED_METADATA | HTML5 metadata loaded event - not implemented |
| GF_EVENT_MEDIA_LODADED_DATA | HTML5 media loaded event - not implemented |
| GF_EVENT_MEDIA_CANPLAY | HTML5 media can play - not implemented |
| GF_EVENT_MEDIA_CANPLAYTHROUGH | HTML5 media can play through - not implemented |
| GF_EVENT_MEDIA_PLAYING | HTML5 media playing - not implemented |
| GF_EVENT_MEDIA_WAITING | HTML5 media waiting - not implemented |
| GF_EVENT_MEDIA_SEEKING | HTML5 media seeking - not implemented |
| GF_EVENT_MEDIA_SEEKED | HTML5 media seeked - not implemented |
| GF_EVENT_MEDIA_ENDED | HTML5 media ended |
| GF_EVENT_MEDIA_DURATION_CHANGED | HTML5 media duration changed - not implemented |
| GF_EVENT_MEDIA_TIME_UPDATE | HTML5 media time update event |
| GF_EVENT_MEDIA_RATECHANGE | HTML5 media playbalck rate change event - not implemented |
| GF_EVENT_MEDIA_VOLUME_CHANGED | HTML5 media volume change event - not implemented |
| GF_EVENT_BATTERY | battery event - not implemented |
| GF_EVENT_CPU | CPU event - not implemented |
| enum GF_KeyCode |
GPAC/DOM3 key codes
| enum GF_KeyModifier |
1.9.1