![]() |
Open Broadcaster Software
Free, open source software for live streaming and recording
|
Data Fields | |
const char * | id |
const char * | task |
const char * | target |
bool(* | exec )(void *object, void *ui_data) |
void * | type_data |
void(* | free_type_data )(void *type_data) |
Modal UI definition structure
bool(* obs_modal_ui::exec)(void *object, void *ui_data) |
Callback to execute modal interface.
The object variable points to the input/output/encoder/etc. The ui_data varaible points to the UI parent or UI-specific data to be used with the custom user interface.
What ui_data points to differs depending on the target, and you should use discretion and consistency when using this variable to relay information to the UI function. For example, it would be ideal to have ui_data point to a parent, QWidget for Qt, or a wxWindow for wxWidgets, etc., though it's up to the discretion of the developer to define that value. Because of the nature of void pointers, discretion and consistency is advised.
object | Pointer/handle to the data associated with this call. |
ui_data | UI data to pass associated with this specific target, if any. |
void(* obs_modal_ui::free_type_data)(void *type_data) |
const char* obs_modal_ui::id |
Identifier associated with this UI
const char* obs_modal_ui::target |
UI target (UI toolkit or program name)
const char* obs_modal_ui::task |
Task of the UI
void* obs_modal_ui::type_data |