diff --git a/documentation/streaming-platform/about-gcore-streaming-platform.md b/documentation/streaming-platform/about-gcore-streaming-platform.md index 84ddb82e0..98bbdad24 100644 --- a/documentation/streaming-platform/about-gcore-streaming-platform.md +++ b/documentation/streaming-platform/about-gcore-streaming-platform.md @@ -33,7 +33,7 @@ The formats and specifications supported by the Video Streaming are described in When you stream via the Video Streaming, there are two ways to send us the stream: PUSH and PULL. - To use PULL, you need a server with a stream in RTMP (or other) format. The stream is sent to our servers, which convert it into HLS. -- Use PUSH if you stream directly from your computer, camera, or any other device using third-party software. In this case, there is a unique key in the Gcore Customer Portal that you insert into your program, and the stream is sent to us. The Video Streaming converts it into HLS and sends it to end-users. +- Use PUSH if you stream directly from your computer, camera, or any other device using third-party software. In this case, there is a unique key in the Gcore Customer Portal that you insert into your program, and the stream is sent to us. The Video Streaming converts it into HLS and sends it to end-users. We can receive SRT streams in either PULL or PUSH format. To send us PULL-SRT, just specify a link in the required protocol in the URL field. If you want to get a PUSH link to send SRT streams to us, write to support via [support@gcore.com](mailto:support@gcore.com) or your manager. We will set up an SRT-PUSH link on your account. diff --git a/documentation/streaming-platform/live-streaming/broadcasting-software/ffmpeg.md b/documentation/streaming-platform/live-streaming/broadcasting-software/ffmpeg.md new file mode 100644 index 000000000..3698ad84f --- /dev/null +++ b/documentation/streaming-platform/live-streaming/broadcasting-software/ffmpeg.md @@ -0,0 +1,68 @@ +--- +title: ffmpeg +displayName: FFmpeg +published: true +order: 10 +pageTitle: Live Stream Setup with FFmpeg | Gcore +pageDescription: A step-by-step guide to pushing live streams via FFmpeg. +--- + +# FFmpeg + +FFmpeg is a free and open-source command line tool for video recording, screencasting, and live streaming. It’s suitable for video game streaming, blogging, educational content, and more. + +FFmpeg links your device (e.g, a laptop or a PC) to different streaming platforms (e.g.,Gcore Video Streaming, YouTube, Twitch, etc.). It takes an image captured by a camera, converts it into a video stream, and then sends it to the streaming platform. + +## Setup + +1\. Install FFmpeg on your device. Follow the download instructions on the official website. + +2\. To get the server URL and stream key, go to the Streaming list, open the **Live stream settings** you need, and copy the relevant value from the **URLs for the encoder** section. + +For example, if you see these values on the **Live stream settings** page: + +Live stream settings + +Concatenate them to form the full RTMP URL for the stream: + + rtmp://vp-push-ix1.gvideo.co/in/400448?cdf2a7ccf990e464c2b… + +3\. Open the command line interface (CLI) on your device and run the following command: + + ffmpeg -f {input format params} -f flv {RTMP URL} + +## Configure the stream parameters for optimal performance + +To ensure optimal streaming performance, we recommend configuring the stream parameters you will send to our server. You can adjust these settings via the CLI parameters of FFmpeg. + +Example of a command line for streaming via FFmpeg with the recommended parameters: + + ffmpeg -f {input format params} \ + -c:v libx264 -preset veryfast -b:v 2000000 \ + -profile:v baseline -vf format=yuv420p \ + -crf 23 -g 60 \ + -b:a 128k -ar 44100 -ac 2 \ + -f flv {RTMP URL} + +### Output parameters + +- **Video Bitrate:** To stream at 720p resolution, set the bitrate to 2000Kbps (`-b:v 2000000`). If you’re broadcasting at 1080p, set the bitrate to 4000Kbps (`-b:v 4000000`). +- **Audio Bitrate:** 128 (`-b:a 128k`). +- **Encoder:** Software (`-c:v libx264`), or any other H264 codec. +- **Rate control:** CRF (`-crf 23`) +- **Keyframe Interval:** 2s (`-g 60`). +- **CPU Usage Preset:** veryfast (`-preset veryfast`). +- **Profile:** baseline (`-profile:v baseline -vf format=yuv420p`) + +### Audio parameters + +- **Sample Rate**: 44.1 kHz (`-ar 44100`) or 48 kHz (`-ar 48000`). +- Use **Stereo** for the best sound quality (`-ac 2`). + +### Video parameters + +If you need to reduce the original resolution (downscale), follow the instructions in this section. If no resolution change is required, you can skip this step. + +- **Output (Scaled) Resolution:** 1280×720 +- **Downscale Filter:** Bicubic +- **Common FPS Values:** 30 diff --git a/documentation/streaming-platform/live-streaming/broadcasting-software/larix.md b/documentation/streaming-platform/live-streaming/broadcasting-software/larix.md new file mode 100644 index 000000000..36a3c7f7a --- /dev/null +++ b/documentation/streaming-platform/live-streaming/broadcasting-software/larix.md @@ -0,0 +1,69 @@ +--- +title: larix +displayName: Larix (Android/iOS) +published: true +order: 20 +pageTitle: Live Stream Setup with Larix | Gcore +pageDescription: A step-by-step guide to pushing live streams via Larix. +--- + +# Larix + +Larix is a free encoder for video recording, screencasting, and live streaming. It’s suitable for video game streaming, blogging, educational content, and more. + +Larix links your mobile device (e.g., a smartphone or a tablet) to different streaming platforms (e.g., Gcore Video Streaming, YouTube, Twitch, etc.). It takes an image captured by a camera, converts it into a video stream, and then sends it to the streaming platform. + +## Setup + +1\. Install Larix on your mobile device. You find the download instructions on the official website. + +2\. To get the server URL and stream key, go to the Streaming list, open the **Live stream settings** you need, and copy the relevant value from the **URLs for the encoder** section. + +For example, if you see these values on the **Live stream settings** page: + +Live stream settings + +Concatenate them to form the full RTMP URL for the stream: + + rtmp://vp-push-ix1.gvideo.co/in/400448?cdf2a7ccf990e464c2b… + +3\. Open Larix Grove, where you can create the configuration for the Larix app that you can share via QR code. +4\. In Larix Grove, scroll down to the **Connection** section. +5\. Enter the RTMP URL and a name for your connection. +6\. Click the QR-Code button to generate a QR code. You can scan this code with the Larix app on your mobile device to automatically configure the connection. +7\. Open the Larix app on your mobile device and tap the gear icon to open the settings. +8\. Tap **Larix Grove** and then tap **Scan Grove QR code**. +9\. Scan the QR code you generated in Larix Grove. The app will automatically configure the connection. +10\. Go back to the main screen of the Larix app and tap the big white button to start streaming. + +## Configure the stream parameters for optimal performance + +To ensure optimal streaming performance, we recommend configuring the stream parameters you will send to our server. + +You can adjust these settings with Larix Grove, where the configuration together with the connection URL is generated as a QR code. This allows you to easily share the configuration with team members. + +After you changed the settings, click the **QR-Code** button to generate a new QR code for sharing. + +Larix Grove + +### Camera parameters + +If you need to reduce the original resolution (downscale), follow the instructions in this section. + +If you need to increase the FPS to 60, make sure to also increase the bitrate accordingly for optimal stream quality (i.e., double it). + +If no resolution change is required, you can skip this step. + +- **Resolution:** 1280×720 +- **Frame rate:** 30 + +### Video encoder parameters + +- **Video Bitrate:** 2000000 for 720p resolution or 4000000 for 1080p resolution. +- **Keyframe Interval:** 60 (i.e., 2 seconds) + +### Audio encoder parameters + +- **Audio Bitrate:** 128000 +- **Sample Rate**: 44100 or 48000 +- **Channels**: 2 diff --git a/documentation/streaming-platform/live-streaming/broadcasting-software/metadata.md b/documentation/streaming-platform/live-streaming/broadcasting-software/metadata.md new file mode 100644 index 000000000..e69de29bb diff --git a/documentation/streaming-platform/live-streaming/push-live-streams-software/push-live-streams-via-obs.md b/documentation/streaming-platform/live-streaming/broadcasting-software/obs.md similarity index 79% rename from documentation/streaming-platform/live-streaming/push-live-streams-software/push-live-streams-via-obs.md rename to documentation/streaming-platform/live-streaming/broadcasting-software/obs.md index 3cdeaa4c6..a41cb9476 100644 --- a/documentation/streaming-platform/live-streaming/push-live-streams-software/push-live-streams-via-obs.md +++ b/documentation/streaming-platform/live-streaming/broadcasting-software/obs.md @@ -1,27 +1,19 @@ --- -title: push-live-streams-via-obs -displayName: OBS (Open Broadcaster Software) +title: obs +displayName: OBS published: true -order: 10 -toc: - --1--What is an OBS?: "what-is-an-obs" - --1--Configure: "configure-the-obs-encoder-for-gcore-streaming" - --1--Manage the stream: "manage-the-stream-parameters" - --2--Output: "output-parameters" - --2--Audio: "audio-parameters" - --2--Video: "video-parameters" +order: 30 pageTitle: Live Stream Setup with OBS | Gcore pageDescription: A step-by-step guide to pushing live streams via Open Broadcaster Software (OBS). --- -# Push live streams via OBS -## What is an OBS? +# Open Broadcaster Software Open Broadcaster Software (OBS) is a free and open-source encoder for video recording, screencasting, and live streaming. It’s suitable for video game streaming, blogging, educational content, and more. OBS links your device (a laptop or a PC) and different streaming platforms (Gcore Video Streaming, YouTube, Twitch, etc.). It takes an image captured by a camera, converts it into a video stream, and then sends it to the streaming platform. -## Configure the OBS encoder for Gcore Streaming +## Setup 1\. Download Open Broadcaster Software (OBS) from the official website and install it. @@ -39,8 +31,8 @@ For example, if you see these values on the Live stream settings page: paste them to the OBS Settings as follows: -- *rtmp://vp-push-ix1.gvideo.co/in/* is the Server; -- *400448?cdf2a7ccf990e464c2b…* is the Stream Key. +- _rtmp://vp-push-ix1.gvideo.co/in/_ is the Server; +- _400448?cdf2a7ccf990e464c2b…_ is the Stream Key. 5\. Click the **Apply** button to save the new configuration. @@ -54,7 +46,7 @@ paste them to the OBS Settings as follows: That’s it. The stream from OBS will be broadcast to your website. -## Manage the stream parameters +## Configure the stream parameters for optimal performance To ensure optimal streaming performance, we recommend configuring the stream parameters you will send to our server. You can adjust these settings in the Output, Audio, and Video tabs within OBS. @@ -64,9 +56,9 @@ To ensure optimal streaming performance, we recommend configuring the stream par 2\. Set the parameters as follows: -- **Video Bitrate:** The resolution of your stream determines the required bitrate: The higher the resolution, the higher the bitrate. To stream at 720p resolution, set the bitrate to 2000Kbps. If you’re broadcasting at 1080p, set the bitrate to 4000Kbps. -- **Audio Bitrate:** 128. -- **Encoder:** Software (x264), or any other H264 codec. +- **Video Bitrate:** The resolution of your stream determines the required bitrate: The higher the resolution, the higher the bitrate. To stream at 720p resolution, set the bitrate to 2000Kbps. If you’re broadcasting at 1080p, set the bitrate to 4000Kbps. +- **Audio Bitrate:** 128. +- **Encoder:** Software (x264), or any other H264 codec. Manage the stream parameters @@ -74,10 +66,10 @@ To ensure optimal streaming performance, we recommend configuring the stream par 4\. Set the parameters as follows: -- **Rate control:** CRF (the default value is 23) -- **Keyframe Interval (0=auto):** 2s -- **CPU Usage Preset:** veryfast -- **Profile:** baseline +- **Rate control:** CRF (the default value is 23) +- **Keyframe Interval (0=auto):** 2s +- **CPU Usage Preset:** veryfast +- **Profile:** baseline 5\. Click **Apply** to save the configuration. @@ -101,9 +93,9 @@ If you need to reduce the original resolution (downscale), follow the instructio 2\. Set the following parameters: -- **Output (Scaled) Resolution:** 1280×720 -- **Downscale Filter:** Bicubic -- **Common FPS Values:** 30 +- **Output (Scaled) Resolution:** 1280×720 +- **Downscale Filter:** Bicubic +- **Common FPS Values:** 30 3\. Click **Apply**. diff --git a/documentation/streaming-platform/live-streaming/create-a-live-stream.md b/documentation/streaming-platform/live-streaming/create-a-live-stream.md index 7961f5233..2c740925c 100644 --- a/documentation/streaming-platform/live-streaming/create-a-live-stream.md +++ b/documentation/streaming-platform/live-streaming/create-a-live-stream.md @@ -4,24 +4,22 @@ displayName: Create a live stream published: true order: 10 toc: - --1--1. Initiate process: "initiate-the-process" - --1--2. Set type and features: "step-2-set-the-stream-type-and-additional-features" - --1--3. Configure push, pull, or WebRTC to HLSl: "step-3-configure-your-stream-for-push-pull-or-webrtc-to-hls" - --2--Push ingest type: "push-ingest-type" - --2--Pull ingest type : "pull-ingest-type" - --2--WebRTC to HLS ingest type: "webrtc-to-hls-ingest-type" - --1--4. Start stream: "step-4-start-the-stream" - --1--5. Embed to app: "step-5-embed-the-stream-to-your-app" + --1--1. Initiate process: 'initiate-the-process' + --1--2. Set type and features: 'step-2-set-the-stream-type-and-additional-features' + --1--3. Configure ingest type and additional features: 'step-3-configure-ingest-type-and-additional-features' + --1--4. Start stream: 'step-4-start-the-stream' + --1--5. Embed to app: 'step-5-embed-the-stream-to-your-app' pageTitle: Guide to Creating Live Streams | Gcore pageDescription: A step-by-step tutorial on how to create live streams using Gcore's interface. Learn about stream types, encoder settings, and embedding options. --- + # Create a live stream ## Step 1. Initiate the process -1\. In the Gcore Customer Portal, navigate to Streaming > **Live Streaming**. +1\. In the **Gcore Customer Portal**, navigate to **Streaming** > **Live Streaming**. -2\. Click **Create Live stream**. +2\. Click the **Create Live stream** button on the top right. Live stream button on the life streaming page @@ -31,13 +29,13 @@ If the button is non-responsive, you have exceeded your live stream limit. To cr -2\. Enter the name of your live stream in the window that appears and click **Create**. +2\. Enter the name of your live stream in the window that appears and click the **Create** button. Enter the name of your live stream -A new page will appear. Perform the remaining steps there. +A new page will appear. Perform the remaining steps there. -## Step 2. Set the stream type and additional features +## Step 2. Set the ingest type and additional features Live stream page @@ -49,92 +47,38 @@ By default, we offer live streams with low latency (a 4–5 second delay.) Low l -2\. (Optional) Review the live stream name and update it if needed. - -3\. Enable additional features If you activated them previously: - -* Record for live stream recording. It will be active when you start streaming. Remember to enable the toggle if you require a record of your stream. -* DVR for an improved user experience. When the DVR feature is enabled, your viewers can pause and rewind the broadcast. - -4\. Select the relevant stream type: **Push**, **Pull**, or **WebRTC => HLS**. - -* Choose **Push** if you don't use your own media server. Establish the URL of our server and the unique stream key in your encoder (e.g. OBS, Streamlabs, vMix, or LiveU Solo). You can use protocols RTMP, RTMPS, and SRT too. The live stream will operate on our server, will be converted to MPEG-DASH and HLS protocols, and will be distributed to end users via our CDN. - -* Choose **Pull** if you have a streaming media server. The live stream will operate on your server. Our server will convert it from the RTMP, RTMPS, SRT, or other protocols to MPEG-DASH and HLS protocols. Then, our CDN will distribute the original live stream in the new format to end users. - -* Choose **WebRTC => HLS** if you want to convert your live video stream from WebRTC to HLS (HTTP Live Streaming) and DASH (Dynamic Adaptive Streaming over HTTP) formats. - -## Step 3. Configure your stream for push, pull, or WebRTC to HLS - -### Push ingest type - -1\. Select the protocol for your stream: **RTMP**, **RTMPS**, or **SRT**. The main difference between these protocols is their security levels and ability to handle packet loss. - -- RTMP is the standard open-source protocol for live broadcasting over the internet. It supports low latency. -- RTMPS is a variation of RTMP that incorporates SSL usage. -- SRT is a protocol designed to transmit data reliably with protection against packet loss. - -URLs for encoder configuration - -2\. Copy the relevant data to insert into your encoder. - - - -Insert the following values: - -- **Server (URL)** is the target server where your encoder will relay the broadcast; e.g., ```rtmp://vp-push-ed1.gvideo.co/in/ ```. -- **Stream key** is the unique identifier of the created live stream. - - - - - -Copy the Push URL SRT. It contains the server URL, port, stream ID (internal for Gcore,) and stream key. For example: - -``` -srt://vp-push-ed1-srt.gvideo.co:5001?streamid=000000#12ab345c678901d… -``` - -SRT configuration - - - - - -We provide backup links, which you can specify in the encoder interface. In case of inaccessibility and overloading of your primary server, the stream will be minimally interrupted and will continue automatically from the backup server. - - - -### Pull ingest type - -In the **URL** field, insert a link to the stream from your media server. Check the full list of supported protocols in our Input parameters guide. +2\. Review the live stream name and update it if needed. -Live streaming section +3\. Enable additional features: - +- Record for live stream recording. It will be active when you start streaming. Remember to enable the toggle if you require a record of your stream. +- DVR for an improved user experience. When the DVR feature is enabled, your viewers can pause and rewind the broadcast. -You can specify multiple media servers separated by space in the URL field. +4\. Select the relevant **Ingest type**: **Push** or **Pull**. -In this case, the first media server will be the primary source, and the subsequent ones will serve as backup servers. If the signal from the first source fails, we will automatically continue the stream from the second source. For example: `rtmps://main-server/live1 rtmp://backup-server/live1 rtmp://backup-server/live2`. +- Choose **Push** if you don't use your own media server. Establish the URL of our server and the unique stream key in your encoder (e.g. OBS, Streamlabs, vMix, or LiveU Solo). You can use protocols RTMP, RTMPS, and SRT too. The live stream will operate on our server, will be converted to MPEG-DASH and HLS protocols, and will be distributed to end users via our CDN. - +- Choose **Pull** if you have a streaming media server. The live stream will operate on your server. Our server will convert it from the RTMP, RTMPS, SRT, or other protocols to MPEG-DASH and HLS protocols. Then, our CDN will distribute the original live stream in the new format to end users. -### WebRTC to HLS ingest type +## Step 3. Configure your stream -Insert the link from the WHIP URL field to any library or tool that supports WHIP (WebRTC-HTTP Ingestion Protocol). This will convert your stream into HLS format. +Depending on the selcected ingest type and protocol, your settings will differ. Refer to specific +protocol pages for more details: -WebRTC to HLS settings +- RTMP/RTMPS +- SRT +- WebRTC to HLS ## Step 4. Start the stream -Start a live stream on your media server or encoder. You will see a streaming preview on the Gcore Live Stream Settings page if everything is configured correctly. +Start a live stream on your media server or encoder. You will see a streaming preview on the **Live Stream Settings** page if everything is configured correctly. ## Step 5. Embed the stream to your app Embed the created live stream into your web app by one of the following methods: -- Copy the iframe code to embed the live stream within the Gcore built-in player. -- Copy the export link in a suitable protocol and paste it into your player. Use the **LL-DASH** link if your live stream will be viewed from any device except iOS. Use **LL HLS** for iOS viewing. +- Copy the iframe code to embed the live stream within the Gcore built-in player. +- Copy the export link in a suitable protocol and paste it into your player. Use the **LL-DASH** link if your live stream will be viewed from any device except iOS. Use **LL HLS** for iOS viewing. Links for embeding them to the app @@ -142,6 +86,6 @@ That’s it. Your viewers can see the live stream. -We only support statistic data collection for Gcore players. If you use your own, non-Gcore player, the statistics page will be empty. Independent of the player, you can view monitoring metrics for performance analysis and troubleshooting. +We only support statistic data collection for Gcore players. If you use your own, non-Gcore player, the statistics page will be empty. Independent of the player, you can view monitoring metrics for performance analysis and troubleshooting. - \ No newline at end of file + diff --git a/documentation/streaming-platform/live-streams-and-videos-protocols-and-codecs/how-low-latency-streaming-works.md b/documentation/streaming-platform/live-streaming/how-low-latency-streaming-works.md similarity index 73% rename from documentation/streaming-platform/live-streams-and-videos-protocols-and-codecs/how-low-latency-streaming-works.md rename to documentation/streaming-platform/live-streaming/how-low-latency-streaming-works.md index 9bcb6cdf9..aed2063b4 100644 --- a/documentation/streaming-platform/live-streams-and-videos-protocols-and-codecs/how-low-latency-streaming-works.md +++ b/documentation/streaming-platform/live-streaming/how-low-latency-streaming-works.md @@ -2,24 +2,25 @@ title: how-low-latency-streaming-works displayName: Low Latency streaming published: true -order: 40 +order: 45 toc: - --1--How Gcore provides low Latency: "how-does-gcore-provide-low-latency" - --1--How LL-HLS and LL-DASH work: "how-do-ll-hls-and-ll-dash-work-in-comparison-to-the-standard-approach" - --1--Use Low Latency streaming: "use-low-latency-streaming" - --1--Switch to legacy HLS modes: "switch-to-legacy-hls-modes" -pageTitle: Understanding Low Latency Streaming | Gcore + --1--How Gcore provides low Latency: 'how-does-gcore-provide-low-latency' + --1--How LL-HLS and LL-DASH work: 'how-do-ll-hls-and-ll-dash-work-in-comparison-to-the-standard-approach' + --1--Use Low Latency streaming: 'use-low-latency-streaming' + --1--Switch to legacy HLS modes: 'switch-to-legacy-hls-modes' +pageTitle: Understanding Low Latency Streaming | Gcore pageDescription: A guide explains streaming latency, how Gcore reduces it with LL-HLS and LL-DASH protocols, and how to use them. --- + # How Low Latency streaming works Streaming latency is the timespan between the moment a frame is captured and when that frame is displayed on the viewers' screens. Latency occurs because each stream is processed several times during broadcasting to be delivered worldwide: -1\. **Encoding (or packaging).** In this step, the streaming service retrieves your stream in any format, converts it into the format for delivery through CDN, and divides it into small fragments. +1\. **Encoding (or packaging).** In this step, the streaming service retrieves your stream in any format, converts it into the format for delivery through CDN, and divides it into small fragments. -2\. **Transferring.** In this step, CDN servers pull the processed stream, cache it, and send it to the end-users. +2\. **Transferring.** In this step, CDN servers pull the processed stream, cache it, and send it to the end-users. -3\. **Receipt by players.** In this step, end-user players load the fragments and buffer them. +3\. **Receipt by players.** In this step, end-user players load the fragments and buffer them. Each step affects latency, so the total timespan can increase to 30–40 seconds, especially if the streaming processing isn't optimized. For some companies (such as sports or metaverse events, or news releases), such latency is too large, and it's crucial to reduce it. @@ -27,8 +28,8 @@ Each step affects latency, so the total timespan can increase to 30–40 seconds The Gcore Video Streaming receives live streams in RTMP or SRT protocols; transcodes to ABR (adaptive bitrate), via CDN in LL-HLS and LL-DASH protocols. -- LL-HLS (Low Latency HTTP Live Streaming) is an adaptive protocol developed by Apple for live streaming via the Internet. This protocol is based on HTTP, which allows it to be cached on CDN servers and distributed via CDN as static content.  -- LL-DASH (Low Latency Dynamic Adaptive Streaming over HTTP) is a data streaming technology that optimizes media content delivery via the HTTP protocol. +- LL-HLS (Low Latency HTTP Live Streaming) is an adaptive protocol developed by Apple for live streaming via the Internet. This protocol is based on HTTP, which allows it to be cached on CDN servers and distributed via CDN as static content. +- LL-DASH (Low Latency Dynamic Adaptive Streaming over HTTP) is a data streaming technology that optimizes media content delivery via the HTTP protocol. Also, Gcore uses CMAF (Common Media Application Format) as a base for LL-HLS/DASH. CMAF allows dividing segments into chunks (video fragments) for faster delivery over HTTP networks. @@ -38,7 +39,7 @@ LL-HLS and LL-DASH reduce latency to 2–4 sec, depending on the network conditi ## How do LL-HLS and LL-DASH work in comparison to the standard approach? -The standard video delivery approach involves sending the entirely created segment to the CDN. Once the CDN receives the complete segment, it transmits it to the player. +The standard video delivery approach involves sending the entirely created segment to the CDN. Once the CDN receives the complete segment, it transmits it to the player. With this approach, video latency depends on segment length. For example, if a segment is 6 seconds long when requesting and processing the first segment, the player displays a frame that is already 6 seconds late compared to the actual time. @@ -54,30 +55,30 @@ Compared to the standard approach, a 6-second segment will be divided into 0.5-2 We support Low Latency streaming by default. It means your live streams are automatically transcoded to LL-HLS or LL-DASH protocol when you create and configure a live stream. -Links for embedding the live stream to your own player contain the */cmaf/* part and look as follows: +Links for embedding the live stream to your own player contain the _/cmaf/_ part and look as follows: -* MPEG-DASH, CMAF (low latency): `https://demo.gvideo.io/cmaf/2675_19146/index.mpd` -* LL HLS, CMAF (low latency): `https://demo.gvideo.io/cmaf/2675_19146/master.m3u8` -* Traditional HLS, MPEG TS (no low latency): `https://demo.gvideo.io/mpegts/2675_19146/master_mpegts.m3u8` +- MPEG-DASH, CMAF (low latency): `https://demo.gvideo.io/cmaf/2675_19146/index.mpd` +- LL HLS, CMAF (low latency): `https://demo.gvideo.io/cmaf/2675_19146/master.m3u8` +- Traditional HLS, MPEG TS (no low latency): `https://demo.gvideo.io/mpegts/2675_19146/master_mpegts.m3u8` ## Switch to legacy HLS modes -Some legacy devices or software require MPEG-TS (.ts) segments for streaming. To ensure full backward compatibility with HLS across all devices and infrastructures, we offer MPEG-TS streaming options. +Some legacy devices or software require MPEG-TS (.ts) segments for streaming. To ensure full backward compatibility with HLS across all devices and infrastructures, we offer MPEG-TS streaming options. -We produce low-latency and non-low-latency streams in parallel, so you don't have to create a stream specifically for cases when the connection is unstable or a device doesn’t support low-latency. Both formats share the same segment sizes, manifest lengths for DVR functionality, and other related capabilities. +We produce low-latency and non-low-latency streams in parallel, so you don't have to create a stream specifically for cases when the connection is unstable or a device doesn’t support low-latency. Both formats share the same segment sizes, manifest lengths for DVR functionality, and other related capabilities. -For modern devices, we recommend using the HLS manifest URL (`hls_cmaf_url`). It’s more efficient and is highly compatible with streaming devices. +For modern devices, we recommend using the HLS manifest URL (`hls_cmaf_url`). It’s more efficient and is highly compatible with streaming devices. -You can get the non-low-latency in the same Links for export section in the Customer Portal: +You can get the non-low-latency in the same Links for export section in the Customer Portal: -1\. On the Video Streaming page, find the needed video. +1\. On the Video Streaming page, find the needed video. -2\. In the **Links for export** section, copy the link in the **HLS non-low-latency manifest URL** field. This link contains non low-latency HLSv3 and MPEG TS files as chunks. +2\. In the **Links for export** section, copy the link in the **HLS non-low-latency manifest URL** field. This link contains non low-latency HLSv3 and MPEG TS files as chunks. HLS non-low-latency link example -For details on how to get the streams via API, check our API documentation. +For details on how to get the streams via API, check our API documentation. diff --git a/documentation/streaming-platform/live-streaming/protocols/metadata.md b/documentation/streaming-platform/live-streaming/protocols/metadata.md new file mode 100644 index 000000000..9f91844ee --- /dev/null +++ b/documentation/streaming-platform/live-streaming/protocols/metadata.md @@ -0,0 +1,6 @@ +--- +title: metadata +displayName: Protocols +published: true +order: 15 +--- diff --git a/documentation/streaming-platform/live-streaming/protocols/rtmp.md b/documentation/streaming-platform/live-streaming/protocols/rtmp.md new file mode 100644 index 000000000..4ef7827d2 --- /dev/null +++ b/documentation/streaming-platform/live-streaming/protocols/rtmp.md @@ -0,0 +1,120 @@ +--- +title: rtmp-rtmps +displayName: RTMP +published: true +order: 10 +pageTitle: Guide to RTMP ingest | Gcore +pageDescription: A step-by-step tutorial on how to create and stop live streams using Gcore's interface or customer's environment. +--- + +# The Real Time Messaging Protocol + +The Real Time Messaging Protocol (RTMP) is the most common way to stream to video streaming platforms. Gcore Live Streaming supports both RTMP and RTMPS. + + + +RTMP is limited to the H264 codec only. If you want to use other codecs, please use SRT instead. + +We're planning to support H265/HVEC and other extensions from the Enhanced RTMP specification. Stay tuned for updates. + + + +## Push streams + +Gcore Video Streaming provides you with two endpoints for pushing a stream, a default one and a backup one. The default endpoint is the one that is closest to your location. The backup endpoint is in a different location and used if the default one is unavailable. + +By default, Gcore will route your stream to free ingest points with the lowest latency. If you need to set a fixed ingest point or if you need to set the main and backup ingest points in the same region (i.e., to not send streams outside the EU or US), please contact our support team. + +### Obtain the server URLs and stream key + +There are two ways to obtain the server URLs and stream key: via the Gcore Customer Portal or via the API. + +#### Via the Gcore Customer Portal + +1\. In the **Gcore Customer Portal**, navigate to **Streaming** > **Live Streaming**. + +List of live streams + +2\. Click on the stream you want to push to. This will open the **Live Stream Settings**. + +Live stream settings + +3\. Ensure that the **Ingest type** is set to **Push**. +4\. Ensure that the protocol is set to **RTMP** or **RTMPS** in the **URLs for encoder** section. +5\. Copy the **Server** URL and **Stream Key** from the **URLs for encoder** section. + +URLs for encoder section + +#### Via the API + +You can also obtain the URL and stream key via the Gcore API. They endpoint returns the complete URLs for the default and backup ingest points, as well as the stream key. + +Example of the API request: + +```http +GET /streaming/streams/{stream_id} +``` + +Example of the API response: + +```json +{ + "push_url": "rtmp://vp-push-anx2.domain.com/in/123?08cd54f0", + "backup_push_url": "rtmp://vp-push-ed1.domain.com/in/123b?08cd54f0", + ... +} +``` + +Read more in the API documentation. + +## Pull streams + +Gcore Video Streaming can pull video data from your external server. + +Main rules of pulling: + +- The URL of the stream to pull from must be **publicly available** and **return a 200 status** for all requests. +- You can specify **multiple media servers** (separated with space characters) in the **URL** input field. The maximum length of all URLs is 255 characters and the round robin is used when polling the list of specified servers. +- If a stream is closed (i.e., its connection is terminated) or there is no video data in the stream for 30 seconds, then the next attempt will be made in the next steps progressively (10s, 30s, 60s, 5min, 10min). +- The stream will be deactivated after 24 hours of inactivity. +- If you need to set an allowlist for access to the stream, please contact support to get an up-to-date list of networks. + +### Setting up a pull stream + +There are two ways to set up a pull stream: via the Gcore Customer Portal or via the API. + +#### Via the Gcore Customer Portal + +1\. In the **Gcore Customer Portal**, navigate to **Streaming** > **Live Streaming**. + +List of live streams + +2\. Click on the stream you want to pull from. This will open the **Live Stream Settings**. + +Live stream settings + +3\. Ensure that the **Ingest type** is set to **Pull**. +4\. In the **URL** field, insert a link to the stream from your media server. +5\. Click the **Save changes** button on the top right. + +#### Via the API + +You can also set up a pull stream via the Gcore API. The endpoint accepts the URL of the stream to pull from. + +Example of the API request: + +```http +PATCH /streaming/streams/{stream_id} +``` + +```json +{ + "stream": { + "pull": true, + "uri": "rtmp://example.com/path/to/stream", + ... + } +} +``` + +Read more in the API documentation. diff --git a/documentation/streaming-platform/live-streaming/protocols/srt.md b/documentation/streaming-platform/live-streaming/protocols/srt.md new file mode 100644 index 000000000..2d1d398d2 --- /dev/null +++ b/documentation/streaming-platform/live-streaming/protocols/srt.md @@ -0,0 +1,114 @@ +--- +title: srt +displayName: SRT +published: true +order: 20 +pageTitle: Guide to SRT ingest | Gcore +pageDescription: A step-by-step tutorial on how to create and stop live streams using Gcore's interface or customer's environment. +--- + +# The Secure Reliable Transport Protocol + +Secure Reliable Transport (SRT) is an open-source streaming protocol that solves some limits of RTMP delivery. It contrast to RTMP/RTMPS, SRT is a UDP-based protocol that provides low-latency streaming over unpredictable networks. On Gcore Video Streaming, SRT is also require if you want to use the H265/HVEC codec. + +## Push streams + +Gcore Video Streaming provides you with two endpoints for pushing a stream, a default one and a backup one. The default endpoint is the one that is closest to your location. The backup endpoint is in a different location and used if the default one is unavailable. + +By default, Gcore will route your stream to free ingest points with the lowest latency. If you need to set a fixed ingest point or if you need to set the main and backup ingest points in the same region (i.e., to not send streams outside the EU or US), please contact our support team. + +### Obtain the server URLs + +There are two ways to obtain the SRT server URLs: via the Gcore Customer Portal or via the API. + +#### Via the Gcore Customer Portal + +1\. In the **Gcore Customer Portal**, navigate to **Streaming** > **Live Streaming**. + +List of live streams + +2\. Click on the stream you want to push to. This will open the **Live Stream Settings**. + +Live stream settings + +3\. Ensure that the **Ingest type** is set to **Push**. +4\. Ensure that the protocol is set to **SRT** in the **URLs for encoder** section. +5\. Copy the server URL from the **Push URL SRT** field. + +URLs for encoder section + +#### Via the API + +You can also obtain the URL and stream key via the Gcore API. They endpoint returns the complete URLs for the default and backup ingest points, as well as the stream key. + +Example of the API request: + +```http +GET /streaming/streams/{stream_id} +``` + +Example of the API response: + +```json +{ + "push_url": "srt://vp-push-anx2.domain.com/in/123?08cd54f0", + "backup_push_url": "srt://vp-push-ed1.domain.com/in/123b?08cd54f0", + ... +} +``` + +Read more in the API documentation. + +## Pull streams + +Gcore Video Streaming can pull video data from your external server. + +Main rules of pulling: + +- The URL of the stream to pull from must be **publicly available** and **return a 200 status** for all requests. +- You can specify **multiple media servers** (separated with space characters) in the **URL** input field. The maximum length of all URLs is 255 characters and the round robin is used when polling the list of specified servers. +- If a stream is closed (i.e., its connection is terminated) or there is no video data in the stream for 30 seconds, then the next attempt will be made in the next steps progressively (10s, 30s, 60s, 5min, 10min). +- The stream will be deactivated after 24 hours of inactivity. +- If you need to set an allowlist for access to the stream, please contact support to get an up-to-date list of networks. + +### Setting up a pull stream + +There are two ways to set up a pull stream: via the Gcore Customer Portal or via the API. + +#### Via the Gcore Customer Portal + +1\. In the **Gcore Customer Portal**, navigate to **Streaming** > **Live Streaming**. + +List of live streams + +2\. Click on the stream you want to pull from. This will open the **Live Stream Settings**. + +Live stream settings + +3\. Ensure that the **Ingest type** is set to **Pull**. +4\. In the **URL** field, insert a link to the stream from your media server. +5\. Click the **Save changes** button on the top right. + +URLs for encoder section + +#### Via the API + +You can also set up a pull stream via the Gcore API. The endpoint accepts the URL of the stream to pull from. + +Example of the API request: + +```http +PATCH /streaming/streams/{stream_id} +``` + +```json +{ + "stream": { + "pull": true, + "uri": "srt://example.com/path/to/stream", + ... + } +} +``` + +Read more in the API documentation. diff --git a/documentation/streaming-platform/live-streaming/webrtc-to-hls-transcoding.md b/documentation/streaming-platform/live-streaming/protocols/webrtc-to-hls-transcoding.md similarity index 75% rename from documentation/streaming-platform/live-streaming/webrtc-to-hls-transcoding.md rename to documentation/streaming-platform/live-streaming/protocols/webrtc-to-hls-transcoding.md index d04e519de..138cac013 100644 --- a/documentation/streaming-platform/live-streaming/webrtc-to-hls-transcoding.md +++ b/documentation/streaming-platform/live-streaming/protocols/webrtc-to-hls-transcoding.md @@ -1,81 +1,83 @@ --- title: webrtc-to-hls-transcoding -displayName: WebRTC ingest and transcoding to HLS/DASH +displayName: WebRTC to HLS/DASH published: true order: 15 toc: - --1--Benefits of WebRTC and HLS/DASH conversion: "advantages-of-webrtc-andconversion-to-hls-dash" - --1--How it works: "how-it-works" - --1--WebRTC stream encoding parameters: "webrtc-stream-encoding-parameters" - --2--Supported WHIP clients: "supported-whip-clients" - --2--LL-HLS and LL-DASH outputs: "ll-hls-and-ll-dash-outputs" - --1--Convert WebRTC in the Customer Portal: "convert-webrtc-to-hls-in-the-customer-portal" - --1--Convert WebRTC in your environment: "convert-webrtc-to-hls-in-your-environment" - --2--With the WebRTC WHIP library: "start-a-stream-with-the-gcore-webrtc-whip-library" - --2--With your backend or frontend: "start-a-stream-with-your-own-backend-or-frontend" - --2--Play HLS or DASH: "play-hls-or-dash" - --2--Deactivate a stream: "deactivate-a-finished-stream" - --2--Demo projects: "demo-projects-of-streaming-with-frontend-and-backend" - --1--Troubleshooting: "troubleshooting" - --2--Error handling: "error-handling" - --2--Sudden disconnection of camera or microphone: "sudden-disconnection-of-camera-or-microphone" - --2--Debugging with Chrome WebRTC internals: "debugging-with-chrome-webrtc-internals-tool" - --2--Network troubleshooting: "network-troubleshooting" + --1--Benefits of WebRTC and HLS/DASH conversion: 'advantages-of-webrtc-andconversion-to-hls-dash' + --1--How it works: 'how-it-works' + --1--WebRTC stream encoding parameters: 'webrtc-stream-encoding-parameters' + --2--Supported WHIP clients: 'supported-whip-clients' + --2--LL-HLS and LL-DASH outputs: 'll-hls-and-ll-dash-outputs' + --1--Convert WebRTC in the Customer Portal: 'convert-webrtc-to-hls-in-the-customer-portal' + --1--Convert WebRTC in your environment: 'convert-webrtc-to-hls-in-your-environment' + --2--With the WebRTC WHIP library: 'start-a-stream-with-the-gcore-webrtc-whip-library' + --2--With your backend or frontend: 'start-a-stream-with-your-own-backend-or-frontend' + --2--Play HLS or DASH: 'play-hls-or-dash' + --2--Deactivate a stream: 'deactivate-a-finished-stream' + --2--Demo projects: 'demo-projects-of-streaming-with-frontend-and-backend' + --1--Troubleshooting: 'troubleshooting' + --2--Error handling: 'error-handling' + --2--Sudden disconnection of camera or microphone: 'sudden-disconnection-of-camera-or-microphone' + --2--Debugging with Chrome WebRTC internals: 'debugging-with-chrome-webrtc-internals-tool' + --2--Network troubleshooting: 'network-troubleshooting' pageTitle: Guide to WebRTC ingest and transcoding to HLS/DASH | Gcore -pageDescription: A step-by-step tutorial on how to create and stop live streams using Gcore's interface or customer's environment. +pageDescription: A step-by-step tutorial on how to create and stop live streams using Gcore's interface or customer's environment. --- + # WebRTC ingest and transcoding to HLS/DASH -Streaming videos using HLS and MPEG-DASH protocols is a simple and cost-effective way to show your video to large audiences. However, this requires the original streams to be in a certain format that browsers do not support natively. +Streaming videos using HLS and MPEG-DASH protocols is a simple and cost-effective way to show your video to large audiences. However, this requires the original streams to be in a certain format that browsers do not support natively. -At the same time, WebRTC protocol works in any browser, but it’s not as flexible when streaming to large audiences. +At the same time, WebRTC protocol works in any browser, but it’s not as flexible when streaming to large audiences. -Gcore Video Streaming supports both WebRTC HTTP Ingest Protocol (WHIP) and WebRTC to HLS/DASH converter, giving you the advantages of these protocols. +Gcore Video Streaming supports both WebRTC HTTP Ingest Protocol (WHIP) and WebRTC to HLS/DASH converter, giving you the advantages of these protocols. A diagram depicting WebRTC converting to LL-HLS/DASH ## Advantages of WebRTC and conversion to HLS/DASH -WebRTC ingest for streaming offers two key advantages over traditional RTMP and SRT protocols: +WebRTC ingest for streaming offers two key advantages over traditional RTMP and SRT protocols: -1\. It runs directly in the presenter's browser, so no additional software is needed. +1\. It runs directly in the presenter's browser, so no additional software is needed. -2\. WebRTC can reduce stream latency. +2\. WebRTC can reduce stream latency. -By using WebRTC WHIP for ingest, you can convert WebRTC to HLS/DASH playback, which provides the following benefits: +By using WebRTC WHIP for ingest, you can convert WebRTC to HLS/DASH playback, which provides the following benefits: -* Fast ingest via WebRTC from a browser. -* Optimal stream distribution using HLS/DASH with adaptive bitrate streaming (ABR) through the CDN. +- Fast ingest via WebRTC from a browser. +- Optimal stream distribution using HLS/DASH with adaptive bitrate streaming (ABR) through the CDN. A diagram depicting WebRTC transcoding and distribution via HLS/DASH -## How it works +## How it works + +We use a dedicated WebRTC WHIP server to manage WebRTC ingest. This server handles both signaling and video data reception. Such a setup allows you to configure WebRTC on demand and continue to use all system capabilities to set up transcoding and delivery via CDN. -We use a dedicated WebRTC WHIP server to manage WebRTC ingest. This server handles both signaling and video data reception. Such a setup allows you to configure WebRTC on demand and continue to use all system capabilities to set up transcoding and delivery via CDN. +The RTC WHIP server organizes signaling and receives video data. Signaling refers to the communication between WebRTC endpoints that are necessary to initiate and maintain a session. WHIP is an open specification for a simple signaling protocol that starts WebRTC sessions in an outgoing direction, such as streaming from your device. -The RTC WHIP server organizes signaling and receives video data. Signaling refers to the communication between WebRTC endpoints that are necessary to initiate and maintain a session. WHIP is an open specification for a simple signaling protocol that starts WebRTC sessions in an outgoing direction, such as streaming from your device. +We use local servers in each region to ensure a minimal route from a user-presenter to the server. -We use local servers in each region to ensure a minimal route from a user-presenter to the server. +### WebRTC stream encoding parameters -### WebRTC stream encoding parameters +The stream must include at least one video track and one audio track: -The stream must include at least one video track and one audio track: +- Video must be encoded using H.264. +- Audio must use OPUS codec. -* Video must be encoded using H.264. -* Audio must use OPUS codec. +If you use OBS or your own WHIP library, use the following video encoding parameters: -If you use OBS or your own WHIP library, use the following video encoding parameters: +- Codec H.264 with no B-frames and fast encoding: -* Codec H.264 with no B-frames and fast encoding: - * **Encoder**: x264, or any of H.264 - * **CPU usage**: very fast - * **Keyframe interval**: 1 sec - * **Profile**: baseline - * **Tune**: zero latency - * **x264 options**: bframes=0 scenecut=0 + - **Encoder**: x264, or any of H.264 + - **CPU usage**: very fast + - **Keyframe interval**: 1 sec + - **Profile**: baseline + - **Tune**: zero latency + - **x264 options**: bframes=0 scenecut=0 -* Bitrate: - * The lower the bitrate, the faster the data will be transmitted to the server. Choose the optimal one for your video. For example, 1-2 Mbps is usually enough for video broadcasts of online training format or online broadcasts with a presenter. +- Bitrate: + - The lower the bitrate, the faster the data will be transmitted to the server. Choose the optimal one for your video. For example, 1-2 Mbps is usually enough for video broadcasts of online training format or online broadcasts with a presenter. For example, you might have the following settings in OBS: @@ -83,27 +85,27 @@ For example, you might have the following settings in OBS: ### Supported WHIP clients -You can use any libraries to send data via the WebRTC WHIP protocol. +You can use any libraries to send data via the WebRTC WHIP protocol. -* Gcore WebRTC WHIP client -* OBS (Open Broadcaster Software) -* @eyevinn/whip-web-client -* whip-go -* Larix Broadcaster (free apps for iOS and Android with WebRTC based on Pion; SDK is available) +- Gcore WebRTC WHIP client +- OBS (Open Broadcaster Software) +- @eyevinn/whip-web-client +- whip-go +- Larix Broadcaster (free apps for iOS and Android with WebRTC based on Pion; SDK is available) ### LL-HLS and LL-DASH outputs -Streams sent via WebRTC are transcoded in the same way as other streams received via RTMP and SRT. +Streams sent via WebRTC are transcoded in the same way as other streams received via RTMP and SRT. -At the output, you can view the streams using any available protocols: +At the output, you can view the streams using any available protocols: -* **MPEG-DASH**: ±2-4 seconds latency to a viewer with ABR. -* **LL-HLS**: ±3-4 seconds latency to a viewer with ABR. -* **HLS MPEG-TS**: legacy with non-low-latency (±10 seconds latency) with ABR. +- **MPEG-DASH**: ±2-4 seconds latency to a viewer with ABR. +- **LL-HLS**: ±3-4 seconds latency to a viewer with ABR. +- **HLS MPEG-TS**: legacy with non-low-latency (±10 seconds latency) with ABR. For WebRTC mode, we use a method of constant transcoding with an initial given resolution. This means that if WebRTC in a viewer’s browser reduces the quality or resolution of the master stream (for example, to 360p) due to restrictions on the viewer's device (such as network conditions or CPU consumption), the transcoder will continue to transcode the reduced stream to the initial resolution (for example 1080p ABR). -When the restrictions on the viewer's device are removed, quality will improve again. +When the restrictions on the viewer's device are removed, quality will improve again. @@ -113,55 +115,55 @@ For more details about low-latency streaming, check out API documentation. +For instructions on how to convert a stream via API, refer to the API documentation. -1\. In the Gcore Customer Portal, navigate to **Streaming**. +1\. In the Gcore Customer Portal, navigate to **Streaming**. -2\. Open the Live Streaming** page and find a needed live stream. If you don’t have one, create a stream first. +2\. Open the Live Streaming\*\* page and find a needed live stream. If you don’t have one, create a stream first. -3\. Click the stream name to open its settings. +3\. Click the stream name to open its settings. 4\. In the **Quick start in browser** section, click **Go Live**. The broadcast will start automatically. Example of live broadcast -5\. Allow Gcore to access your camera and microphone. In several seconds the HLS/DASH stream will appear in an HTML video player. +5\. Allow Gcore to access your camera and microphone. In several seconds the HLS/DASH stream will appear in an HTML video player. -You’ll see the result under the **Video preview** instead of a black area with the “No active streams found” message. This large window of an HTML video player is the transcoded version of the stream in HLS/DASH protocols using adaptive bitrate. +You’ll see the result under the **Video preview** instead of a black area with the “No active streams found” message. This large window of an HTML video player is the transcoded version of the stream in HLS/DASH protocols using adaptive bitrate. Example of a fully launched stream -A small window in the top-right corner is from your camera. It shows the stream taken from the webcam. +A small window in the top-right corner is from your camera. It shows the stream taken from the webcam. -There are also settings for selecting a camera and microphone if you have more than one option on your device. +There are also settings for selecting a camera and microphone if you have more than one option on your device. ## Convert WebRTC to HLS in your environment -We provide a WebRTC WHIP library for working in browsers. It implements the basic system calls and simplifies working with WebRTC: +We provide a WebRTC WHIP library for working in browsers. It implements the basic system calls and simplifies working with WebRTC: -* Wrapper for initializing WebRTC stream and connecting to the server. -* Camera and mic wrapper. -* Monitoring WebRTC events and calling appropriate handlers in your code. +- Wrapper for initializing WebRTC stream and connecting to the server. +- Camera and mic wrapper. +- Monitoring WebRTC events and calling appropriate handlers in your code. The latest library version, 0.72.0, is available at https://rtckit.gvideo.io/0.72.0/index.esm.js. ### Start a stream with the Gcore WebRTC WHIP library -Since WHIP is an open standard, many libraries have been released for it in different languages. You can use our WebRTC WHIP or any other library specified in the WHIP clients section. +Since WHIP is an open standard, many libraries have been released for it in different languages. You can use our WebRTC WHIP or any other library specified in the WHIP clients section. -Using our library, you can start the conversion with a few lines of code. To go live immediately, create a live stream in the Gcore Streaming dashboard and paste a URL into the example linked below: +Using our library, you can start the conversion with a few lines of code. To go live immediately, create a live stream in the Gcore Streaming dashboard and paste a URL into the example linked below: -1\. In the Gcore Customer Portal, open the Live Streaming page. +1\. In the Gcore Customer Portal, open the Live Streaming page. 2\. Open the stream settings and copy a WHIP URL from the **WebRTC => HLS parameters** section. -3\. Open WHIP demo app and paste the WHIP URL into the `WHIP_ENDPOINT const`. +3\. Open WHIP demo app and paste the WHIP URL into the `WHIP_ENDPOINT const`. WHIP endpoint where to paste the info -4\. Click the **Start** button. The steam will be started in the Customer Portal. +4\. Click the **Start** button. The steam will be started in the Customer Portal. -You can find the technical reference manual on data types, interfaces, methods, and other components in the gcorevideo/rtckit repository. +You can find the technical reference manual on data types, interfaces, methods, and other components in the gcorevideo/rtckit repository. ### Start a stream with your own backend or frontend @@ -183,7 +185,7 @@ curl -L 'https://api.gcore.com/streaming/streams' \ }' -Example response: +Example response: { @@ -193,11 +195,11 @@ Example response: } -Use the `“push_url_whip”` value from the response to start the stream. +Use the `“push_url_whip”` value from the response to start the stream. #### Frontend WHIP -Get access and data from the microphone and camera: +Get access and data from the microphone and camera: import { WebrtcStreaming } from 'https://rtckit.gvideo.io/0.68.2/index.esm.js'; @@ -205,7 +207,7 @@ const WHIP_ENDPOINT = '{push_url_whip}'; const webrtc = new WebrtcStreaming(WHIP_ENDPOINT, {...}); -Send a local stream to the WHIP server: +Send a local stream to the WHIP server: webrtc.openSourceStream({ @@ -215,27 +217,27 @@ webrtc.openSourceStream({ }) -Note that if a user stops streaming to the ingester, for example, by closing the browser tab, the stream settings will be terminated. When the user resumes streaming from any browser, the ingester will pick up the stream. However, there will be a brief delay before the ingested stream becomes playable. +Note that if a user stops streaming to the ingester, for example, by closing the browser tab, the stream settings will be terminated. When the user resumes streaming from any browser, the ingester will pick up the stream. However, there will be a brief delay before the ingested stream becomes playable. -If a user tries to stream to the same endpoint where another user is already streaming, the former will get an error message from the media server. The current stream will remain uninterrupted. +If a user tries to stream to the same endpoint where another user is already streaming, the former will get an error message from the media server. The current stream will remain uninterrupted. ### Play HLS or DASH -After sending the stream from frontend, the stream will start transcoding. In ±2-7 seconds, the HLS and MPEG-DASH versions will be ready for viewing. +After sending the stream from frontend, the stream will start transcoding. In ±2-7 seconds, the HLS and MPEG-DASH versions will be ready for viewing. The stream can be viewed through the built-in web player or using direct links to the manifests. You can take these links from the API response. Examples: -* Web player: https://player.gvideo.co/streams/102748_1965207 -* LL-HLS manifest: https://102748.gvideo.io/cmaf/102748_1965207/master.m3u8 -* DASH manifest: https://102748.gvideo.io/cmaf/102748_1965207/index.mpd +- Web player: https://player.gvideo.co/streams/102748_1965207 +- LL-HLS manifest: https://102748.gvideo.io/cmaf/102748_1965207/master.m3u8 +- DASH manifest: https://102748.gvideo.io/cmaf/102748_1965207/index.mpd Send a GET request to the following endpoint: `https://api.gcore.com/streaming/streams/{id}`. -Example request: +Example request: curl -L 'https://api.gcore.com/streaming/streams/1965207' \ @@ -263,7 +265,7 @@ Example response: Update the stream by sending a PATCH request to the following endpoint: `https://api.gcore.com/streaming/streams/{id}`. -Example request: +Example request: curl -L -X PATCH 'https://api.gcore.com/streaming/streams/1965207' \ @@ -276,7 +278,7 @@ curl -L -X PATCH 'https://api.gcore.com/streaming/streams/1965207' \ Alternatively, you can delete the stream by sending the DELETE request to `https://api.gcore.com/streaming/streams/$id`. -Example request: +Example request: curl -L -X DELETE 'https://api.gcore.com/streaming/streams/1965207' \ @@ -295,26 +297,26 @@ Example command to close the stream: `webrtc.close()` #### Demo 1. JavaScript WebRTC WHIP client app -You can find a detailed description of this version above. To view the full code, inspect the https://stackblitz.com/edit/stackblitz-starters-j2r9ar?file=index.html. +You can find a detailed description of this version above. To view the full code, inspect the https://stackblitz.com/edit/stackblitz-starters-j2r9ar?file=index.html. Example of demo project 1 #### Demo 2. Comprehensive full-stack implementation on Nuxt -This demo depicts a complete frontend and backend implementation with the Nuxt framework. It’s a fully functional prebuilt version with a demo stream from our demo server. +This demo depicts a complete frontend and backend implementation with the Nuxt framework. It’s a fully functional prebuilt version with a demo stream from our demo server. -The implementation includes: stream generation, initialization of WebRTC data in a browser, video transmission from the browser to the server, and displaying the HLS/DASH web player with transcoded broadcast. +The implementation includes: stream generation, initialization of WebRTC data in a browser, video transmission from the browser to the server, and displaying the HLS/DASH web player with transcoded broadcast. -We’ve added the demo instance and source code to help you explore the implementation in action: +We’ve added the demo instance and source code to help you explore the implementation in action: -* Demo app – https://gcore-webrtc-sdk-js-nuxt.vercel.app/host?token=123 -* Source code – https://github.com/G-Core/gcore-webrtc-sdk-js/tree/main/apps/ingest-demo-nuxt +- Demo app – https://gcore-webrtc-sdk-js-nuxt.vercel.app/host?token=123 +- Source code – https://github.com/G-Core/gcore-webrtc-sdk-js/tree/main/apps/ingest-demo-nuxt -To start streaming: +To start streaming: -1\. Select your camera and microphone +1\. Select your camera and microphone -2\. In the **Host** section, click **Start** under the video preview. +2\. In the **Host** section, click **Start** under the video preview. 3\. Click the **Watch** link. @@ -330,17 +332,17 @@ If you experience issues related to our streaming service, check out the followi **NetworkError** -For details, refer to NetworkError class. +For details, refer to NetworkError class. -The ingestion service is unavailable or is unreachable from the client’s network. The error message includes a description of the error cause. +The ingestion service is unavailable or is unreachable from the client’s network. The error message includes a description of the error cause. -In such cases, the application should render itself unavailable and report the error to Gcore support. The app should not retry the operation, as the retry logic is already implemented in the SDK. +In such cases, the application should render itself unavailable and report the error to Gcore support. The app should not retry the operation, as the retry logic is already implemented in the SDK. -**ServerRequestError** +**ServerRequestError** -For details, check out ServerRequestError class. +For details, check out ServerRequestError class. -The ingestion server returned an error, which can be identified by inspecting the `status` and `detail` fields of the error object. +The ingestion server returned an error, which can be identified by inspecting the `status` and `detail` fields of the error object. @@ -389,9 +391,9 @@ The ingestion server returned an error, which can be identified by inspecting th **TimeoutError** -For details, check out TimeoutError class. +For details, check out TimeoutError class. -Some operation has timed out. +Some operation has timed out. @@ -415,51 +417,51 @@ Some operation has timed out. -Other types of errors are described in our SDK docs. End-users should not encounter these errors, and there is no way to handle them in a real application apart from reporting the error occurrence. +Other types of errors are described in our SDK docs. End-users should not encounter these errors, and there is no way to handle them in a real application apart from reporting the error occurrence. -Some SDK methods might also throw browser’s native exceptions, such as WebrtcStreaming.openSourceStream and the methods of the MediaDevicesHelper throw getUserMedia-originated exceptions. The application should handle them accordingly. +Some SDK methods might also throw browser’s native exceptions, such as WebrtcStreaming.openSourceStream and the methods of the MediaDevicesHelper throw getUserMedia-originated exceptions. The application should handle them accordingly. ### Sudden disconnection of camera or microphone -Sometimes, users use external or plug-in cameras and microphones, and these devices can be disconnected at any time. For example: +Sometimes, users use external or plug-in cameras and microphones, and these devices can be disconnected at any time. For example: -* A USB camera cable might be unplugged. -* AirPods may be placed back in their case. +- A USB camera cable might be unplugged. +- AirPods may be placed back in their case. -If a camera or microphone is accidentally disconnected, you need to track such cases programmatically. Enable the `mediaDevicesAutoSwitch` option and subscribe to the event: +If a camera or microphone is accidentally disconnected, you need to track such cases programmatically. Enable the `mediaDevicesAutoSwitch` option and subscribe to the event: -* set mediaDevicesAutoSwitch: true -* catch WebrtcStreamingEvents +- set mediaDevicesAutoSwitch: true +- catch WebrtcStreamingEvents -The new algorithm ensures uninterrupted broadcasting by prompting the browser to switch to another available camera or microphone if the current device becomes unavailable. +The new algorithm ensures uninterrupted broadcasting by prompting the browser to switch to another available camera or microphone if the current device becomes unavailable. -When such a situation occurs, you will know which device was disconnected and which one was connected instead. This will allow you to visualize (if necessary) the new connected device in your interface. +When such a situation occurs, you will know which device was disconnected and which one was connected instead. This will allow you to visualize (if necessary) the new connected device in your interface. A list of available devices with USB audio selected ### Debugging with Chrome WebRTC internals tool -Chrome is really good at working with WebRTC because it has a built-in tool to help developers see how things are working. +Chrome is really good at working with WebRTC because it has a built-in tool to help developers see how things are working. -Chrome v87+ has a special page called chrome://webrtc-internals where you can check your WebRTC calls: +Chrome v87+ has a special page called chrome://webrtc-internals where you can check your WebRTC calls: -1\. Open a new Chrome tab and navigate to chrome://webrtc-internals while you're in a WebRTC call. On this page, you can view detailed information about the video and audio streams, connection setup, and more. +1\. Open a new Chrome tab and navigate to chrome://webrtc-internals while you're in a WebRTC call. On this page, you can view detailed information about the video and audio streams, connection setup, and more. -2\. Use the provided information to find potential problems. For instance, when videos won't play, calls won't connect, or videos are slow. +2\. Use the provided information to find potential problems. For instance, when videos won't play, calls won't connect, or videos are slow. -One of the parameters you can monitor in Stats graphs for candidate-pair: +One of the parameters you can monitor in Stats graphs for candidate-pair: -* **AvailableOutgoingBitrate** +- **AvailableOutgoingBitrate** AvailableOutgoingBitrate graph in Chrome WebRTC internals -You can also follow the following parameters from the **Stats graphs for outbound-rtp**: +You can also follow the following parameters from the **Stats graphs for outbound-rtp**: -* bytesSent_in_bits/s -* targetBitrate -* frameWidth -* frameHeight -* framesSent/s +- bytesSent_in_bits/s +- targetBitrate +- frameWidth +- frameHeight +- framesSent/s For example, consider how unevenly frames are sent from the browser in the following screenshot: @@ -469,41 +471,41 @@ For example, consider how unevenly frames are sent from the browser in the follo #### Video stream is poorly transcoded or constantly stops -If a stream in the player constantly stops, is interrupted, or has poor quality, the issue is likely related to slow transmission of the original stream from a presenter via WebRTC. +If a stream in the player constantly stops, is interrupted, or has poor quality, the issue is likely related to slow transmission of the original stream from a presenter via WebRTC. -WebRTC is very demanding of the quality of internet connection from client to server. At the same time, standard implementations take into account many parameters on a local device, which can cause slower transmission of data or even stop it altogether until conditions are improved. +WebRTC is very demanding of the quality of internet connection from client to server. At the same time, standard implementations take into account many parameters on a local device, which can cause slower transmission of data or even stop it altogether until conditions are improved. -To diagnose such situations: +To diagnose such situations: -1\. Use the **VideoResolutionChangeDetector** plugin. It allows you to show a message about bad network conditions on a viewer’s device. +1\. Use the **VideoResolutionChangeDetector** plugin. It allows you to show a message about bad network conditions on a viewer’s device. -2\. Use Chrome’s WebRTC debug tool that’s available via this link: chrome:\\webrtc-internals. +2\. Use Chrome’s WebRTC debug tool that’s available via this link: chrome:\\webrtc-internals. -Network congestion, occurring when resource demand surpasses capacity, leads to packet loss, increased latency, and jitter, hindering real-time communication, with congestion control algorithms optimizing performance by regulating data packet flow. You can read how WebRTC uses Transport Wide Congestion Control (TWCC) to control it in thearticle about TWCC. +Network congestion, occurring when resource demand surpasses capacity, leads to packet loss, increased latency, and jitter, hindering real-time communication, with congestion control algorithms optimizing performance by regulating data packet flow. You can read how WebRTC uses Transport Wide Congestion Control (TWCC) to control it in thearticle about TWCC. -The available bitrate is calculated in the **availableOutgoingBitrate** parameter, which indicates the available outbound capacity of the network connection. The higher the value, the more bandwidth you can assume is available for outgoing data. The value is reported in bits per second and is computed over a 1-second interval. +The available bitrate is calculated in the **availableOutgoingBitrate** parameter, which indicates the available outbound capacity of the network connection. The higher the value, the more bandwidth you can assume is available for outgoing data. The value is reported in bits per second and is computed over a 1-second interval. -The most likely scenario for quality degradation occurs here when the channel width becomes insufficient to send good resolution. +The most likely scenario for quality degradation occurs here when the channel width becomes insufficient to send good resolution. -However, sometimes the connection is even worse when packets are lost. In this case, the server starts sending NACK (Negative Acknowledgement) packets. You can read more about this issue in the NACK overview article. +However, sometimes the connection is even worse when packets are lost. In this case, the server starts sending NACK (Negative Acknowledgement) packets. You can read more about this issue in the NACK overview article. -More and more data start to be resent, which leads to increased latency or gaps in frames. In this case, the transcoder doesn’t receive frames on time, causing the video to interrupt or stop altogether. You can monitor and debug this issue in Chrome’s webrtc-internals tool: +More and more data start to be resent, which leads to increased latency or gaps in frames. In this case, the transcoder doesn’t receive frames on time, causing the video to interrupt or stop altogether. You can monitor and debug this issue in Chrome’s webrtc-internals tool: Example graphs in Chrome WebRTC internals tool -What to do in such situations: +What to do in such situations: -* Always show users a message about changed conditions. In 99% of cases, the issue is related to the user’s internet conditions. -* Use TCP as the delivery protocol instead of UDP. -* Use the TURN server for delivery instead of sending directly to the media server. +- Always show users a message about changed conditions. In 99% of cases, the issue is related to the user’s internet conditions. +- Use TCP as the delivery protocol instead of UDP. +- Use the TURN server for delivery instead of sending directly to the media server. -#### Issues with ICE servers +#### Issues with ICE servers -If you experience problems with timeout waiting for an ICE candidate, check your ICE server configuration. +If you experience problems with timeout waiting for an ICE candidate, check your ICE server configuration. -ICE servers used by the WHIP client can be configured explicitly using the iceServers configuration option. Otherwise, they are fetched from Gcore’s media server in the response to a session initiation request. +ICE servers used by the WHIP client can be configured explicitly using the iceServers configuration option. Otherwise, they are fetched from Gcore’s media server in the response to a session initiation request. -In the case of the latter, check what the server returns in the `Link` headers. For example: +In the case of the latter, check what the server returns in the `Link` headers. For example: Example data in Link headers @@ -513,17 +515,17 @@ Link: ; rel="ice-server"; us Link: ... -You can also inspect the servers using chrome://webrtc-internals or an alternative tool: +You can also inspect the servers using chrome://webrtc-internals or an alternative tool: Example of servers check in Chome WebRTC internals -After you verify your server configuration, use the Trickle ICE app to test the servers. +After you verify your server configuration, use the Trickle ICE app to test the servers. -Add a STUN or TURN server and check how it works. If everything functions correctly, the results will show: +Add a STUN or TURN server and check how it works. If everything functions correctly, the results will show: -* A srvrflx candidate for STUN server -* A relay candidate for a TURN server +- A srvrflx candidate for STUN server +- A relay candidate for a TURN server -If you don't see these results, your STUN or TURN server may be misconfigured, or there is an outage. +If you don't see these results, your STUN or TURN server may be misconfigured, or there is an outage. The Gcore support team will help you handle that. In the request, include the results of your ICE connectivity check to help us resolve the issue quickly. diff --git a/documentation/streaming-platform/live-streaming/push-live-streams-software/metadata.md b/documentation/streaming-platform/live-streaming/push-live-streams-software/metadata.md deleted file mode 100644 index aa38d557a..000000000 --- a/documentation/streaming-platform/live-streaming/push-live-streams-software/metadata.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: metadata -displayName: Push live streams software -published: true -order: 20 ---- diff --git a/documentation/streaming-platform/live-streaming/push-live-streams-software/push-live-streams-via-liveu-solo.md b/documentation/streaming-platform/live-streaming/push-live-streams-software/push-live-streams-via-liveu-solo.md deleted file mode 100644 index bd4d09a0d..000000000 --- a/documentation/streaming-platform/live-streaming/push-live-streams-software/push-live-streams-via-liveu-solo.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: push-live-streams-via-liveu-solo -displayName: LiveU Solo -published: true -order: 30 -toc: -pageTitle: Live Stream Setup with LiveU Solo | Gcore -pageDescription: A step-by-step guide to pushing live streams via LiveU Solo. ---- -# Push live streams via LiveU Solo - -Install and launch LiveU Solo. - -Click on the «Edit Destination» button. - - LiveU Solo - -Find RTMP URL and a stream key in the Gcore Customer Portal according to the Create a live stream guide. Choose the stream, click edit, and look at the Push URL. - -Fill the «Primary Ingress URL» field with this part of PUSH URL: *rtmp://vp-push-ed1.gvideo.co/in/* and «Stream name» field with the key — all the remaining symbols: *9cb3fdee0836564bd0046dasdb0e4de3sda32af712411313*. - -Run the stream. \ No newline at end of file diff --git a/documentation/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs.md b/documentation/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs.md index 1e5dd1091..8a51197ee 100644 --- a/documentation/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs.md +++ b/documentation/streaming-platform/live-streams-and-videos-protocols-and-codecs/output-parameters-after-transcoding-bitrate-frame-rate-and-codecs.md @@ -136,29 +136,6 @@ We provide an optimized set of quality presets designed for smooth streaming acr Each video can have its own unique quality settings, so you’re not limited to a single configuration. Default and custom presets work together, giving you the flexibility to fine-tune streaming quality as needed. Check out the API documentation to explore available custom quality sets. If you need assistance, our [support team](mailto:support@gcore.com) is always ready to help you customize the best option for your needs. - -## HTTP response codes when requesting Live and VOD videos - -The following table includes the possible HTTP response codes returned when requesting videos and live streams for manifests (.m3u8, .mpd) and chunks (.ts, mp4, etc.). - - - - - - - - - - - -
CodeFunctionDescription
200OKAll OK
403ForbiddenAccess is denied. If you use any distribution restriction such as geo-restriction or token, you must satisfy this condition for access.
404Not FoundThere's no requested video, or the live stream is temporarily not delivering chunks. Check the request link or activate your video.
For Live streams in CMAF format, you can check the extra header "X-Err-Code":
  • 1000 – Master-stream is missed. The stream is not pushed or not transcoded, so start a stream or restart transcoding.
  • 2000 – Invalid StreamID. The identifier is not parsed from the requested URL; check the URL.
  • 3000 – Stream is not ready for delivery. Inspect the logs or contact support. Oftentimes, this happens when the master-stream has wrong parameters, such as video and audio codecs, FPS, or bitrate. Verify the parameters to ensure everything works as expected.
422Not FoundThis is advanced functionality (i.e. custom encoding presets). To enable it, contact your manager or the support team.
500Internal Server ErrorAn unexpected issue happened on the server. This may be a local error in a specific video. In this case, check the video processing status in your personal account. If the error is global, the information will be on the status page.
502Bad GatewayAn unexpected issue happened on the server. This may happen when VOD or Live can't be delivered over CDN because an incorrect response was received from an origin (storage or live transcoder). In this case, check the video processing status or live stream transcoding in your personal account. If the error is global, the information will appear on the status page.
503Service UnavailableAn unexpected issue happened on the server. This may be a local error in a specific video. In this case, check the video processing status in your personal account. If the error is global, the information will be on the status page.
504Gateway Time-outTimeout for receiving data from the source. Try checking the status of video sending/ingesting and transcoding.
- - - -The system health status page is available at [https://status.gcore.com/](https://status.gcore.com/) - - - ## How to apply 2K/4K+ and custom advanced settings Some settings require manual control. If you need them, contact the Gcore [support team](mailto:support@gcore.com) or your manager. diff --git a/documentation/streaming-platform/troubleshooting/general-issues.md b/documentation/streaming-platform/troubleshooting/general-issues.md new file mode 100644 index 000000000..f350ef52e --- /dev/null +++ b/documentation/streaming-platform/troubleshooting/general-issues.md @@ -0,0 +1,84 @@ +--- +title: general-issues +displayName: General issues +published: true +order: 10 +pageTitle: Solving General Video Streaming Issues | Gcore +pageDescription: An explanation of common basic checks to address general issues that may arise when working with Video Streaming. +--- + +# General Video Streaming Issues + +Common issues you may encounter when working with both Live and VOD streams, as well as steps you can take to troubleshoot them. + + + +If you encounter problems that are specific to live streaming or VOD uploads, please refer to the [Live streaming issues](https://gcore.com/docs/streaming-platform/live-streaming/troubleshooting/live-streaming-issues) or [VOD issues](https://gcore.com/docs/streaming-platform/live-streaming/troubleshooting/vod-issues) pages. + + + +## General troubleshooting steps + +For the most common issues, such as video not playing, taking a long time to start streaming, or looking blurry, these basic checks should help: + +- **Status page**. Check if the issue you are experiencing is related to any known issue or is an isolated one by visiting the status page. +- **Source video**. Ensure that the source content is uploaded for streaming. If the same issue occurs in the source, re-upload the video or restart the stream. +- **Stream URL and code**. Make sure to use the exact URL and embed code that appear in the Streaming settings. +- **Streaming settings**. Make sure the stream is enabled. If configured to pull a stream, make sure the source URL is correct. +- **Encoder settings**. Make sure you are using the recommended settings. If configured to push a stream, make sure the server URL and stream key are accurate. + +Other things to try: + +- Clear the browsing data. +- Disable any interfering browser extensions. +- Ensure that the network connection is stable. Try connecting with or without a VPN. +- Verify that the streaming ports are open on the firewall. +- Update the browser or device OS. + +## Common playback issues + +Issues with playback can be caused by a variety of factors, including network issues, device compatibility, and encoding settings. Here are some common issues and their solutions. + +### Stream does not appear on some devices + +_Possible cause_: Device is too old. +_Suggested solution_: Streaming should work on most devices, but some devices may not be compatible. Try using a modern device with enough processing power and memory to successfully stream video. + +### Stream returns an HTTP 404 error + +_Possible cause_: Transcoding is in progress. +_Suggested solution_: Each video chunk may take several seconds to transcode. Allow 10 to 15 seconds for this to happen. Once the chunks have been transcoded, the stream should be ready to play. + +_Possible cause_: Low Latency is not enabled in the Customer Portal. +_Suggested solution_: Contact our [support team](mailto:support@gcore.com) to activate this option. + + + +For more details on HTTP status codes, see the HTTP status codes page. + + + +### Stream returns an HTTP 502 error + +_Possible cause_: CDN resource settings have been changed from the preset settings. +_Suggested solution_: Contact our [support team](mailto:support@gcore.com) to assist you in restoring the settings. + +_Possible cause_: Token configuration is not synchronized. +_Suggested solution_: Contact our [support team](mailto:support@gcore.com) to help you restore the settings. + +## Open a support ticket + +If none of the above work or apply to your issue, contact our [support team](mailto:support@gcore.com) with the following information: + +1. Link to the stream. +2. Description of the issue and steps to reproduce. +3. List of steps taken to troubleshoot the issue. +4. Screenshot of the information shown in http://iam.gcdn.co/info. +5. Screenshot of the response to this command: + + ``` + curl http://iam.gcdn.co/info/json + ``` + +6. Screenshot of the speed test result using http://iam.gcdn.co/info. +7. HAR file. This page describes how to generate one in Chrome, Firefox, and Edge. diff --git a/documentation/streaming-platform/troubleshooting/http-status-codes.md b/documentation/streaming-platform/troubleshooting/http-status-codes.md new file mode 100644 index 000000000..49192c1ba --- /dev/null +++ b/documentation/streaming-platform/troubleshooting/http-status-codes.md @@ -0,0 +1,67 @@ +--- +title: http-status-codes +displayName: HTTP status codes +published: true +order: 20 +pageTitle: Video Streaming HTTP Status Codes | Gcore +pageDescription: An explanation of the HTTP status codes returned when requesting videos and live streams for manifests or chunks. +--- + +# Video Streaming HTTP Status Codes + +The following table includes all possible HTTP status codes returned when requesting videos and live streams for manifests (e.g., .m3u8 and .mpd) or chunks (e.g., .ts, .mp4, etc.). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CodeStatusDescription
200OKAll OK
403ForbiddenAccess is denied. If you use any distribution restriction such as geo-restriction or token, you must satisfy this condition for access.
404Not FoundThere's no requested video, or the live stream is temporarily not delivering chunks. Check the request link or activate your video.
For Live streams in CMAF format, you can check the extra header "X-Err-Code":
  • 1000 – Master-stream is missed. The stream is not pushed or not transcoded, so start a stream or restart transcoding.
  • 2000 – Invalid StreamID. The identifier is not parsed from the requested URL; check the URL.
  • 3000 – Stream is not ready for delivery. Inspect the logs or contact support. Oftentimes, this happens when the master-stream has wrong parameters, such as video and audio codecs, FPS, or bitrate. Verify the parameters to ensure everything works as expected.
+
422Unprocessable ContentThis is advanced functionality (e.g., custom encoding presets). To enable it, contact your manager or the support team.
500Internal Server ErrorAn unexpected issue happened on the server. This may be a local error in a specific video. In this case, check the video processing status in your personal account. If the error is global, the information will be on the status page.
502Bad GatewayAn unexpected issue happened on the server. This may happen when VOD or Live can't be delivered over CDN because an incorrect response was received from an origin (storage or live transcoder). In this case, check the video processing status or live stream transcoding in your personal account. If the error is global, the information will appear on the status page.
503Service UnavailableAn unexpected issue happened on the server. This may be a local error in a specific video. In this case, check the video processing status in your personal account. If the error is global, the information will be on the status page.
504Gateway Time-outTimeout for receiving data from the source. Try checking the status of video sending/ingesting and transcoding.
+ + + +The system health status page is available at [https://status.gcore.com/](https://status.gcore.com/) + + diff --git a/documentation/streaming-platform/troubleshooting/live-streaming-issues.md b/documentation/streaming-platform/troubleshooting/live-streaming-issues.md new file mode 100644 index 000000000..fc4268426 --- /dev/null +++ b/documentation/streaming-platform/troubleshooting/live-streaming-issues.md @@ -0,0 +1,30 @@ +--- +title: live-streaming-issues +displayName: Live streaming issues +published: true +order: 30 +pageTitle: Solving Live Streaming Issues | Gcore +pageDescription: An explanation of common basic checks to address issues that may arise when working with Live Streaming. +--- + +# Live Streaming issues + +Common issues you may encounter when working with Live Streaming, as well as steps you can take to troubleshoot them. + +## Low latency mode has a delay of more than 5 seconds + +_Possible cause_: The player does not support the DASH.JS library. +_Suggested solution_: Our low latency solution has a latency of 4-5 seconds. If the delay is more than 5 seconds: + +- Make sure that the player supports the DASH.JS library. +- Try testing your low latency stream at the open source DASH.JS player. + +## Current broadcast contains DVR chunks of the previous broadcast + +_Possible cause_: The broadcast is over, but the stream has not been stopped. +_Suggested solution_: This is a normal behavior. + +To avoid this situation: + +- Stop the stream when the broadcast is finished. +- Delete the DVR archive before starting a new broadcast. diff --git a/documentation/streaming-platform/troubleshooting/real-time-video-issues/metadata.md b/documentation/streaming-platform/troubleshooting/real-time-video-issues/metadata.md index f58e926c7..7ad82f203 100644 --- a/documentation/streaming-platform/troubleshooting/real-time-video-issues/metadata.md +++ b/documentation/streaming-platform/troubleshooting/real-time-video-issues/metadata.md @@ -1,6 +1,6 @@ --- title: metadata -displayName: WebRTC common issues +displayName: WebRTC issues published: true -order: 20 +order: 50 --- diff --git a/documentation/streaming-platform/troubleshooting/solve-common-streaming-platform-issues.md b/documentation/streaming-platform/troubleshooting/solve-common-streaming-platform-issues.md deleted file mode 100644 index 64a310fb3..000000000 --- a/documentation/streaming-platform/troubleshooting/solve-common-streaming-platform-issues.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: solve-common-streaming-platform-issues -displayName: Streaming issues -published: true -order: 10 -toc: - --1--General troubleshooting steps: "general-troubleshooting-steps" - --1--Other common issues and solutions: "other-common-issues-and-solutions" - --2--Playback: "playback" - --2--Upload: "upload" - --2--Player: "player" - --1--Open a support ticket: "open-a-support-ticket" -pageTitle: Solving Video Streaming Issues | Gcore -pageDescription: An explanation of common basic checks to address issues that may arise when working with a Video Streaming. ---- - -# Solve common Video Streaming issues - -We are covering some issues you may encounter when working with both Live and VOD streams, as well as steps you can take to troubleshoot them. - -## General troubleshooting steps - -For the most common issues, such as video not playing, taking a long time to start streaming, or looking blurry, these basic checks should help: - -- **Status page**. Check if the issue you are experiencing is related to any known issue or is an isolated one by visiting the status page. -- **Source video**. Ensure that the source content is uploaded for streaming. If the same issue occurs in the source, re-upload the video or restart the stream. -- **Stream URL and code**. Make sure to use the exact URL and embed code that appear in the Streaming settings. -- **Streaming settings**. Make sure the stream is enabled. If configured to pull a stream, make sure the source URL is correct. -- **Encoder settings**. Make sure you are using the recommended settings. If configured to push a stream, make sure the server URL and stream key are accurate. - -Other things to try: - -- Clear the browsing data. -- Disable any interfering browser extensions. -- Ensure that the network connection is stable. Try connecting with or without a VPN. -- Verify that the streaming ports are open on the firewall. -- Update the browser or device OS. - -## Other common issues and solutions - -### Playback - -**Stream does not appear on some devices** - -*Possible cause*: Device is too old. -*Suggested solution*: Streaming should work on most devices, but some devices may not be compatible. Try using a modern device with enough processing power and memory to successfully stream video. - -**Stream returns an HTTP 404 error** - -*Possible cause*: Transcoding is in progress. -*Suggested solution*: Each video chunk may take several seconds to transcode. Allow 10 to 15 seconds for this to happen. Once the chunks have been transcoded, the stream should be ready to play. - -*Possible cause*: Low Latency is not enabled in the Customer Portal. -*Suggested solution*: Contact our [support team](mailto:support@gcore.com) to activate this option. - -**Stream returns an HTTP 502 error** - -*Possible cause*: CDN resource settings have been changed from the preset settings. -*Suggested solution*: Contact our [support team](mailto:support@gcore.com) to assist you in restoring the settings. - -*Possible cause*: Token configuration is not synchronized. -*Suggested solution*: Contact our [support team](mailto:support@gcore.com) to help you restore the settings. - -**Current broadcast contains DVR chunks of the previous broadcast** - -*Possible cause*: The broadcast is over, but the stream has not been stopped. -*Suggested solution*: This is a normal behavior. - -To avoid this situation: - -- Stop the stream when the broadcast is finished. -- Delete the DVR archive before starting a new broadcast. - -**Low latency mode has a delay of more than 5 seconds** - -*Possible cause*: The player does not support the DASH.JS library. -*Suggested solution*: Our low latency solution has a latency of 4-5 seconds. If the delay is more than 5 seconds: - -- Make sure that the player supports the DASH.JS library. -- Try testing your low latency stream at the open source DASH.JS player. - -### Upload - -**Video is not uploaded** - -*Possible cause*: Upload has been interrupted by closing or reloading the window. -*Suggested solution*: Try uploading again and be careful not to interrupt the process. If the size of the video is more than 500 MB, the upload will resume where it left off. - -*Possible cause*: Not enough storage space to complete the upload. -*Suggested solution*: Confirm in the Storage statistics that you have used up your storage. Contact our [support team](mailto:support@gcore.com) to increase the storage space. - -**Upload to the Gcore Customer Portal is interrupted by a session timeout (force logout)** - -*Possible cause*: Video is too large to upload through UI. -*Suggested solution*: - -- Upload during late night or early morning hours when there is less load on the queue. -- Upload a small batch of videos (e.g., 10 at a time). -- Upload via API. - -**Upload is stuck in the Processed state for a long time** - -*Possible cause*: Processing queue is too long or loaded with large videos. -*Suggested solution*: Wait a while and then try uploading again. - -### Player - -**No sound when using Gcore player** - -*Possible cause*: The audio is encoded with an unsupported codec. -*Suggested solution*: Set the audio codec to AAC. Note that if you are using Adobe FMLE on Windows, you need to purchase an AAC encoder plugin in order to use the AAC audio format. - -**Selected Gcore player does not render on the page** - -*Possible cause*: Some parameters have been added to the URL in the embed code. -*Suggested solution*: Contact our [support team](mailto:support@gcore.com) to troubleshoot the issue further. - -**No playback controls on the Gcore player** - -*Possible cause*: Disable Skin is active. -*Suggested solution*: Turn this option off. - -## Open a support ticket - -If none of the above work or apply to your issue, contact our [support team](mailto:support@gcore.com) with the following information: - -1. Link to the stream. -2. Description of the issue and steps to reproduce. -3. List of steps taken to troubleshoot the issue. -4. Screenshot of the information shown in http://iam.gcdn.co/info. -5. Screenshot of the response to this command: - -``` -curl http://iam.gcdn.co/info/json -``` -6. Screenshot of the speed test result using http://iam.gcdn.co/info. -7. HAR file. This page describes how to generate one in Chrome, Firefox, and Edge. \ No newline at end of file diff --git a/documentation/streaming-platform/troubleshooting/vod-issues.md b/documentation/streaming-platform/troubleshooting/vod-issues.md new file mode 100644 index 000000000..a5063ba74 --- /dev/null +++ b/documentation/streaming-platform/troubleshooting/vod-issues.md @@ -0,0 +1,34 @@ +--- +title: vod-issues +displayName: VOD issues +published: true +order: 40 +pageTitle: Solving VOD Issues | Gcore +pageDescription: An explanation of common basic checks to address issues that may arise when working with VOD. +--- + +# VOD issues + +Common issues you may encounter when working with VOD, as well as steps you can take to troubleshoot them. + +## Video is not uploaded + +_Possible cause_: Upload has been interrupted by closing or reloading the window. +_Suggested solution_: Try uploading again and be careful not to interrupt the process. If the size of the video is more than 500 MB, the upload will resume where it left off. + +_Possible cause_: Not enough storage space to complete the upload. +_Suggested solution_: Confirm in the Storage statistics that you have used up your storage. Contact our [support team](mailto:support@gcore.com) to increase the storage space. + +## Upload to the Gcore Customer Portal is interrupted by a session timeout (force logout) + +_Possible cause_: Video is too large to upload through UI. +_Suggested solution_: + +- Upload during late night or early morning hours when there is less load on the queue. +- Upload a small batch of videos (e.g., 10 at a time). +- Upload via API. + +## Upload is stuck in the Processed state for a long time + +_Possible cause_: Processing queue is too long or loaded with large videos. +_Suggested solution_: Wait a while and then try uploading again.