agoraio/obs

Agora RTC Tool (Windows)

中文

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

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 (26.1 and later)

Compiling Agora RTC Tool

Prerequisites

1. Download dependencies

   download deps, After unzip deps.zip, copy deps to folder agora-tool-ui.If you need update agora sdk, donwload lastes version agora sdk. 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, CMake and a working OBS Studio development environment 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

5 Configure file include:

• appid
• token
• channel name
• uid
• rtmp url

obs's Issues

请问可以升级OBS Sutdio版本吗

最新obs 已经升级到25，目前21版本在win10系统，部分显卡最新驱动会报错，官方最新版本正常，还望能尽快升级obs 版本

Any example of config setup using API?

Hello! 想一次性咨询多个问题：

1. windows 3.3.0版本我看到有通过api获取config的方式，但是只看到了一个textinput输入框，具体的例子或者使用方式有吗？
2. 一般rtcEngine再初始化时需要指定profile: 及是音视频通话还是直播，这个plugin是选择了其中哪种模式呢？
3. 核心开发者能否提供一个联系方式呢？想进一步交流。

Not streaming on macos

I've installed obs on mac os using this release but it won't start streaming.

It says:

Starting the output failed. Please check the log for details.

Note: If you are using the NVENC or AMD encoders, make sure your video drivers are up to date.

I've changed the encoders for streaming and recording but it had no effect.

I've also checked the logs:

11:57:22.129: CPU Name: Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz
11:57:22.129: CPU Speed: 2900MHz
11:57:22.129: Physical Cores: 6, Logical Cores: 12
11:57:22.129: Physical Memory: 32768MB Total
11:57:22.129: OS Name: Mac OS X (NSMACHOperatingSystem)
11:57:22.129: OS Version: Version 10.16 (Build 20B29)
11:57:22.129: Kernel Version: 20.1.0
11:57:22.133: hotkeys-cocoa: Getting keyboard keys failed
11:57:22.133: hotkeys-cocoa: Getting keyboard keys failed
11:57:22.133: hotkeys-cocoa: Getting keyboard keys failed
11:57:22.133: hotkeys-cocoa: Using layout 'com.apple.keylayout.ABC'
11:57:22.133: Portable mode: false
11:57:22.241: OBS 25.0.7-38-g09e3e6ed (mac)
11:57:22.241: ---------------------------------
11:57:22.242: ---------------------------------
11:57:22.242: audio settings reset:
11:57:22.242: 	samples per sec: 44100
11:57:22.242: 	speakers:        2
11:57:22.242: ---------------------------------
11:57:22.242: Initializing OpenGL...
11:57:22.268: Loading up OpenGL on adapter ATI Technologies Inc. AMD Radeon Pro 560X OpenGL Engine
11:57:22.268: OpenGL loaded successfully, version 4.1 ATI-4.0.47, shading language 4.10
11:57:22.341: ---------------------------------
11:57:22.341: video settings reset:
11:57:22.341: 	base resolution:   1920x1080
11:57:22.341: 	output resolution: 1920x1080
11:57:22.341: 	downscale filter:  Lanczos
11:57:22.341: 	fps:               60/1
11:57:22.341: 	format:            NV12
11:57:22.341: 	YUV mode:          601/Partial
11:57:22.341: NV12 texture support not available
11:57:22.342: Audio monitoring device:
11:57:22.342: 	name: Default
11:57:22.342: 	id: default
11:57:22.342: ---------------------------------
11:57:22.345: Failed to load 'en-US' text for module: 'decklink-ouput-ui.so'
11:57:22.351: os_dlopen(libpython3.7m.dylib->libpython3.7m.dylib): dlopen(libpython3.7m.dylib, 257): image not found
11:57:22.351: 
11:57:22.351: [Python] Could not load library: libpython3.7m.dylib
11:57:22.360: agora_loaded
11:57:22.421: A DeckLink iterator could not be created.  The DeckLink drivers may not be installed
11:57:22.421: No blackmagic support
11:57:22.481: [VideoToolbox encoder]: Adding VideoToolbox H264 encoders
11:57:22.498: [obs-browser]: Version 2.8.6
11:57:22.506: VLC found, VLC video source enabled
11:57:22.507: Ignoring old obs-browser.so version
11:57:22.507: ---------------------------------
11:57:22.507:   Loaded Modules:
11:57:22.507:     vlc-video.so
11:57:22.507:     text-freetype2.so
11:57:22.507:     rtmp-services.so
11:57:22.507:     obs-x264.so
11:57:22.507:     obs-vst.so
11:57:22.507:     obs-transitions.so
11:57:22.507:     obs-outputs.so
11:57:22.507:     obs-libfdk.so
11:57:22.507:     obs-filters.so
11:57:22.507:     obs-ffmpeg.so
11:57:22.507:     obs-browser.so
11:57:22.507:     mac-vth264.so
11:57:22.507:     mac-syphon.so
11:57:22.507:     mac-decklink.so
11:57:22.507:     mac-capture.so
11:57:22.507:     mac-avcapture.so
11:57:22.507:     mac-agora.so
11:57:22.507:     linux-jack.so
11:57:22.507:     image-source.so
11:57:22.507:     frontend-tools.so
11:57:22.507:     decklink-ouput-ui.so
11:57:22.507:     coreaudio-encoder.so
11:57:22.507: ---------------------------------
11:57:22.507: os_dlopen(../obs-plugins/obs-browser->../obs-plugins/obs-browser.so): dlopen(../obs-plugins/obs-browser.so, 257): image not found
11:57:22.507: 
11:57:22.507: ==== Startup complete ===============================================
11:57:22.519: All scene data cleared
11:57:22.519: ------------------------------------------------
11:57:22.610: coreaudio: device 'MacBook Pro Microphone' initialized
11:57:22.610: [Loaded global audio device]: 'Mic/Aux'
11:57:22.619: Webcam: Selected device 'FaceTime HD Camera (Built-in)'
11:57:22.621: Webcam: Using preset 640x480
11:57:22.643: adding 46 milliseconds of audio buffering, total audio buffering is now 46 milliseconds (source: Mic/Aux)
11:57:22.643: 
11:57:22.668: Switched to scene 'Coding'
11:57:22.668: ------------------------------------------------
11:57:22.668: Loaded scenes:
11:57:22.668: - scene 'Coding':
11:57:22.668:     - source: 'Webcam' (av_capture_input)
11:57:22.668: - scene 'Terminal':
11:57:22.668:     - source: 'CLI' (window_capture)
11:57:22.668:     - source: 'Webcam' (av_capture_input)
11:57:22.668: ------------------------------------------------

More info:

• MacBook Pro (2018)
• MacOS 11.0.1

How can I get this to work, and keep it working in the future? Updating OBS seems to remove the agora plugin so I don't know what the best approach is.

Resolution/frame is not correct when streaming from OSX

When we stream from OSX with OBS studio version 25.0.7-38-g09e3e6ed, the resolution/frame is not correct.

To repro:

• start with a portrait canvas 405x720

expected:

• see full frame on the client side

actually:

• only see the center part of the video. top, bottom, left & right are cut out of the video frame on the client side.

想问问这个版本支持最新的agora4k直播吗？

想问问这个版本支持最新的agora4k直播吗？

Streaming from Agora on Mac using UI tool

Hi!

We're playing with the latest release, which looks "agora UI tool", as a solution to stream from my OBS 26.1+, but we can't figure out how this actually works.

We used the macos installer and everything seems to run fine, but we can't see where the actual files are installed (which path?), nor any visible change on the OBS UI.

Can you please help us? What should we do to have OBS stream to our Agora channels?

Many thanks

3.6.200 version not working with latest OBS, crashed when start streaming

Step to reproduce:

1. Install OBS 27.1.3
2. Install Agora RTC Tool 3.6.200
3. Enter AppID and Channel
4. Start Streaming ==> OBS quit unexpectedly

Enviroment:

• MacOS Monterey/BigSur both not working
• Window 10 x64 also

Note: The 3.3.3 version still able to working with OBS.

How to run streaming to agora network?

I'm using win32 version, I've clicked "Start to Agora Streaming", entered channel, uid & appid, pushed Save but nothing happened.. What should I do to start streaming?

Streaming portrait mode + save settings

Hi!

I am testing the Agora RTC Tool on Macos, OBS 26.1.2. I managed to stream correctly to our app (flutter), but I am finding this 2 problems:

• I can't seem to stream portrait. While the settings will allow me to change width and height to 1080x1920 in the Agora Settings, it will not work and the call will show a cut version of the video in landscape. I think it should respect OBS video output settings.
• The settings will not save. Everytime I open OBS, I need to input APPID and any other setting.

Is that solved in current master? Would you be so kind to release a new version is that the case?

Thanks

where is mac-agora plugin source code?

where is mac-agora plugin source code?

Build failed while adding Agora plugin to OBS

Hi @plutoless and @sbd021 ,

I'm running OBS(27.1.3) on mac OS and Agora-tool-ui-3.3.3.

I'm getting following error while configuring the project using CMAKE.

Could NOT find LibAJANTV2 (missing: AJA_LIBRARIES_INCLUDE_DIR AJA_NTV2_LIB) 
aja plugin disabled (deps not found)
Could NOT find LibAJANTV2 (missing: AJA_LIBRARIES_INCLUDE_DIR AJA_NTV2_LIB) 
aja-output-ui plugin disabled (deps not found)
Configuring done

Unable to generate the project. Any fix for this issue ?

Will obs version 28 or 29 be supported ?

Will obs version 28 or 29 be supported ?

CMake Error at C:/Program Files/CMake/share/cmake-3.24/Modules/CMakeFindDependencyMacro.cmake:47 (find_package):
By not providing "Findw32-pthreads.cmake" in CMAKE_MODULE_PATH this project
has asked CMake to find a package configuration file provided by
"w32-pthreads", but CMake did not find one.

Could not find a package configuration file provided by "w32-pthreads" with
any of the following names:

w32-pthreadsConfig.cmake
w32-pthreads-config.cmake

Add the installation prefix of "w32-pthreads" to CMAKE_PREFIX_PATH or set
"w32-pthreads_DIR" to a directory containing one of the above files. If
"w32-pthreads" provides a separate development package or SDK, be sure it
has been installed.
Call Stack (most recent call first):
obs-studio/build/libobs/libobsConfig.cmake:30 (find_dependency)
CMakeLists.txt:36 (find_package)

支持obs for mac吗

Streaming in 2 different platforms makes obs crash

I stream on Epal (with Agora tool) and on Twitch (with normal OBS Studio) but after some minutes, OBS completly crash. Can someone help me please?

The Audio and Video is not mapping while livestreaming

Has anyone had the same issue as mine?
host and audience use the mobile app to live stream is not happen
It just happens in case host use the Agora RTC Tool in OBS and the audience use the mobile app.

All of them are in the latest version.

We are using the Agora bitrate

Failed to build branch agora-tool-ui-3.6.200

Hey guys,
I have set up the building environment according to the manual page. I built the branch agora-tool-ui-3.3.3 successfully. but it failed when I build the branch agora-tool-ui-3.6.200. There are some errors like namespace "agora::rtc" has no member "RtcConnection" Please refer to the below screenshot.

It seems the Agora SDK isn't the latest. But I think I already use the latest one Windows v3.6.0.

Build Environment

• Windows 10 x64
• Vistual Studio 2019
• Agora SDK Windows v3.6.0

Compilation on MacOS 12 failed

I'm trying to build agora-ui-tool from sources on my Mac, according to the short manual that is placed in the repo, but strange error is appearing.
After configuration and generation steps in the cmake-gui, I'm trying to execute make in the build directory. The result of the execution is placed below:

blade@MBP-Alex build % make
[ 11%] Automatic MOC and UIC for target agora-tool-ui
[ 11%] Built target agora-tool-ui_autogen
[ 22%] Building CXX object CMakeFiles/agora-tool-ui.dir/agora-tool-ui_autogen/mocs_compilation.cpp.o
In file included from /Users/blade/Development/Investigation/agora-ui-tool/obs-agora-ui-tool/build/agora-tool-ui_autogen/mocs_compilation.cpp:2:
In file included from /Users/blade/Development/Investigation/agora-ui-tool/obs-agora-ui-tool/build/agora-tool-ui_autogen/U3KM7JFWRN/moc_agorartcengine.cpp:10:
/Users/blade/Development/Investigation/agora-ui-tool/obs-agora-ui-tool/build/agora-tool-ui_autogen/U3KM7JFWRN/../../../src/Agora/agorartcengine.hpp:3:10: fatal error: 'QObject' file not found
#include <QObject>
         ^~~~~~~~~
1 error generated.
make[2]: *** [CMakeFiles/agora-tool-ui.dir/agora-tool-ui_autogen/mocs_compilation.cpp.o] Error 1
make[1]: *** [CMakeFiles/agora-tool-ui.dir/all] Error 2
make: *** [all] Error 2

But I believe that Qt5 was installed (via brew). I'm pretty new in Qt so any help will be very appreciate. Please show me the right way to compile the tool. The cmake-gui screenshot is attached.

dev/2.7.1分支已经升级到25，需要自己编译程序包。

请问25版本是依据哪个obs的tag版本创建的？

Crash

hello, Its crashing, .dlls agora and qt for x64 not included in the released installer.

How to add agora plugin in existing OBS in Mac

https://github.com/AgoraIO/OBS/blob/agora-tool-ui-3.3.0/README.md

1. build obs
2. configure in cmake-gui

when starting obs in does not show the agora plugin

Generated successfully, but "Agora Rtc Tool" does not show in the Tool menu. I am started obs from obs-studio/build/rundir/RelWithDebInfo/bin

Am I in the correct way?

How to uninstall this plugin?

I tried this plugin in my OBS, but I want to know how to remove it.
Sorry I did not find any doc to uninstall this plugin, could you please help me?

Build process

I'm not too sure how to build the project. I would like to have executables for my customers and the last version you released was in April of last year. (.exe and .dmg)
I tried to build it myself, but the instructions are far from clear.
Can somebody help me with that? :)
Thanks!