{"id":18536018,"url":"https://github.com/tencent-rtc/obs-trtc","last_synced_at":"2026-01-24T16:36:02.483Z","repository":{"id":174937540,"uuid":"652568069","full_name":"Tencent-RTC/obs-trtc","owner":"Tencent-RTC","description":"Demo for using OBS WHIP to publish a stream to the TRTC(Tencent Real-Time Communication) service.","archived":false,"fork":false,"pushed_at":"2024-05-29T08:28:17.000Z","size":614,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-26T03:25:02.370Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tencent-rtc.github.io/obs-trtc/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tencent-RTC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-06-12T10:38:54.000Z","updated_at":"2024-12-11T08:46:16.000Z","dependencies_parsed_at":"2023-07-10T13:00:51.508Z","dependency_job_id":"e8bfb921-b8c6-4e9d-93e0-6e784239c910","html_url":"https://github.com/Tencent-RTC/obs-trtc","commit_stats":null,"previous_names":["tencent-rtc/obs-trtc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent-RTC%2Fobs-trtc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent-RTC%2Fobs-trtc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent-RTC%2Fobs-trtc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tencent-RTC%2Fobs-trtc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tencent-RTC","download_url":"https://codeload.github.com/Tencent-RTC/obs-trtc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239251041,"owners_count":19607555,"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":[],"created_at":"2024-11-06T19:29:26.287Z","updated_at":"2025-11-01T02:30:31.277Z","avatar_url":"https://github.com/Tencent-RTC.png","language":"HTML","readme":"# OBS-TRTC\n\n[![](https://img.shields.io/twitter/follow/TencentRTC?style=social)](https://twitter.com/TencentRTC)\n[![](https://img.shields.io/badge/TencentRTC-YouTube-red)](https://www.youtube.com/@TencentRTC)\n[![](https://badgen.net/discord/members/vDHty6ddrZ)](https://discord.gg/vDHty6ddrZ)\n\nDemo for using OBS WHIP to publish a stream to the TRTC(Tencent Real-Time Communication) service.\n\n## Overview\n\nOBS includes WHIP support, which allows you to do many interesting things by combining \nthe powers of both OBS and WHIP.\n\nWHIP is a standard protocol that lets you use HTML5 and different clients to publish \nand play live streams. Plus, you can use open-source tools to build your own live \nstreaming platform.\n\nYou can also use [TRTC (Tencent Real-Time Communication)](https://trtc.tencentcloud.com/?utm_source=community\u0026utm_medium=github\u0026utm_campaign=OBS-WHIP-TRTC\u0026_channel_track_key=5pdHDh2F) \ncloud services with OBS WHIP support for a streaming platform. This is a great option \nif you don't want to build your own platform or need a more reliable and stable \nplatform with dedicated support.\n\nAdditionally, TRTC (Tencent Real-Time Communication) provides a free trial that includes \na specific amount of streaming time, making it super easy for you to try out.\n\nIf you need help or run into any problems, don't hesitate to contact us on \n[Discord](https://discord.gg/vDHty6ddrZ).\n\n## Prerequisites\n\nBefore you move forward, double-check that you've got these necessary items ready:\n\n- OBS with WHIP support, please download from [OBS](https://github.com/obsproject/obs-studio/releases/tag/30.0.0)\n- TRTC(Tencent Real-Time Communication) account, please register at [here](https://www.tencentcloud.com/account/login?s_url=https%253A%252F%252Fconsole.tencentcloud.com%252Ftrtc\u0026utm_source=community\u0026utm_medium=github\u0026utm_campaign=OBS-WHIP-TRTC\u0026_channel_track_key=6vGiu0P3)\n\n\u003e Note: Currently, OBS WHIP has been merged into the master branch but has not been released yet. \n\u003e You can login GitHub and download OBS 30+ from [here](https://github.com/obsproject/obs-studio/releases/tag/30.0.0).\n\nNext, you need to create a TRTC application and generate a Bearer Token for WHIP.\n\n## Step 1: Create a TRTC application\n\nPlease follow the steps below to create a TRTC application:\n\n1. Log in to the [TRTC console](https://console.cloud.tencent.com/trtc?utm_source=community\u0026utm_medium=github\u0026utm_campaign=OBS-WHIP-TRTC\u0026_channel_track_key=kgdTyhux) and click **Application Management** on the left sidebar.\n1. Click **Create Application** and enter the application name.\n1. Click **Create** to create the application.\n\n![001](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/dce31494-ac4f-4844-b437-de3d244af678)\n\nAfter the application is created, you can view the SDKAppID and SDKSecretKey on the application details page.\n\n![003](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/f54ad443-645a-4089-8dc7-5a34af48a335)\n\n* SDKAppID: `2000xxxx`\n* SDKSecretKey: `yyyyyy`\n\nFollowing that, you must generate a Bearer Token for WHIP, which will be \nutilized in OBS.\n\n## Step 2: Create a Bearer Token for WHIP\n\nYou can directly visit [https://tencent-rtc.github.io/obs-trtc/bearer.html](https://tencent-rtc.github.io/obs-trtc/bearer.html) \nto create a WHIP Bearer Token. Ensure that use the appid with your own `SDKAppID` and \nsecret with your own `SDKSecretKey`, then click the `Generate Bearer Token` button.\n\n![0031](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/a6df5559-570e-4348-8492-60ffd7aaa2de)\n\n\u003e Note: You can also access the url `https://tencent-rtc.github.io/obs-trtc/bearer.html?appid=2000xxx\u0026secret=yyyyyy` to setup the parameters.\n\nNext, use the generated WHIP Bearer Token to configure OBS.\n\n## Step 3: Configure OBS\n\nIn the `OBS WHIP` section, you will find the generated WHIP `Server` and `Bearer Token` for configuring OBS.\n\n![004](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/29f1ac74-cb3a-4c6e-a3e4-e6c92ea2aab0)\n\nPlease follow the steps below to configure OBS:\n\n1. Open OBS and click **Settings**.\n1. Click **Stream** on the left sidebar.\n1. Select `WHIP` for **Service**.\n1. Make sure to input the `Server` and `Bearer Token` accurately.\n1. Click **OK** to save the settings.\n1. Click **Start Streaming** to start streaming.\n\n![005](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/612ad0f9-9927-4b48-82da-8ac388dece80)\n\nAt this point, the stream is streaming to the TRTC service.\n\n## Step 4: Play the stream\n\nOpen the previous webpage, go to the `WHEP Player` section, \nand click **Play Stream** to play the stream via WHEP.\n\n![006](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/2e727bce-6d2b-47c8-b214-6fc320b1291a)\n\nAnother option is go to the `TRTC Room` section, and click **Join Room** to access the TRTC room \nand watch the stream via TRTC, or you can utilize the TRTC mobile SDK to join the room and view \nthe stream.\n\n![007](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/0a18bd36-e1f3-4070-bc89-95218785cb95)\n\nSince both WHIP and WHEP are standard protocols, you can utilize any client that supmv ports \nthem to play the stream.\n\n## Conclusion\n\nWe looked into using TRTC (Tencent Real-Time Communication) cloud services to make a stronger \nstreaming platform and the steps needed to create a TRTC app with OBS WHIP. These tools make it \neasier to provide real-time live streaming experiences for different situations, with the \npower of OBS.\n\nIf you require assistance or encounter any difficulties, please feel free to reach out\nto us via [Discord](https://discord.gg/vDHty6ddrZ).\n\nIn the future, we will further investigate specific use cases and technologies associated\nwith OBS WHIP and TRTC integration.\n\n## (Optional) Annex A: Deploy the WHIP Bearer Token Server\n\nWe deploy this tool on the server [https://tencent-rtc.github.io/obs-trtc/bearer.html](https://tencent-rtc.github.io/obs-trtc/bearer.html) \nfor your convenience.\n\nAlternatively, you can operate your own server to produce the token by utilizing\nthe following command line to generate a WHIP Bearer Token.\n\n```bash\ngit clone https://github.com/Tencent-RTC/obs-trtc.git\ncd obs-trtc\nopen index.html\n```\n\nThe other steps are the same as the previous section.\n\n## (Optional) Annex B: Configure OBS in Real-Time Mode\n\nIf you want to configur1e OBS in real-time mode, please follow the steps below:\n\n1. Open OBS and click **Settings**.\n1. Click **Output** on the left sidebar.\n1. Select `Advanced` for **Output Mode**.\n1. Set **Keyframe Interval** to `1 s`.\n1. Select `veryfast` for **CPU Usage Preset**.\n1. Select `baseline` for **Profile**.\n1. Select `zerolatency` for **Tune**.\n1. Click **OK** to save the settings.\n\n![009](https://github.com/Tencent-RTC/obs-trtc/assets/2777660/76c36f45-f164-4a78-b3fc-29005cacf6e7)\n\nThe other steps are the same as the previous section.\n\n## (Optional) Annex C: Create a Bearer Token for Real-World Use\n\nIf you need to create a Bearer Token in a real-world setting, check out the \n[UserSig](https://www.tencentcloud.com/document/product/647/35166) link for \nmore information.\n\nIf you require assistance or encounter any difficulties, please feel free to reach out\nto us via [Discord](https://discord.gg/vDHty6ddrZ).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftencent-rtc%2Fobs-trtc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftencent-rtc%2Fobs-trtc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftencent-rtc%2Fobs-trtc/lists"}