Live video on the AT Protocol

Merge pull request #180 from streamplace/natb/update-docs-rtmp

doc: update stream guides for RTMP

authored by

Eli Mallon and committed by
GitHub
7a25b884 67bb56ad

+84 -27
+48 -10
js/docs/src/content/docs/guides/start-streaming/obs-multistreaming.md
··· 1 1 --- 2 - title: OBS Multistreaming 2 + title: OBS Multistreaming with Streamplace 3 3 description: 4 - This guide walks you through configuring OBS (Open Broadcaster Software) for 5 - desktop streaming using Streamplace. 4 + Configure OBS for multistreaming to Streamplace and other platforms using the 5 + obs-multi-rtmp plugin. 6 6 order: 20 7 7 --- 8 8 9 - Simultaneously streaming to Streamplace and other platforms can be easily 10 - accomplished with plugins such as 11 - [obs-multi-rtmp](https://github.com/sorayuki/obs-multi-rtmp). Please note the 12 - following settings to avoid streams with heavily distorted audio: 9 + This guide explains how to configure Open Broadcaster Software (OBS) for 10 + simultaneous streaming to Streamplace and other platforms using the 11 + `obs-multi-rtmp` plugin. 12 + 13 + For basic Streamplace setup with WHIP, including obtaining your stream key or 14 + bearer token, please refer to the main 15 + [Start streaming with OBS](/guides/start-streaming/obs) guide before proceeding 16 + here. 17 + 18 + ### Prerequisites 13 19 14 - - Protocol: WebRTC (WHIP) 15 - - Audio Encoder: FFmpeg Opus 20 + To enable multistreaming, you need to install the `obs-multi-rtmp` plugin for 21 + OBS. 16 22 17 - ![alt text](obs-multistream.jpg "Title") 23 + - Download the latest release from: 24 + [GitHub Releases - obs-multi-rtmp](https://github.com/sorayuki/obs-multi-rtmp/releases) 25 + 26 + Follow the installation instructions provided. 27 + 28 + ### Streamplace Output Configuration in `obs-multi-rtmp` 29 + 30 + When configuring the Streamplace output within the `obs-multi-rtmp` plugin, use 31 + the following recommended settings for optimal compatibility and audio handling 32 + during multistreaming: 33 + 34 + #### Recommended Configuration (WebRTC/WHIP) 35 + 36 + Using **WHIP with `ffmpeg_opus`** is recommended for stability reasons. 37 + 38 + - **Protocol:** WebRTC (WHIP) 39 + - **Server**: https://stream.place 40 + - **Audio Encoder:** `ffmpeg_opus` 41 + 42 + #### Alternative Configuration (RTMP) 43 + 44 + Streamplace also supports RTMP via this plugin. This configuration may be 45 + suitable if you are also multistreaming to platforms like Twitch that primarily 46 + use RTMP to avoid an audio re-encode. 47 + 48 + - **Protocol:** RTMP 49 + - **Server**: rtmps://stream.place:1935/live 50 + - **Audio Encoder:** _(Select an AAC encoder)_ 51 + 52 + The image below illustrates where to configure these settings within the 53 + `obs-multi-rtmp` plugin interface in OBS. 54 + 55 + ![Multistreaming settings in OBS using obs-multi-rtmp plugin.](obs-multistream.jpg "OBS Multistreaming Settings")
+36 -17
js/docs/src/content/docs/guides/start-streaming/obs.md
··· 15 15 16 16 ## Basic Setup Instructions 17 17 18 - ### 1. Initial OBS Configuration 19 - 20 - 1. Launch OBS Studio 21 - 2. Navigate to Settings > Stream 22 - 23 - ### 2. Stream.place Authentication 18 + ### 1. Get your Stream Key from Streamplace 24 19 25 20 1. Open your web browser 26 21 2. [Visit Streamplace](https://stream.place) and log in to your account 27 22 3. Navigate to the Live Dashboard 28 23 4. Click "Stream from OBS" 29 - 5. Under Bearer Token, click "Generate Stream Key" 30 - - The stream key will automatically copy to your clipboard 24 + 5. Select either `WHIP` (preferred) or `RTMP`. 25 + 6. Click "Generate Stream Key" 26 + - The stream key will automatically be copied to your clipboard 27 + 28 + ### 2. Configure OBS Studio 29 + 30 + #### 2a. Initial OBS Configuration 31 + 32 + 1. Launch OBS Studio 33 + 2. Navigate to Settings > Stream 31 34 32 - ### 3. OBS Stream Settings 35 + #### 2b. Stream Settings 33 36 34 37 1. Return to OBS Settings > Stream 35 38 2. Configure the following: 36 - - Service: `WHIP` 37 - - Server: `https://stream.place` 38 - - Bearer Token: _Paste your copied stream key_ 39 + - Service: 40 + - If using `WHIP`, select `WHIP`. 41 + - If using `RTMP`, select `Custom...`. 42 + - Server: 43 + - If using `WHIP`: `https://stream.place` 44 + - If using `RTMP`: `rtmps://stream.place:1935/live` 45 + - Bearer Token (for WHIP) or Stream Key (for RTMP): _Paste your copied stream 46 + key_ 39 47 40 - ### 4. Output Configuration 48 + #### 2c. Output Configuration 41 49 42 50 1. Go to OBS Settings > Output 43 51 2. Configure these settings: 44 52 - Output Mode: Select "Advanced" from dropdown 45 53 - Navigate to Streaming Tab 46 54 47 - #### Streaming Settings 55 + #### 2d. Streaming Settings 48 56 49 - - Audio Encoder: _(Select appropriate encoder, e.g. AAC)_ 57 + - Audio Encoder: 58 + - For `WHIP`, use `ffmpeg_opus`. 59 + - For `RTMP`, choose an appropriate AAC encoder. 50 60 - Video Encoder: _(Select appropriate encoder, e.g. libx264/nvenc_h264)_ 51 61 52 - #### Suggested Encoder Settings 62 + #### 2e. Suggested Video Encoder Settings 53 63 54 64 - Rate Control: `CBR` 55 65 - Keyframe Interval: `1s` 56 66 - x264 Options: `bframes=0` 67 + - If available, there also may be a 'no bframes' checkbox which should be 68 + checked 69 + 70 + ### 3. Announce your stream 71 + 72 + 1. Once you're live, go back to the live dashboard. 73 + 2. There, you can fill out your stream title and choose an optional thumbnail. 74 + 3. Click 'Announce Livestream' to announce your livestream to the world! 57 75 58 76 ## Multi-Streaming Support 59 77 ··· 62 80 1. **OBS Resources - Multiple RTMP Outputs** 63 81 64 82 - [GitHub Releases - obs-multi-rtmp](https://github.com/sorayuki/obs-multi-rtmp/releases) 83 + - [OBS Multistreaming Guide](guides/obs-multistreaming) 65 84 66 85 2. [**Aitum Multistream Plugin**](https://aitum.tv/products/multi) 67 86 ··· 69 88 70 89 - Test your stream settings before going live 71 90 - Monitor your stream health during broadcasts 91 + - If you see lots of dropped frames, lower your bitrate. 72 92 - Ensure stable internet connection 73 93 - Keep your OBS software updated 74 94 75 95 ## Additional Resources 76 96 77 97 - [OBS Official Documentation](https://obsproject.com/docs/) 78 - - [Stream.place Documentation](https://stream.place/docs/)