![]() |
Open Broadcaster Software
Free, open source software for live streaming and recording
|
Go to the source code of this file.
Data Structures | |
struct | obs_modal_ui |
struct | obs_modeless_ui |
Macros | |
#define | OBS_UI_SUCCESS 0 |
#define | OBS_UI_CANCEL -1 |
#define | OBS_UI_NOTFOUND -2 |
Functions | |
EXPORT void | obs_register_modal_ui (const struct obs_modal_ui *info) |
EXPORT void | obs_register_modeless_ui (const struct obs_modeless_ui *info) |
EXPORT int | obs_exec_ui (const char *id, const char *task, const char *target, void *data, void *ui_data) |
EXPORT void * | obs_create_ui (const char *id, const char *task, const char *target, void *data, void *ui_data) |
Modules can specify custom user-interface-specific exports. UI functions can be within the same library as the actual core logic, or separated in to different modules to split up UI logic and core module logic.
The reasoning for this is to allow for custom user interface of differing toolkits or for automatically generated user interface, or to simply allow separation of UI code from core code (which may often be in differing languages).
#define OBS_UI_CANCEL -1 |
#define OBS_UI_NOTFOUND -2 |
#define OBS_UI_SUCCESS 0 |
EXPORT void* obs_create_ui | ( | const char * | id, |
const char * | task, | ||
const char * | target, | ||
void * | data, | ||
void * | ui_data | ||
) |
Requests modeless UI to be created. Returns immediately.
name | Name of the input/output/etc type that UI was requested for |
task | Task of the user interface |
target | Desired target (i.e. "qt", "wx", "gtk3", "win32", etc) |
data | Pointer to the obs input/output/etc |
ui_data | UI-specific data, usually a parent pointer/handle (if any) |
EXPORT int obs_exec_ui | ( | const char * | id, |
const char * | task, | ||
const char * | target, | ||
void * | data, | ||
void * | ui_data | ||
) |
Requests modal UI to be displayed. Returns when user is complete.
name | Name of the input/output/etc type that UI was requested for |
task | Task of the user interface (usually "config") |
target | Desired target (i.e. "qt", "wx", "gtk3", "win32", etc) |
data | Pointer to the obs input/output/etc |
ui_data | UI-specific data, usually a parent pointer/handle (if any) |
EXPORT void obs_register_modal_ui | ( | const struct obs_modal_ui * | info | ) |
Regsiters a modal UI definition to the current obs context. This should be used in obs_module_load.
info | Pointer to the modal definition structure |
EXPORT void obs_register_modeless_ui | ( | const struct obs_modeless_ui * | info | ) |
Registers a modeless UI definition to the current obs context. This should be used in obs_module_load.
info | Pointer to the modal definition structure |