Obs_source_info structure and fill it out with information and Source API Reference (obs_source_t) for more information.įor example, to implement a source object, you need to define an The libobs/obs-source.h file is theĭedicated header for implementing sources. Sources can also be used to implement audio and videoįilters as well as transitions. Things such asĬapturing displays/games/audio, playing a video, showing an image, or Sources are used to render video and/or audio on stream. * my-plugin.c */ #include /* 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 ) Sources  This is an example of a common directory structure for a native plugin Source, my-output.c for the definition of a custom output, etc. Initialization is done, my-source.c for the definition of a custom ‘my-plugin’, you’d have something like my-plugin.c where plugin For example, if you were to create a plugin called

Initialization, and then specific files for each individual object The common way source files are organized is to have one file for plugin Libobs/graphics/graphics.h – Used for graphics renderingĬommon Directory Structure and CMakeLists.txt  Libobs/obs-properties.h – Used for generating properties for Libobs/obs-data.h – Used for managing settings for libobs Libobs/obs-service.h – Used for implementing services in Libobs/obs-encoder.h – Used for implementing encoders in Libobs/obs-output.h – Used for implementing outputs in plugin Libobs/obs-source.h – Used for implementing sources in plugin This file automatically includes the following files: Libobs/obs-module.h – The primary header used for creating plugin These are some notable headers commonly used by plugins: Writing your first plugin? We provide a basic template plugin Plugins can implement sources, outputs, encoders, and services. The ability to captureĪnd/or output audio/video, make a recording, output to an RTMP stream,Įncode in x264 are all examples of things that are accomplished via Array Output Serializer Structure (struct array_output_data)Īlmost all custom functionality is added through plugin modules, whichĪre typically dynamic libraries or scripts.Serializer Structure (struct serializer).Circular Buffer Structure (struct circlebuf).

Raw Frame Data Structure (encoder_frame).

Encoder Packet Structure (encoder_packet).

Encoder Definition Structure (obs_encoder_info).

Output Definition Structure (obs_output_info).

Scene Item Order Info Structure (*obs_sceneitem_order_info).Scene Item Crop Structure (obs_sceneitem_crop).Scene Item Transform Structure (obs_transform_info).Source Definition Structure (obs_source_info).Initialization, Shutdown, and Information.Saving/Loading Objects and Object Management.Common Directory Structure and CMakeLists.txt.

Obsproject plugins