How To Use

Follow the official tutorial, open "Developer Command Prompt for VS 2022" and run the cmake command lines to build the plugin.

Build results are in the project folder: .\build_x64\rundir\RelWithDebInfo, you may see a folder

• "obs-screen-split-recording"

and two files

• "obs-screen-split-recording.dll"
• "obs-screen-split-recording.pdb".

The folder should be copied to the OBS studio's data\obs-plugins folder:

• e.g. "D:\obs-studio\data\obs-plugins"

The two files should be copied to OBS studio's obs-plugins\64bit folder:

• e.g. "D:\obs-studio\obs-plugins\64bit"

Code Notes

how to find recording videos save path?

C:\Users\WS\AppData\Roaming\obs-studio\basic\profiles\未命名\basic.ini

There are 3 paths:

• Output Mode - Simple(输出模式 简单): Recording Path(录像路径)
• Output Mode - Advanced(输出模式 高级): Standard(标准) Type: Recording Path(录像路径)
• Output Mode - Advanced(输出模式 高级): Custom Output(FFmpeg)(自定义输出) Type: Recording Path(录像路径)

[SimpleOutput]
FilePath=C:/Users/wangshuo/Videos
...balabala

[AdvOut]
...balabala
RecFilePath=C:\\Users\\Administrator\\Videos
...balabala
FFFilePath=C:/Users/wangshuo/Pictures
...balabala

see the function below and other two load setting functions to set save path in cpp

void OBSBasicSettings::LoadSimpleOutputSettings()

OBS Plugin Template

Introduction

The plugin template is meant to be used as a starting point for OBS Studio plugin development. It includes:

• Boilerplate plugin source code
• A CMake project file
• GitHub Actions workflows and repository actions

Supported Build Environments

Platform	Tool
Windows	Visal Studio 17 2022
macOS	XCode 16.0
Windows, macOS	CMake 3.30.5
Ubuntu 24.04	CMake 3.28.3
Ubuntu 24.04	ninja-build
Ubuntu 24.04	pkg-config
Ubuntu 24.04	build-essential

Quick Start

An absolute bare-bones Quick Start Guide is available in the wiki.

Documentation

All documentation can be found in the Plugin Template Wiki.

Suggested reading to get up and running:

• Getting started
• Build system requirements
• Build system options

GitHub Actions & CI

Default GitHub Actions workflows are available for the following repository actions:

• push: Run for commits or tags pushed to master or main branches.
• pr-pull: Run when a Pull Request has been pushed or synchronized.
• dispatch: Run when triggered by the workflow dispatch in GitHub's user interface.
• build-project: Builds the actual project and is triggered by other workflows.
• check-format: Checks CMake and plugin source code formatting and is triggered by other workflows.

The workflows make use of GitHub repository actions (contained in .github/actions) and build scripts (contained in .github/scripts) which are not needed for local development, but might need to be adjusted if additional/different steps are required to build the plugin.

Retrieving build artifacts

Successful builds on GitHub Actions will produce build artifacts that can be downloaded for testing. These artifacts are commonly simple archives and will not contain package installers or installation programs.

Building a Release

To create a release, an appropriately named tag needs to be pushed to the main/master branch using semantic versioning (e.g., 12.3.4, 23.4.5-beta2). A draft release will be created on the associated repository with generated installer packages or installation programs attached as release artifacts.

Signing and Notarizing on macOS

Basic concepts of codesigning and notarization on macOS are explained in the correspodning Wiki article which has a specific section for the GitHub Actions setup.