https://github.com/agoraio/obs
https://github.com/agoraio/obs
agora obs
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/agoraio/obs
- Owner: AgoraIO
- Created: 2018-07-12T06:15:54.000Z (almost 8 years ago)
- Default Branch: agora-tool-ui-3.8.200
- Last Pushed: 2025-02-05T07:48:57.000Z (over 1 year ago)
- Last Synced: 2025-03-31T11:03:05.500Z (about 1 year ago)
- Topics: agora, obs
- Language: C++
- Size: 231 MB
- Stars: 49
- Watchers: 54
- Forks: 35
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Agora RTC Tool (Windows)
*[中文](README.zh.md)*
Agora RTC Tool for OBS Studio.
## Possible use cases
Using it for video chat in real time. This plugin is depended agora sdk.
This pulugin just publishes a selected camera video.
You can get details about agora sdk from [agora.io](https://www.agora.io/en)
**Running the tool:**
* Register an agora account, you can get an APPID.
* To startup Agora RTC Tool, open the "Agora RTC Tool" dialog under OBS' "Tools" menu.
* Initialize agora settings including fill appid, channel name and uid, before running the tool first time.
* Then you can start to publish stream to Agora SDK.
* If you want to publish stream to rtmp server after start agora streaming, you need to stop obs studio to publish stream to the same url.
* If agora sdk and obs studio use the same camera, the tool will make obs studio to stop using it. Enable obs studio to use camera after stop agora streaming.
## Download Release Setup
You can install release setup directly corresponding to OBS Stduio version.
* [agora-tool-ui for windows](https://github.com/AgoraIO/OBS/releases/download/3.6.200/Agora-Tool-3.6.200-Installer.exe) (26.1 and later)
## Compiling Agora RTC Tool
### Prerequisites
1. Download dependencies
download [deps](https://github.com/AgoraIO/OBS/releases/download/3.6.200/deps.zip), After unzip deps.zip, copy deps to folder agora-tool-ui.If you need update agora sdk, donwload lastes version [agora sdk](https://docs.agora.io/cn/All/downloads?platform=All%20Platforms). Unzip sdk file, replace corresponding files under deps/Agora folder. If ther version is a big update. For example the agora sdk interface used by plugin changed, you need adapt to the new version sdk.
2. You'll need [Qt 5.14.2](https://github.com/sbd021/Basic-Video-Broadcasting/releases/download/5.14.2/Qt5.14.2.zip),
[CMake](https://cmake.org/download/) and a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions) installed on your
computer.
### Windows
In cmake-gui, you'll have to set the following variables :
* QTDIR (path) : location of the Qt environment suited for your compiler and architecture
* LIBOBS_INCLUDE_DIR (path) : location of the libobs subfolder in the source code of OBS Studio
* LIBOBS_LIB (filepath) : location of the libobs project
* OBS_FRONTEND_LIB (filepath) : location of the obs-frontend-api project
For example, if the build directory is located in obs-studio src directory, named build64.
* LIBOBS\_INCLUDE\_DIR is obs-studio/libobs
* LIBOBS\_LIB is obs-studio/build64/libobs,
* OBS\_FRONTEND\_LIB is obs-studio/build64/UI/obs-frontend-api.
After configure camke, you get an variable LibObs_DIR, make sure its value is obs-studio/build64/libobs.
### Mac
Compile obs studio first, before you compile agora tool ui plugin. Reference obs studio compile document.
Use cmake-gui, set variable first:
* QTDIR ： Use the right version qt corresponding to conpiler, sucha as /usr/local/Cellar/qt/5.15.2/lib/cmake/Qt5
*
* LIBOBS_INCLUDE_DIR : the path libobs in obs studio source code path.
* LIBOBS_LIB: libobs path
* OBS_FRONTEND_LIB : obs-frontend-api path, such as:obs-studio/UI/obs-frontend-api
For example, obs source code path is obs-studio, build path is obs-studio/build64.
* LIBOBS\_INCLUDE\_DIR value is obs-studio/build/libobs
* LIBOBS\_LIB value is obs-studio/build/libobs,
* OBS\_FRONTEND\_LIB value is obs-studio/build/UI/obs-frontend-api.
Click configure on cmake-gui, then you get a variable LibObs_DIR. Make sure the value is obs-studio/build/libobs.
## Run RTC Tool
1 Startup obs
2 Select "Agora Rtc Tool" in Tool menu.Then pop up a dialog.
3 Click settings, then setup basic information
4 You can also download and fill a configure file, then load the configure file.
[AgoraObs.zip](https://github.com/AgoraIO/OBS/releases/download/3.3.0/AgoraObs.zip)
5 Configure file include:
* appid
* token
* channel name
* uid
* rtmp url