Welcome to OBS Studio’s documentation!

• See More

  Setting up an OBS development environment? Use the Wiki

• Developing your first OBS plugin? Use the obs-plugintemplate

Core Concepts

• OBS Studio Backend Design
• Plugins
• Frontends
• Rendering Graphics
• Python/Lua Scripting

API Reference

• OBS Core
  • Initialization, Shutdown, and Information
  • Libobs Objects
  • Video, Audio, and Graphics
  • Primary signal/procedure handlers
  • Core OBS Signals
  • Displays
  • Views
• Modules
  • obs_module_t
  • Module Macros
  • Module Exports
  • Module Externs
  • Frontend Module Functions
• Core API Object
  • Sources (obs_source_t)
  • Scenes (obs_scene_t)
  • Outputs (obs_output_t)
  • Encoders (obs_encoder_t)
  • Services (obs_service_t)
  • Data Settings (obs_data_t)
  • Properties (obs_properties_t)
• Platform/Utility
  • Logging
  • Memory Management
  • Config Files
  • Dynamic Arrays
  • Double-Ended Queue
  • Dynamic Strings And String Helpers
  • Platform Helpers
  • Profiler
  • Serializer
  • Array Output Serializer
  • File Input/Output Serializers
  • Buffered File Output Serializer
  • Source Profiler
  • Text Lookup Interface
  • Threading
• Callbacks (libobs/callback)
  • Calldata
  • Signals
  • Procedure Handlers
• Graphics (libobs/graphics)
  • Effects (Shaders)
  • 2-Component Vector
  • 3-Component Vector
  • 4-Component Vector
  • Quaternion
  • Matrix
  • Extra Math Functions/Macros
  • Image File Helper
  • Axis Angle
  • Core Graphics API
• Media I/O (libobs/media-io)
  • Video Handler
  • Audio Handler
  • Resampler
• OBS Studio Frontend API
  • Structures/Enumerations
  • Functions