OBS Studio

https://docs.obsproject.com
Admin
OBS Studio is free and open-source software for video recording and live streaming, offering...
Tokens:576,264
Snippets:4,343
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Effect Parameters Example

Source: https://docs.obsproject.com/graphics

Shows the recommended way to start an effect file by declaring uniforms. Includes the universal ViewProj and image parameters, plus custom float4 and float parameters.

```hlsl
uniform float4x4 ViewProj;
uniform texture2d image;

uniform float4 my_color_param;
uniform float my_float_param;

```

--------------------------------

### CMakeLists.txt for a native plugin module

Source: https://docs.obsproject.com/plugins

Example CMakeLists.txt that defines the project, lists source files, creates a MODULE library linked against libobs, and installs plugin data using install_obs_plugin_with_data.

```cmake
# my-plugin/CMakeLists.txt

project(my-plugin)

set(my-plugin_SOURCES
      my-plugin.c
      my-source.c
      my-output.c
      my-encoder.c
      my-service.c)

add_library(my-plugin MODULE
      ${my-plugin_SOURCES})
target_link_libraries(my-plugin
      libobs)

install_obs_plugin_with_data(my-plugin data)
```

--------------------------------

### Configure and start an OBS output with encoders and service

Source: https://docs.obsproject.com/frontends

Shows how to configure an output with video and audio encoders, optionally attach a service for streaming, and start the output. Once started successfully, the output automatically captures from the current video/audio output channels. If startup fails, the output sends the stop signal with an error code and possibly a translated message retrievable via obs_output_get_last_error().

```c
obs_encoder_set_video(my_h264_encoder, obs_get_video());
obs_encoder_set_audio(my_aac_encoder, obs_get_audio());
obs_output_set_video_encoder(my_output, my_h264_encoder);
obs_output_set_audio_encoder(my_output, my_aac_encoder);
obs_output_set_service(my_output, my_service); /* if a stream */
obs_output_start(my_output);

```

--------------------------------

### obs_frontend_recording_start()

Source: https://docs.obsproject.com/plugins

Starts recording.

```APIDOC
## obs_frontend_recording_start()

### Description
Starts recording.

### Method
Function

### Signature
`void obs_frontend_recording_start(void);`

### Parameters
None.

### Return Value
None.
```

--------------------------------

### profile_start

Source: https://docs.obsproject.com/reference-libobs-util-profiler

Starts a profile node. This profile node will be a child of the last node that was started.

```APIDOC
## profile_start

### Description
Starts a profile node. This profile node will be a child of the last node that was started.

### Function Signature
void profile_start(const char *name)

### Parameters
- **name** (const char*) - Required - Name of the profile node

### Returns
void
```

--------------------------------

### Transition Functions

Source: https://docs.obsproject.com/reference-core-objects

Functions for managing transitions, including getting sources, starting, and setting properties.

```APIDOC
## Transition Functions

### Description
These functions manage transitions, including getting sources, starting, and setting properties.

### Functions
- `obs_transition_get_source()`
- `obs_transition_clear()`
- `obs_transition_get_active_source()`
- `obs_transition_start()`
- `obs_transition_is_active()`
- `obs_transition_set_size()`
- `obs_transition_get_size()`
- `obs_transition_set_scale_type()`
- `obs_transition_get_scale_type()`
- `obs_transition_set_alignment()`
- `obs_transition_get_alignment()`
```

--------------------------------

### obs_transition_start()

Source: https://docs.obsproject.com/reference-canvases

Starts a transition.

```APIDOC
## obs_transition_start()

### Description
Starts a transition.

### Function Signature
`void obs_transition_start(obs_source_t *transition, enum obs_transition_mode mode, uint32_t duration_ms, obs_source_t *dest)`

### Parameters
- **transition** (obs_source_t*) - Required - The transition source.
- **mode** (enum obs_transition_mode) - Required - Transition mode.
- **duration_ms** (uint32_t) - Required - Duration in milliseconds.
- **dest** (obs_source_t*) - Required - Destination source.

### Return Value
None.
```

--------------------------------

### obs_frontend_streaming_start()

Source: https://docs.obsproject.com/plugins

Starts streaming.

```APIDOC
## obs_frontend_streaming_start()

### Description
Starts streaming.

### Method
Function

### Signature
`void obs_frontend_streaming_start(void);`

### Parameters
None.

### Return Value
None.
```

--------------------------------

### profiler_start()

Source: https://docs.obsproject.com/graphics

Starts the profiler.

```APIDOC
## profiler_start()

### Description
Starts the profiler.

### Function Signature
`void profiler_start(void)`

### Parameters
None.

```

--------------------------------

### obs_frontend_start_virtualcam()

Source: https://docs.obsproject.com/graphics

Starts the virtual camera. This function is part of the OBS frontend API and can be called by plugins to start the virtual camera.

```APIDOC
## obs_frontend_start_virtualcam()

### Description
Starts the virtual camera.

### Method
Function call

### Endpoint
obs_frontend_start_virtualcam()

### Parameters
None

### Response
No return value.
```

--------------------------------

### obs_frontend_replay_buffer_start()

Source: https://docs.obsproject.com/graphics

Starts the replay buffer. This function is part of the OBS frontend API and can be called by plugins to start the replay buffer.

```APIDOC
## obs_frontend_replay_buffer_start()

### Description
Starts the replay buffer.

### Method
Function call

### Endpoint
obs_frontend_replay_buffer_start()

### Parameters
None

### Response
No return value.
```

--------------------------------

### profile_start()

Source: https://docs.obsproject.com/graphics

Starts profiling a named section.

```APIDOC
## profile_start()

### Description
Starts profiling a named section.

### Function Signature
`void profile_start(profiler_snapshot_entry_t *entry)`

### Parameters
- **entry** (profiler_snapshot_entry_t*) - Required - Entry to start profiling.

```

--------------------------------

### obs_source_media_started()

Source: https://docs.obsproject.com/reference-canvases

Checks if media has started on a source.

```APIDOC
## obs_source_media_started()

### Description
Checks if media has started on a source.

### Function Signature
`bool obs_source_media_started(const obs_source_t *source)`

### Parameters
- **source** (const obs_source_t*) - Required - The source to query.

### Return Value
`bool` - True if media has started, false otherwise.
```

--------------------------------

### obs_sceneitem_do_transition()

Source: https://docs.obsproject.com/reference-libobs-graphics-axisang

Starts the transition for the scene item.

```APIDOC
## obs_sceneitem_do_transition()

### Description
Triggers the transition for a scene item.

### Method
Function

### Signature
`void obs_sceneitem_do_transition(obs_sceneitem_t *item);`

### Parameters
- `item` (obs_sceneitem_t*) - Required - The scene item.

### Returns
- void

```

--------------------------------

### obs_frontend_get_transitions()

Source: https://docs.obsproject.com/plugins

Gets a list of transition sources.

```APIDOC
## obs_frontend_get_transitions()

### Description
Gets a list of transition sources.

### Method
Function

### Signature
`obs_frontend_source_list *obs_frontend_get_transitions(void);`

### Parameters
None.

### Return Value
- **obs_frontend_source_list*** - Pointer to a list of transition sources. Must be freed with `obs_frontend_source_list_free`.
```

--------------------------------

### Transition Functions

Source: https://docs.obsproject.com/reference-sources

Functions to manage transitions, including getting sources, clearing, starting, and setting size/scale/alignment.

```APIDOC
## obs_transition_get_source()

### Description
Gets the source of a transition.

### Method
Function

### Endpoint
obs_transition_get_source()

### Parameters
- None explicitly documented.

## obs_transition_clear()

### Description
Clears the transition.

### Method
Function

### Endpoint
obs_transition_clear()

### Parameters
- None explicitly documented.

## obs_transition_get_active_source()

### Description
Gets the active source of a transition.

### Method
Function

### Endpoint
obs_transition_get_active_source()

### Parameters
- None explicitly documented.

## obs_transition_start()

### Description
Starts the transition.

### Method
Function

### Endpoint
obs_transition_start()

### Parameters
- None explicitly documented.

## obs_transition_is_active()

### Description
Checks if the transition is active.

### Method
Function

### Endpoint
obs_transition_is_active()

### Parameters
- None explicitly documented.

## obs_transition_set_size()

### Description
Sets the size of the transition.

### Method
Function

### Endpoint
obs_transition_set_size()

### Parameters
- None explicitly documented.

## obs_transition_get_size()

### Description
Gets the size of the transition.

### Method
Function

### Endpoint
obs_transition_get_size()

### Parameters
- None explicitly documented.

## obs_transition_set_scale_type()

### Description
Sets the scale type of the transition.

### Method
Function

### Endpoint
obs_transition_set_scale_type()

### Parameters
- None explicitly documented.

## obs_transition_get_scale_type()

### Description
Gets the scale type of the transition.

### Method
Function

### Endpoint
obs_transition_get_scale_type()

### Parameters
- None explicitly documented.

## obs_transition_set_alignment()

### Description
Sets the alignment of the transition.

### Method
Function

### Endpoint
obs_transition_set_alignment()

### Parameters
- None explicitly documented.

## obs_transition_get_alignment()

### Description
Gets the alignment of the transition.

### Method
Function

### Endpoint
obs_transition_get_alignment()

### Parameters
- None explicitly documented.

```

--------------------------------

### obs_startup()

Source: https://docs.obsproject.com/plugins

Initializes the OBS library. Must be called before using most other OBS functions.

```APIDOC
## obs_startup()

### Description
Initializes the OBS library. Must be called before using most other OBS functions.

### Method
Function

### Signature
`bool obs_startup(const char *locale, const char *module_config_path, profiler_name_store_t *store)`

### Parameters
- **locale** (const char*) - Required - The locale to use for localization.
- **module_config_path** (const char*) - Required - Path to the module configuration directory.
- **store** (profiler_name_store_t*) - Optional - Profiler name store, can be NULL.

### Returns
- **bool** - True on success, false on failure.
```

--------------------------------

### Virtual Camera Functions

Source: https://docs.obsproject.com/reference-libobs-graphics-vec4

Functions to control the virtual camera: start, stop, check active, and get output.

```APIDOC
## Virtual Camera Functions

### Description
These functions control the virtual camera: start, stop, check if active, and get the output object.

### Functions

#### obs_frontend_get_virtualcam_output()
Returns the virtual camera output object.

#### obs_frontend_start_virtualcam()
Starts the virtual camera.

#### obs_frontend_stop_virtualcam()
Stops the virtual camera.

#### obs_frontend_virtualcam_active()
Returns whether the virtual camera is active.

```

--------------------------------

### obs_startup()

Source: https://docs.obsproject.com/backend-design

Initializes the OBS library. Must be called before using most other OBS functions.

```APIDOC
## obs_startup()

### Description
Initializes the OBS library. Must be called before using most other OBS functions.

### Method
Function

### Signature
`bool obs_startup(const char *locale, profiler_name_store_t *store, uint32_t version)`

### Parameters
- **locale** (const char*) - Required - Locale string for localization.
- **store** (profiler_name_store_t*) - Optional - Profiler name store.
- **version** (uint32_t) - Required - Version of the calling application.

### Returns
- **bool** - True if initialization succeeded, false otherwise.
```

--------------------------------

### obs_startup

Source: https://docs.obsproject.com/reference-core

Initializes the OBS core context with the specified locale, module config path, and profiler name store. Returns false if already initialized or failed to initialize.

```APIDOC
## obs_startup

### Description
Initializes the OBS core context.

### Function Signature
bool obs_startup(const char *locale, const char *module_config_path, profiler_name_store_t *store)

### Parameters
- **locale** (const char*) - Required - The locale to use for modules (E.G. "en-US")
- **module_config_path** (const char*) - Required - Path to module config storage directory (or NULL if none)
- **store** (profiler_name_store_t*) - Required - The profiler name store for OBS to use or NULL

### Returns
- **bool** - false if already initialized or failed to initialize
```

--------------------------------

### obs_startup

Source: https://docs.obsproject.com/frontends

Initializes libobs. Must be called before any other libobs functions. The configuration directory parameter is optional and used by certain modules.

```APIDOC
## obs_startup

### Description
Initializes libobs. Must be called before any other libobs functions. The configuration directory parameter is optional and used by certain modules.

### Method
Function

### Signature
`obs_startup(config_dir)`

### Parameters
- **config_dir** (string) - Optional - Configuration storage directory for modules.

### Returns
- **bool** - True on success, false on failure.

### Notes
Must be called before `obs_reset_video()` and `obs_reset_audio()`.
```

--------------------------------

### Data Settings (obs_data_t) - Get Functions

Source: https://docs.obsproject.com/reference-libobs-graphics-vec2

Functions to get values of different types from an obs_data_t object.

```APIDOC
## Data Settings (obs_data_t) - Get Functions

### Description
These functions retrieve values of various types from an obs_data_t object.

### Functions
- `obs_data_get_string()` - Gets a string value.
- `obs_data_get_int()` - Gets an integer value.
- `obs_data_get_double()` - Gets a double value.
- `obs_data_get_bool()` - Gets a boolean value.
- `obs_data_get_obj()` - Gets an obs_data_t object value.
- `obs_data_get_array()` - Gets an obs_data_array_t value.
```

--------------------------------

### my-source.c: Define obs_source_info structure

Source: https://docs.obsproject.com/plugins

Example of implementing a source by defining an obs_source_info structure with callbacks for name, create, destroy, update, render, and dimensions.

```c
/* my-source.c */

[...]

struct obs_source_info my_source {
        .id           = "my_source",
        .type         = OBS_SOURCE_TYPE_INPUT,
        .output_flags = OBS_SOURCE_VIDEO,
        .get_name     = my_source_name,
        .create       = my_source_create,
        .destroy      = my_source_destroy,
        .update       = my_source_update,
        .video_render = my_source_render,
        .get_width    = my_source_width,
        .get_height   = my_source_height
};

```

--------------------------------

### os_cpu_usage_info_start()

Source: https://docs.obsproject.com/graphics

Initializes CPU usage tracking and returns an info handle.

```APIDOC
## os_cpu_usage_info_start()

### Description
Initializes CPU usage tracking and returns an info handle.

### Function Signature
`os_cpu_usage_info_t *os_cpu_usage_info_start(void)`

### Parameters
None.

### Return Value
- **os_cpu_usage_info_t*** - Handle to CPU usage info, or NULL on failure.

```

--------------------------------

### obs_output_can_begin_data_capture

Source: https://docs.obsproject.com/reference-outputs

Determines whether video/audio capture (encoded or raw) is able to start. Call this before initializing any output state to ensure that the output can start.

```APIDOC
## obs_output_can_begin_data_capture

### Description
Determines whether video/audio capture (encoded or raw) is able to start. Call this before initializing any output state to ensure that the output can start.

### Function
- `bool obs_output_can_begin_data_capture(const obs_output_t *output, int flags)`

### Parameters
- **output** (const obs_output_t*) - Required - The output.
- **flags** (int) - Required - Reserved. Set this to 0.

### Returns
- _true_ if data capture can begin, _false_ otherwise.
```

--------------------------------

### obs_get_source_properties

Source: https://docs.obsproject.com/reference-sources

Gets the properties for a source type by its ID. This is useful for getting default properties for a source type without an instance. Free with obs_properties_destroy().

```APIDOC
## obs_get_source_properties

### Description
Gets the properties for a source type by its ID. This is useful for getting default properties for a source type without an instance. Free with `obs_properties_destroy()`.

### Function Signature
```c
obs_properties_t *obs_get_source_properties(const char *id);
```

### Parameters
- **id** (const char*) - Required - The source type identifier.

### Returns
- **obs_properties_t*** - The properties list for the source type. Must be freed with `obs_properties_destroy()`.
```

--------------------------------

### Utility Functions

Source: https://docs.obsproject.com/reference-libobs-util-text-lookup

Functions to get locale strings, check theme darkness, get last recording/screenshot/replay, add undo/redo actions, and copy/paste scene items.

```APIDOC
## obs_frontend_get_locale_string()

### Description
Gets a localized string for the given key.

### Method
Function call

### Endpoint
obs_frontend_get_locale_string()

### Parameters
None

### Returns
const char* - The localized string.

## obs_frontend_is_theme_dark()

### Description
Checks if the current theme is dark.

### Method
Function call

### Endpoint
obs_frontend_is_theme_dark()

### Parameters
None

### Returns
bool - true if theme is dark, false otherwise.

## obs_frontend_get_last_recording()

### Description
Gets the path of the last recording.

### Method
Function call

### Endpoint
obs_frontend_get_last_recording()

### Parameters
None

### Returns
const char* - The path of the last recording.

## obs_frontend_get_last_screenshot()

### Description
Gets the path of the last screenshot.

### Method
Function call

### Endpoint
obs_frontend_get_last_screenshot()

### Parameters
None

### Returns
const char* - The path of the last screenshot.

## obs_frontend_get_last_replay()

### Description
Gets the path of the last replay buffer.

### Method
Function call

### Endpoint
obs_frontend_get_last_replay()

### Parameters
None

### Returns
const char* - The path of the last replay buffer.

## obs_frontend_add_undo_redo_action()

### Description
Adds an undo/redo action to the undo stack.

### Method
Function call

### Endpoint
obs_frontend_add_undo_redo_action()

### Parameters
None

### Returns
void

## obs_frontend_copy_sceneitem()

### Description
Copies the selected scene item.

### Method
Function call

### Endpoint
obs_frontend_copy_sceneitem()

### Parameters
None

### Returns
void

## obs_frontend_can_paste_sceneitem()

### Description
Checks if a scene item can be pasted.

### Method
Function call

### Endpoint
obs_frontend_can_paste_sceneitem()

### Parameters
None

### Returns
bool - true if paste is possible, false otherwise.

## obs_frontend_paste_sceneitem()

### Description
Pastes the copied scene item.

### Method
Function call

### Endpoint
obs_frontend_paste_sceneitem()

### Parameters
None

### Returns
void

## obs_frontend_is_safe_mode_enabled()

### Description
Checks if safe mode is enabled.

### Method
Function call

### Endpoint
obs_frontend_is_safe_mode_enabled()

### Parameters
None

### Returns
bool - true if safe mode is enabled, false otherwise.
```

--------------------------------

### obs_transition_swap_begin()

Source: https://docs.obsproject.com/reference-canvases

Begins swapping transition sources.

```APIDOC
## obs_transition_swap_begin()

### Description
Begins swapping transition sources.

### Function Signature
`void obs_transition_swap_begin(obs_source_t *transition)`

### Parameters
- **transition** (obs_source_t*) - Required - The transition source.

### Return Value
None.
```

--------------------------------

### obs_output_start()

Source: https://docs.obsproject.com/reference-libobs-graphics-axisang

Starts the output, returning success status.

```APIDOC
## obs_output_start()

### Description
Starts the output.

### Method
Function

### Signature
`bool obs_output_start(obs_output_t *output);`

### Parameters
- `output` (obs_output_t*) - Required - The output.

### Returns
- `bool` - True on success, false on failure.

```

--------------------------------

### Video and UI Functions

Source: https://docs.obsproject.com/reference-libobs-graphics-matrix4

Functions to reset video, open source properties/filters/interaction, open scene item transform, get current record output path, get locale string, check theme darkness, get last recording/screenshot/replay, add undo/redo action, copy/paste scene items, and check safe mode.

```APIDOC
## obs_frontend_reset_video()

### Description
Resets the video output.

### Method
Function call

### Signature
`void obs_frontend_reset_video()`

### Parameters
None

### Returns
None

## obs_frontend_open_source_properties()

### Description
Opens the properties dialog for a source.

### Method
Function call

### Signature
`void obs_frontend_open_source_properties(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - Required - Pointer to the source.

### Returns
None

## obs_frontend_open_source_filters()

### Description
Opens the filters dialog for a source.

### Method
Function call

### Signature
`void obs_frontend_open_source_filters(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - Required - Pointer to the source.

### Returns
None

## obs_frontend_open_source_interaction()

### Description
Opens the interaction dialog for a source.

### Method
Function call

### Signature
`void obs_frontend_open_source_interaction(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - Required - Pointer to the source.

### Returns
None

## obs_frontend_open_sceneitem_edit_transform()

### Description
Opens the edit transform dialog for a scene item.

### Method
Function call

### Signature
`void obs_frontend_open_sceneitem_edit_transform(obs_sceneitem_t *item)`

### Parameters
- **item** (obs_sceneitem_t*) - Required - Pointer to the scene item.

### Returns
None

## obs_frontend_get_current_record_output_path()

### Description
Gets the current recording output path.

### Method
Function call

### Signature
`const char *obs_frontend_get_current_record_output_path()`

### Parameters
None

### Returns
- **const char*** - The current recording output path.

## obs_frontend_get_locale_string()

### Description
Gets a localized string for the given key.

### Method
Function call

### Signature
`const char *obs_frontend_get_locale_string(const char *key)`

### Parameters
- **key** (const char*) - Required - The localization key.

### Returns
- **const char*** - The localized string.

## obs_frontend_is_theme_dark()

### Description
Checks if the current theme is dark.

### Method
Function call

### Signature
`bool obs_frontend_is_theme_dark()`

### Parameters
None

### Returns
- **bool** - True if theme is dark, false otherwise.

## obs_frontend_get_last_recording()

### Description
Gets the path of the last recording.

### Method
Function call

### Signature
`const char *obs_frontend_get_last_recording()`

### Parameters
None

### Returns
- **const char*** - Path of the last recording.

## obs_frontend_get_last_screenshot()

### Description
Gets the path of the last screenshot.

### Method
Function call

### Signature
`const char *obs_frontend_get_last_screenshot()`

### Parameters
None

### Returns
- **const char*** - Path of the last screenshot.

## obs_frontend_get_last_replay()

### Description
Gets the path of the last replay buffer.

### Method
Function call

### Signature
`const char *obs_frontend_get_last_replay()`

### Parameters
None

### Returns
- **const char*** - Path of the last replay.

## obs_frontend_add_undo_redo_action()

### Description
Adds an undo/redo action to the undo/redo stack.

### Method
Function call

### Signature
`void obs_frontend_add_undo_redo_action(const char *name, undo_redo_cb undo, undo_redo_cb redo, void *data)`

### Parameters
- **name** (const char*) - Required - Name of the action.
- **undo** (undo_redo_cb) - Required - Callback for undo.
- **redo** (undo_redo_cb) - Required - Callback for redo.
- **data** (void*) - Optional - Data to pass to callbacks.

### Returns
None

## obs_frontend_copy_sceneitem()

### Description
Copies a scene item to the clipboard.

### Method
Function call

### Signature
`void obs_frontend_copy_sceneitem(obs_sceneitem_t *item)`

### Parameters
- **item** (obs_sceneitem_t*) - Required - Pointer to the scene item to copy.

### Returns
None

## obs_frontend_can_paste_sceneitem()

### Description
Checks if a scene item can be pasted.

### Method
Function call

### Signature
`bool obs_frontend_can_paste_sceneitem()`

### Parameters
None

### Returns
- **bool** - True if paste is possible, false otherwise.

## obs_frontend_paste_sceneitem()

### Description
Pastes a scene item from the clipboard.

### Method
Function call

### Signature
`void obs_frontend_paste_sceneitem()`

### Parameters
None

### Returns
None

## obs_frontend_is_safe_mode_enabled()

### Description
Checks if safe mode is enabled.

### Method
Function call

### Signature
`bool obs_frontend_is_safe_mode_enabled()`

### Parameters
None

### Returns
- **bool** - True if safe mode is enabled, false otherwise.
```

--------------------------------

### obs_output_begin_data_capture

Source: https://docs.obsproject.com/reference-outputs

Begins data capture from raw media or encoders. This is typically when the output actually activates (starts) internally. Video/audio data will start being sent to the callbacks of the output.

```APIDOC
## obs_output_begin_data_capture

### Description
Begins data capture from raw media or encoders. This is typically when the output actually activates (starts) internally. Video/audio data will start being sent to the callbacks of the output.

### Function
- `bool obs_output_begin_data_capture(obs_output_t *output, int flags)`

### Parameters
- **output** (obs_output_t*) - Required - The output.
- **flags** (int) - Required - Reserved. Set this to 0.

### Returns
- _true_ if successful, _false_ otherwise.
```

--------------------------------

### Utility Functions

Source: https://docs.obsproject.com/reference-scenes

Functions to get locale strings, check theme darkness, get last recording/screenshot/replay, add undo/redo actions, copy/paste scene items, and check safe mode.

```APIDOC
## obs_frontend_get_locale_string()

### Description
Gets a localized string.

### Method
Function call

### Endpoint
obs_frontend_get_locale_string()

### Parameters
None

### Response
Returns the localized string.

## obs_frontend_is_theme_dark()

### Description
Checks whether the current theme is dark.

### Method
Function call

### Endpoint
obs_frontend_is_theme_dark()

### Parameters
None

### Response
Returns a boolean indicating if the theme is dark.

## obs_frontend_get_last_recording()

### Description
Gets the path of the last recording.

### Method
Function call

### Endpoint
obs_frontend_get_last_recording()

### Parameters
None

### Response
Returns the path of the last recording.

## obs_frontend_get_last_screenshot()

### Description
Gets the path of the last screenshot.

### Method
Function call

### Endpoint
obs_frontend_get_last_screenshot()

### Parameters
None

### Response
Returns the path of the last screenshot.

## obs_frontend_get_last_replay()

### Description
Gets the path of the last replay buffer.

### Method
Function call

### Endpoint
obs_frontend_get_last_replay()

### Parameters
None

### Response
Returns the path of the last replay buffer.

## obs_frontend_add_undo_redo_action()

### Description
Adds an undo/redo action.

### Method
Function call

### Endpoint
obs_frontend_add_undo_redo_action()

### Parameters
None

### Response
No return value.

## obs_frontend_copy_sceneitem()

### Description
Copies a scene item.

### Method
Function call

### Endpoint
obs_frontend_copy_sceneitem()

### Parameters
None

### Response
No return value.

## obs_frontend_can_paste_sceneitem()

### Description
Checks whether a scene item can be pasted.

### Method
Function call

### Endpoint
obs_frontend_can_paste_sceneitem()

### Parameters
None

### Response
Returns a boolean indicating if paste is possible.

## obs_frontend_paste_sceneitem()

### Description
Pastes a scene item.

### Method
Function call

### Endpoint
obs_frontend_paste_sceneitem()

### Parameters
None

### Response
No return value.

## obs_frontend_is_safe_mode_enabled()

### Description
Checks whether safe mode is enabled.

### Method
Function call

### Endpoint
obs_frontend_is_safe_mode_enabled()

### Parameters
None

### Response
Returns a boolean indicating if safe mode is enabled.
```

--------------------------------

### Register a Lua source with obs_register_source

Source: https://docs.obsproject.com/scripting

Create an obs_source_info table with required keys and call obs_register_source(info) to register a custom source. The example defines get_name, create, video_render, get_width, and get_height callbacks. Note that the source data is stored as a table and the width/height are returned from that table.

```lua
local info = {}
info.id = "my_source_id"
info.type = obslua.OBS_SOURCE_TYPE_INPUT
info.output_flags = obslua.OBS_SOURCE_VIDEO

info.get_name = function()
        return "My Source"
end

info.create = function(settings, source)
        -- typically source data would be stored as a table
        local my_source_data = {}

        [...]

        return my_source_data
end

info.video_render = function(my_source_data, effect)
        [...]
end

info.get_width = function(my_source_data)
        [...]

        -- assuming the source data contains a 'width' key
        return my_source_data.width
end

info.get_height = function(my_source_data)
        [...]

        -- assuming the source data contains a 'height' key
        return my_source_data.height
end

-- register the source
obs_register_source(info)

```

--------------------------------

### my-plugin.c: Register one object of each type

Source: https://docs.obsproject.com/plugins

Complete example of a native plugin module that registers a source, output, encoder, and service. Includes OBS_DECLARE_MODULE() and OBS_MODULE_USE_DEFAULT_LOCALE().

```c
/* my-plugin.c */
#include <obs-module.h>

/* Defines common functions (required) */
OBS_DECLARE_MODULE()

/* Implements common ini-based locale (optional) */
OBS_MODULE_USE_DEFAULT_LOCALE("my-plugin", "en-US")

extern struct obs_source_info  my_source;  /* Defined in my-source.c  */
extern struct obs_output_info  my_output;  /* Defined in my-output.c  */
extern struct obs_encoder_info my_encoder; /* Defined in my-encoder.c */
extern struct obs_service_info my_service; /* Defined in my-service.c */

bool obs_module_load(void)
{
        obs_register_source(&my_source);
        obs_register_output(&my_output);
        obs_register_encoder(&my_encoder);
        obs_register_service(&my_service);
        return true;
}

```

--------------------------------

### obs_init_module()

Source: https://docs.obsproject.com/reference-canvases

Initializes a module.

```APIDOC
## obs_init_module()

### Description
Initializes a module.

### Function Signature
`bool obs_init_module(obs_module_t *module)`

### Parameters
- **module** (obs_module_t*) - The module to initialize.

### Returns
bool - true if the module was initialized successfully, false otherwise.
```

--------------------------------

### os_mkdir()

Source: https://docs.obsproject.com/graphics

Creates a directory.

```APIDOC
## os_mkdir()

### Description
Creates a directory.

### Function Signature
`int os_mkdir(const char *path)`

### Parameters
- **path** (const char*) - Required - Path of the directory to create.

### Return Value
- **int** - 0 on success, non-zero on failure.

```

--------------------------------

### Color key filter rendering with obs_source_process_filter_begin/end

Source: https://docs.obsproject.com/graphics

Example of rendering a video effect filter from the color key filter. Calls obs_source_process_filter_begin, sets effect parameters, then obs_source_process_filter_end to finish rendering.

```c
static void color_key_render(void *data, gs_effect_t *effect)
{
        struct color_key_filter_data *filter = data;

        if (!obs_source_process_filter_begin(filter->context, GS_RGBA,
                                OBS_ALLOW_DIRECT_RENDERING))
                return;

        gs_effect_set_vec4(filter->color_param, &filter->color);
        gs_effect_set_float(filter->contrast_param, filter->contrast);
        gs_effect_set_float(filter->brightness_param, filter->brightness);
        gs_effect_set_float(filter->gamma_param, filter->gamma);
        gs_effect_set_vec4(filter->key_color_param, &filter->key_color);
        gs_effect_set_float(filter->similarity_param, filter->similarity);
        gs_effect_set_float(filter->smoothness_param, filter->smoothness);

        obs_source_process_filter_end(filter->context, filter->effect, 0, 0);

        UNUSED_PARAMETER(effect);
}

```

--------------------------------

### gs_effect_get_param_by_name

Source: https://docs.obsproject.com/reference-libobs-util-darray

Gets a parameter by name.

```APIDOC
## gs_effect_get_param_by_name

### Description
Gets a parameter by name.

### Function
`gs_effect_get_param_by_name()`

```

--------------------------------

### obs_source_info.create

Source: https://docs.obsproject.com/reference-sources

Callback to create the implementation data for the source. Required for all source types.

```APIDOC
## Function: create

### Description
Creates the implementation data for the source.

### Signature
`void *(*create)(obs_data_t *settings, obs_source_t *source)`

### Parameters
- **settings** (obs_data_t*) - Settings to initialize the source with.
- **source** (obs_source_t*) - Source that this data is associated with.

### Return Value
- **void*** - The implementation data associated with this source.
```

--------------------------------

### gs_effect_get_technique

Source: https://docs.obsproject.com/reference-libobs-util-darray

Gets a technique by name.

```APIDOC
## gs_effect_get_technique

### Description
Gets a technique by name.

### Function
`gs_effect_get_technique()`

```

--------------------------------

### gs_get_viewport

Source: https://docs.obsproject.com/reference-libobs-graphics-graphics

Gets the current viewport.

```APIDOC
## gs_get_viewport

### Description
Gets the current viewport.

### Method
void gs_get_viewport(struct gs_rect *rect)

### Parameters
- **rect** (struct gs_rect *) - Required - Pointer to receive viewport rectangle

```

--------------------------------

### obs_frontend_get_locale_string()

Source: https://docs.obsproject.com/plugins

Gets a localized string.

```APIDOC
## obs_frontend_get_locale_string()

### Description
Gets a localized string.

### Method
Function call

### Signature
`const char* obs_frontend_get_locale_string(const char* string)`

### Parameters
- **string** (const char*) - Required - The string to localize.

### Return Value
- **const char*** - The localized string.
```

--------------------------------

### gs_image_file_ex_init()

Source: https://docs.obsproject.com/graphics

Initializes an image file helper structure.

```APIDOC
## gs_image_file_ex_init()

### Description
Initializes an image file helper structure.

### Method
Function

### Signature
`void gs_image_file_ex_init(gs_image_file_ex_t *image)`

### Parameters
- **image** (gs_image_file_ex_t*) - Image file helper structure.

### Returns
None
```

--------------------------------

### gs_image_file_ex_init

Source: https://docs.obsproject.com/reference-libobs-graphics-image-file

Loads and initializes an image file helper. Does not initialize the texture; call gs_image_file_ex_init_texture() to initialize the texture.

```APIDOC
## gs_image_file_ex_init

### Description
Loads and initializes an image file helper. Does not initialize the texture; call `gs_image_file_ex_init_texture()` to initialize the texture.

### Method
Function

### Signature
`void gs_image_file_ex_init(gs_image_file_ex_t *image, const char *file, enum gs_image_alpha_mode alpha_mode)`

### Parameters
- **image** (gs_image_file_ex_t*) - Required - Image file helper to initialize
- **file** (const char*) - Required - Path to the image file to load
- **alpha_mode** (enum gs_image_alpha_mode) - Required - Alpha mode for the image

### Return Value
None
```

--------------------------------

### obs_canvas_get_uuid

Source: https://docs.obsproject.com/reference-canvases

Gets the UUID of a canvas.

```APIDOC
## obs_canvas_get_uuid

### Description
Get canvas UUID.

### Method
Function

### Signature
`const char *obs_canvas_get_uuid(const obs_canvas_t *canvas)`

### Parameters
- **canvas** (const obs_canvas_t*) - Required - The canvas to get the UUID from.

### Returns
- **const char*** - The canvas UUID.
```

--------------------------------

### obs_canvas_get_name

Source: https://docs.obsproject.com/reference-canvases

Gets the name of a canvas.

```APIDOC
## obs_canvas_get_name

### Description
Get canvas name.

### Method
Function

### Signature
`const char *obs_canvas_get_name(const obs_canvas_t *canvas)`

### Parameters
- **canvas** (const obs_canvas_t*) - Required - The canvas to get the name from.

### Returns
- **const char*** - The canvas name.
```

--------------------------------

### os_mkdirs()

Source: https://docs.obsproject.com/graphics

Creates a directory and all missing parent directories.

```APIDOC
## os_mkdirs()

### Description
Creates a directory and all missing parent directories.

### Function Signature
`int os_mkdirs(const char *path)`

### Parameters
- **path** (const char*) - Required - Path of the directory to create.

### Return Value
- **int** - 0 on success, non-zero on failure.

```

--------------------------------

### obs_transition_get_alignment()

Source: https://docs.obsproject.com/reference-canvases

Gets the alignment of a transition.

```APIDOC
## obs_transition_get_alignment()

### Description
Gets the alignment of a transition.

### Function Signature
`uint32_t obs_transition_get_alignment(const obs_source_t *transition)`

### Parameters
- **transition** (const obs_source_t*) - Required - The transition source.

### Return Value
`uint32_t` - Alignment flags.
```

--------------------------------

### obs_transition_get_size()

Source: https://docs.obsproject.com/reference-canvases

Gets the size of a transition.

```APIDOC
## obs_transition_get_size()

### Description
Gets the size of a transition.

### Function Signature
`void obs_transition_get_size(const obs_source_t *transition, uint32_t *cx, uint32_t *cy)`

### Parameters
- **transition** (const obs_source_t*) - Required - The transition source.
- **cx** (uint32_t*) - Required - Output width.
- **cy** (uint32_t*) - Required - Output height.

### Return Value
None.
```

--------------------------------

### obs_transition_get_source()

Source: https://docs.obsproject.com/reference-canvases

Gets the source of a transition.

```APIDOC
## obs_transition_get_source()

### Description
Gets the source of a transition.

### Function Signature
`obs_source_t *obs_transition_get_source(obs_source_t *transition)`

### Parameters
- **transition** (obs_source_t*) - Required - The transition source.

### Return Value
`obs_source_t*` - The transition source.
```

--------------------------------

### my-plugin.c: Register source in obs_module_load()

Source: https://docs.obsproject.com/plugins

Shows how to call obs_register_source() within obs_module_load() to register the source defined in my-source.c.

```c
/* my-plugin.c */

[...]

extern struct obs_source_info  my_source;  /* Defined in my-source.c  */

bool obs_module_load(void)
{
        obs_register_source(&my_source);

        [...]

        return true;
}

```

--------------------------------

### obs_source_get_flags()

Source: https://docs.obsproject.com/reference-canvases

Gets flags for a source.

```APIDOC
## obs_source_get_flags()

### Description
Gets flags for a source.

### Function Signature
`uint32_t obs_source_get_flags(const obs_source_t *source)`

### Parameters
- **source** (const obs_source_t*) - Required - The source to query.

### Return Value
`uint32_t` - The flags.
```

--------------------------------

### Retrieve and free scene list with obs_frontend_get_scenes

Source: https://docs.obsproject.com/reference-frontend-api

Populates an obs_frontend_source_list with reference-incremented scenes in the same order as the Scenes dock. Do not call obs_source_release or obs_scene_release on these sources; use obs_frontend_source_list_free to release them. Use obs_scene_from_source to convert a source to an obs_scene_t.

```c
struct obs_frontend_source_list scenes = {0};

obs_frontend_get_scenes(&scenes);

for (size_t i = 0; i < scenes.sources.num; i++) {
      /* Do NOT call `obs_source_release` or `obs_scene_release`
       * on these sources
       */
      obs_source_t *source = scenes.sources.array[i];

      /* Convert to obs_scene_t if needed */
      obs_scene_t *scene = obs_scene_from_source(source);

      [...]
}

obs_frontend_source_list_free(&scenes);

```

--------------------------------

### obs_source_get_volume()

Source: https://docs.obsproject.com/reference-canvases

Gets the volume of a source.

```APIDOC
## obs_source_get_volume()

### Description
Gets the volume of a source.

### Function Signature
`float obs_source_get_volume(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
float - The volume level.
```

--------------------------------

### file_output_serializer_init()

Source: https://docs.obsproject.com/graphics

Initializes a file output serializer.

```APIDOC
## file_output_serializer_init()

### Description
Initializes a file output serializer.

### Function Signature
`bool file_output_serializer_init(struct serializer *s, const char *path)`

### Parameters
- **s** (struct serializer*) - Required - Serializer to initialize.
- **path** (const char*) - Required - Path to the file to write.

### Return Value
- **bool** - true on success, false on failure.

```

--------------------------------

### obs_source_get_id()

Source: https://docs.obsproject.com/reference-canvases

Gets the ID of a source.

```APIDOC
## obs_source_get_id()

### Description
Gets the ID of a source.

### Function Signature
`const char *obs_source_get_id(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
const char* - The source type ID.
```

--------------------------------

### obs_source_get_type()

Source: https://docs.obsproject.com/reference-canvases

Gets the type of a source.

```APIDOC
## obs_source_get_type()

### Description
Gets the type of a source.

### Function Signature
`enum obs_source_type obs_source_get_type(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
enum obs_source_type - The source type.
```

--------------------------------

### obs_source_get_uuid()

Source: https://docs.obsproject.com/reference-canvases

Gets the UUID of a source.

```APIDOC
## obs_source_get_uuid()

### Description
Gets the UUID of a source.

### Function Signature
`const char *obs_source_get_uuid(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
const char* - The UUID of the source.
```

--------------------------------

### os_dlopen()

Source: https://docs.obsproject.com/graphics

Opens a dynamic library. Returns a handle to the loaded library or NULL on failure.

```APIDOC
## os_dlopen()

### Description
Opens a dynamic library. Returns a handle to the loaded library or NULL on failure.

### Function Signature
`void *os_dlopen(const char *path)`

### Parameters
- **path** (const char*) - Required - Path to the dynamic library file.

### Return Value
- **void*** - Handle to the loaded library, or NULL on failure.

```

--------------------------------

### obs_source_get_name()

Source: https://docs.obsproject.com/reference-canvases

Gets the name of a source.

```APIDOC
## obs_source_get_name()

### Description
Gets the name of a source.

### Function Signature
`const char *obs_source_get_name(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
const char* - The name of the source.
```

--------------------------------

### obs_source_get_settings()

Source: https://docs.obsproject.com/reference-canvases

Gets the settings of a source.

```APIDOC
## obs_source_get_settings()

### Description
Gets the settings of a source.

### Function Signature
`obs_data_t *obs_source_get_settings(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
obs_data_t* - The settings.
```

--------------------------------

### obs_display_create()

Source: https://docs.obsproject.com/backend-design

Creates a display.

```APIDOC
## obs_display_create()

### Description
Creates a display.

### Method
Function

### Signature
`obs_display_t *obs_display_create(const struct gs_init_data *graphics_data, uint32_t background_color)`

### Parameters
- **graphics_data** (const struct gs_init_data*) - Required - Graphics initialization data.
- **background_color** (uint32_t) - Required - Background color.

### Returns
- **obs_display_t*** - Display handle.
```

--------------------------------

### obs_source_get_height()

Source: https://docs.obsproject.com/reference-canvases

Gets the height of a source.

```APIDOC
## obs_source_get_height()

### Description
Gets the height of a source.

### Function Signature
`uint32_t obs_source_get_height(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
uint32_t - The height in pixels.
```

--------------------------------

### obs_source_media_started

Source: https://docs.obsproject.com/reference-sources

Emits a media_started signal for the source.

```APIDOC
## obs_source_media_started

### Description
Emits a **media_started** signal.

### Function Signature
void obs_source_media_started(obs_source_t *source)

### Parameters
- **source** (obs_source_t*) - Required - The source that started media playback.
```

--------------------------------

### os_cpu_usage_info_start()

Source: https://docs.obsproject.com/scripting

Starts collecting CPU usage information. This function is part of the CPU Usage Functions group in the platform utilities API.

```APIDOC
## os_cpu_usage_info_start()

### Description
Starts collecting CPU usage information.

### Method
Function Call

### Signature
`os_cpu_usage_info_start()`
```

--------------------------------

### obs_source_get_width()

Source: https://docs.obsproject.com/reference-canvases

Gets the width of a source.

```APIDOC
## obs_source_get_width()

### Description
Gets the width of a source.

### Function Signature
`uint32_t obs_source_get_width(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
uint32_t - The width in pixels.
```

--------------------------------

### obs_source_properties()

Source: https://docs.obsproject.com/reference-canvases

Gets the properties of a source.

```APIDOC
## obs_source_properties()

### Description
Gets the properties of a source.

### Function Signature
`obs_properties_t *obs_source_properties(obs_source_t *source)`

### Parameters
- **source** (obs_source_t*) - The source.

### Returns
obs_properties_t* - The properties.
```
Tokens:
Raw