{"id":20268707,"url":"https://github.com/agoraio/obs","last_synced_at":"2025-09-11T23:18:18.816Z","repository":{"id":56603897,"uuid":"140669460","full_name":"AgoraIO/OBS","owner":"AgoraIO","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-05T07:48:57.000Z","size":242611,"stargazers_count":49,"open_issues_count":17,"forks_count":35,"subscribers_count":54,"default_branch":"agora-tool-ui-3.8.200","last_synced_at":"2025-03-31T11:03:05.500Z","etag":null,"topics":["agora","obs"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-12T06:15:54.000Z","updated_at":"2025-02-05T06:38:24.000Z","dependencies_parsed_at":"2025-01-15T22:16:19.670Z","dependency_job_id":"33f0967b-5f02-40d3-a155-7c6da7d8747d","html_url":"https://github.com/AgoraIO/OBS","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FOBS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FOBS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FOBS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2FOBS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO","download_url":"https://codeload.github.com/AgoraIO/OBS/tar.gz/refs/heads/agora-tool-ui-3.8.200","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657281,"owners_count":20974345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agora","obs"],"created_at":"2024-11-14T12:19:37.596Z","updated_at":"2025-04-07T13:08:17.735Z","avatar_url":"https://github.com/AgoraIO.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agora RTC Tool (Windows)\n\n*[中文](README.zh.md)*\n\nAgora RTC Tool for OBS Studio.\n\n## Possible use cases\n\nUsing it for video chat in real time. This plugin is depended agora sdk.\n\nThis pulugin just publishes a selected camera video. \n\nYou can get details about agora sdk from [agora.io](https://www.agora.io/en)\n\n**Running the tool:**\n\n* Register an agora account, you can get an APPID.\n\n* To startup Agora RTC Tool, open the \"Agora RTC Tool\" dialog under OBS' \"Tools\" menu.\n\n* Initialize agora settings including fill appid, channel name and uid, before running the tool first time. \n\n* Then you can start to publish stream to Agora SDK.\n\n* 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.\n\n* 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.\n\n\n## Download Release Setup\n\nYou can install release setup directly corresponding to OBS Stduio version.\n\n\n* [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)\n## Compiling Agora RTC Tool\n\n### Prerequisites\n\n1. Download dependencies\n\n     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.\n\n2. You'll need [Qt 5.14.2](https://github.com/sbd021/Basic-Video-Broadcasting/releases/download/5.14.2/Qt5.14.2.zip),\n[CMake](https://cmake.org/download/) and a working [OBS Studio development environment](https://obsproject.com/wiki/install-instructions) installed on your\ncomputer.\n\n### Windows\n\nIn cmake-gui, you'll have to set the following variables :\n\n* QTDIR (path) : location of the Qt environment suited for your compiler and architecture\n* LIBOBS_INCLUDE_DIR (path) : location of the libobs subfolder in the source code of OBS Studio\n* LIBOBS_LIB (filepath) : location of the libobs project\n* OBS_FRONTEND_LIB (filepath) : location of the obs-frontend-api project \n\nFor example, if the build directory is located in obs-studio src directory, named build64.\n\n* LIBOBS\\_INCLUDE\\_DIR is obs-studio/libobs\n* LIBOBS\\_LIB is obs-studio/build64/libobs, \n* OBS\\_FRONTEND\\_LIB is obs-studio/build64/UI/obs-frontend-api. \n\nAfter configure camke, you get an variable LibObs_DIR, make sure its value is obs-studio/build64/libobs.\n\n\n### Mac\nCompile obs studio first, before you compile agora tool ui plugin. Reference obs studio compile document.\n\nUse cmake-gui, set variable first:\n\n* QTDIR ： Use the right version qt corresponding to conpiler, sucha as /usr/local/Cellar/qt/5.15.2/lib/cmake/Qt5\n* \n* LIBOBS_INCLUDE_DIR : the path libobs in obs studio source code path.\n* LIBOBS_LIB: libobs path\n* OBS_FRONTEND_LIB : obs-frontend-api path, such as:obs-studio/UI/obs-frontend-api\n\nFor example, obs source code path is obs-studio, build path is obs-studio/build64.\n\n* LIBOBS\\_INCLUDE\\_DIR value is obs-studio/build/libobs\n* LIBOBS\\_LIB value is  obs-studio/build/libobs, \n* OBS\\_FRONTEND\\_LIB value is  obs-studio/build/UI/obs-frontend-api. \n\nClick configure on cmake-gui, then you get a variable LibObs_DIR. Make sure the value is obs-studio/build/libobs.\n\n\n## Run RTC Tool\n\n1 Startup obs\n\n2 Select \"Agora Rtc Tool\" in Tool menu.Then pop up a dialog.\n\n3 Click settings, then setup basic information\n\n4 You can also download and fill a configure file, then load the configure file.\n[AgoraObs.zip](https://github.com/AgoraIO/OBS/releases/download/3.3.0/AgoraObs.zip)\n\n5 Configure file include:\n\n* appid\n* token\n* channel name\n* uid\n* rtmp url\n\n\n\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fobs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio%2Fobs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fobs/lists"}