![]() |
Open Broadcaster Software
Free, open source software for live streaming and recording
|
This file is used by modules for module declaration and module exports. More...
Go to the source code of this file.
Macros | |
#define | MODULE_EXPORT EXPORT |
#define | MODULE_EXTERN extern |
#define | OBS_DECLARE_MODULE() |
#define | OBS_MODULE_USE_DEFAULT_LOCALE(module_name, default_locale) |
#define | obs_module_file(file) obs_find_module_file(obs_current_module(), file) |
#define | obs_module_config_path(file) obs_module_get_config_path(obs_current_module(), file) |
#define | OBS_MODULE_AUTHOR(name) |
Functions | |
MODULE_EXPORT bool | obs_module_load (void) |
MODULE_EXPORT void | obs_module_unload (void) |
MODULE_EXPORT void | obs_module_post_load (void) |
MODULE_EXPORT void | obs_module_set_locale (const char *locale) |
MODULE_EXPORT void | obs_module_free_locale (void) |
MODULE_EXTERN const char * | obs_module_text (const char *lookup_string) |
MODULE_EXTERN bool | obs_module_get_string (const char *lookup_string, const char **translated_string) |
MODULE_EXTERN obs_module_t * | obs_current_module (void) |
MODULE_EXPORT const char * | obs_module_name (void) |
MODULE_EXPORT const char * | obs_module_description (void) |
This file is used by modules for module declaration and module exports.
#define MODULE_EXPORT EXPORT |
#define MODULE_EXTERN extern |
#define OBS_DECLARE_MODULE | ( | ) |
Required: Declares a libobs module.
#define OBS_MODULE_AUTHOR | ( | name | ) |
Optional: Declares the author(s) of the module
name | Author name(s) |
#define obs_module_config_path | ( | file | ) | obs_module_get_config_path(obs_current_module(), file) |
Returns the location to a module config file associated with the current module. Free with bfree when complete. Will return NULL if configuration directory is not set. Equivalent to: obs_module_get_config_path(obs_current_module(), file);
#define obs_module_file | ( | file | ) | obs_find_module_file(obs_current_module(), file) |
Returns the location to a module data file associated with the current module. Free with bfree when complete. Equivalent to: obs_find_module_file(obs_current_module(), file);
#define OBS_MODULE_USE_DEFAULT_LOCALE | ( | module_name, | |
default_locale | |||
) |
Optional: Use this macro in a module to use default locale handling.
MODULE_EXTERN obs_module_t* obs_current_module | ( | void | ) |
Helper function that returns the current module
MODULE_EXPORT const char* obs_module_description | ( | void | ) |
Optional: Returns a description of the module
MODULE_EXPORT void obs_module_free_locale | ( | void | ) |
Called to free the current locale data for the module.
MODULE_EXTERN bool obs_module_get_string | ( | const char * | lookup_string, |
const char ** | translated_string | ||
) |
Helper function for looking up locale if default locale handler was used, returns true if text found, otherwise false
MODULE_EXPORT bool obs_module_load | ( | void | ) |
Required: Called when the module is loaded. Use this function to load all the sources/encoders/outputs/services for your module, or anything else that may need loading.
MODULE_EXPORT const char* obs_module_name | ( | void | ) |
Optional: Returns the full name of the module
MODULE_EXPORT void obs_module_post_load | ( | void | ) |
Optional: Called when all modules have finished loading
MODULE_EXPORT void obs_module_set_locale | ( | const char * | locale | ) |
Called to set the current locale data for the module.
MODULE_EXTERN const char* obs_module_text | ( | const char * | lookup_string | ) |
Helper function for looking up locale if default locale handler was used
MODULE_EXPORT void obs_module_unload | ( | void | ) |
Optional: Called when the module is unloaded.