SRT feature release update

Author: foltra-nc

docs/assets/obs-srt-eu.png

@@ -46,8 +46,9 @@ Live encoding/ingest is supported with:
 
 - ingest with your own **H264/AAC/RTMP Live Encoders** (e.g. OBS, Wirecast, Hardware Encoders)
 - ingest with plugin-free web based **nanoStream Webcaster** broadcaster incl. screen sharing
+- ingest via protocols RTMP and SRT.
 - ingest with our **nanoStream Apps/SDKs** (nanoStream Apps for Win/Mac/iOS/Android),
-- other formats like RTSP, SRT available upon request
+- other formats like RTSP available upon request
 
 ## Live Playback with H5Live
 Live Playback is supported with our unique H5Live player. The same player code runs on all browsers.

docs/assets/obs-srt-sa.png

@@ -0,0 +1,186 @@
+---
+id: srt_ingest
+title: nanoStream Cloud SRT Ingest Guide
+sidebar_label: SRT Ingest
+---
+
+# **Introduction**
+
+Thank you for your interest in SRT (Secure Reliable Transport) streaming on nanoStream cloud. We are glad that you can start using this new feature. 
+
+> ## **Feedback**
+> We welcome any feedback that can help us improve the service. Send an email to [support@nanocosmos.de](mailto:support@nanocosmos.de) with subject **SRT feedback program** and do share with us the following information:
+> - Encoding or streaming software being used and hardware equipment setup.
+> - Video and audio encoding, or streaming parameters being used. For example: format, resolution, bit-rate, and so on.
+> - Full test results with description of expected outcomes and issues encountered.
+> - All issues reported must contain a time frame in UTC and relevant stream names.
+
+
+# **SRT Setup Guide**
+
+The SRT setup will require creating a new stream or making use of an existing stream in your organization account for publishing and viewing. In this workflow, SRT streaming protocol will be used for ingest while playing back with H5Live player or RTMP protocol. *SRT playback* is not supported at the moment.
+
+## **Ingest**
+
+### Supported Formats and Codecs
+
+|                   |                                                        |
+|-------------------|--------------------------------------------------------|
+| **Stream format** | MPEG-TS                                                |
+| **Track count**   | Single channel of video and/or single channel of audio |
+| **Video codec**   | H.264                                                  |
+| **Audio codec**   | AAC                                                    |
+
+### Server Domains and Port
+
+| Global domain (preferred) | bintu-srt.nanocosmos.de    |
+|---------------------------|----------------------------|
+| **Europe domain**         | bintu-srt-eu.nanocosmos.de |
+| **North America domain**  | bintu-srt-us.nanocosmos.de |
+| **South America domain**  | bintu-srt-sa.nanocosmos.de |
+| **Port number**           | 5000                       |
+
+### SRT Stream Id
+
+SRT stream id format definition: `prefix:streamname[:postfix]`
+- prefix: `push` for ingest or publish action
+- streamname: existing Bintu stream name in the form `XXXXX-YYYYY`
+- suffix: `record` to enable VOD recording of a live stream (optional)
+
+**Stream Id limitations**
+
+ - The SRT protocol specification limits the Stream Id length to 512 characters.
+ - Allowed character set in SRT Stream Ids: `a-z`,`A-Z`,`0-9`,`?`,`&`,`=`,`-`,`_`,`,` plus delimiter `:`. 
+ - Colon delimiter `:` is permited on the stream id, **not** on stream name **nor** stream name parameters. 
+ - Percent sign `%` is only allowed in the context of URL encoding.
+
+**Stream Id examples**
+
+Replace `XXXXX-YYYYY` with an existing Bintu stream name.
+
+Basic push: \
+`push:XXXXX-YYYYY`
+
+Push with vod recording: \
+`push:XXXXX-YYYYY:record`
+
+Push with stream name parameters: \
+`push:XXXXX-YYYYY?param1=one&param2=two`
+
+Push with stream name parameters and VOD recording: \
+`push:XXXXX-YYYYY?param1=one&param2=two:record`
+
+> **Note:**
+> Some streaming applications where the SRT stream id needs to be configured as part of a URL,
+> for example _OBS Studio_, may require the stream name parameters to use URL encoding.
+> The URL encoding can be applied to the entire Stream Id or stream name parameters only.
+> The URL encoded parts will be decoded accordingly on the server side.<br>
+> See the following examples:
+
+Push with URL encoded stream id: <br>
+`push%3AXXXXX-YYYYY%3Fparam1%3Done%26param2%3Dtwo`
+
+Push with URL encoded stream name parameters: <br>
+`push:XXXXX-YYYYY%3Fparam1%3Done%26param2%3Dtwo`
+
+Push with URL encoded stream name parameters and VOD recording:<br>
+`push:XXXXX-YYYYY%3Fparam1%3Done%26param2%3Dtwo:record`
+
+### Ingest Parameters
+
+|                           |                                                                                                                                               |
+|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| **SRT mode**              | caller                                                                                                                                        |
+| **SRT transmission type** | live                                                                                                                                          |
+| **SRT latency**           | Default is **500ms**. Higher values can be used to maintain more buffer and will help to reduce packet drop in lossy transmission situations. |
+| **SRT timeout**           | Recommended is **1 second**. Higher values can solve connect issues in case of longer routing distances or high round trip times (RTT).       |
+| **SRT stream id**         | See [Above](#srt-stream-id).                                                                                                                  |
+
+### Example of Setup using OBS Studio
+
+OBS Studio is able to support SRT streaming in versions 25.0 or newer and has the flexibility of fine tuning capabilities.
+You can refer more here: [SRT Protocol Streaming Guide](https://obsproject.com/de/kb/srt-protocol-streaming-guide#stream-with-srt. "OBS SRT Protocol Streaming Guide")
+
+> **Note:**<br>
+> OBS expects timeout and latency values in microseconds, that is, seconds ⨉ 1000000.
+
+### Ingest Address
+#### **Global Ingest Domain (Recommended)**
+
+Setup server with:
+```http
+srt://bintu-srt.nanocosmos.de:5000?mode=caller&latency=500000&timeout=1000000&transtype=live&streamid=push:XXXXX-YYYYY
+```
+
+![](assets/obs-srt.png)
+
+#### **For Europe Domain**
+
+Setup server with:
+```http
+srt://bintu-srt-eu.nanocosmos.de:5000?mode=caller&latency=500000&timeout=1000000&transtype=live&streamid=push:XXXXX-YYYYY
+```
+
+![](assets/obs-srt-eu.png)
+
+#### **For North America Domain**
+
+Setup server with:
+```http
+srt://bintu-srt-us.nanocosmos.de:5000?mode=caller&latency=500000&timeout=1000000&transtype=live&streamid=push:XXXXX-YYYYY
+```
+
+![](assets/obs-srt-us.png)
+
+#### **For South America Domain**
+
+Setup server with:
+```http
+srt://bintu-srt-sa.nanocosmos.de:5000?mode=caller&latency=500000&timeout=1000000&transtype=live&streamid=push:XXXXX-YYYYY
+```
+
+![](assets/obs-srt-sa.png)
+
+Whereby `XXXXX-YYYYY` is an existing Bintu stream name in your organization account and `latency`, and`timeout` values provided in **microseconds**.
+
+### **Stream Transcoding and ABR**
+
+If your organization account has transcoding feature enabled you may set up ABR with SRT. Just use the pass-through stream name for SRT ingest.
+
+## **Playback**
+
+SRT playback is not supported at the moment.
+Playback is possible using the H5live Player or through RTMP protocol.
+
+### **Using H5Live Player**
+
+For a single bit-rate stream, the ingested stream can be played out with the following playback URL: 
+
+
+```http
+https://demo.nanocosmos.de/nanoplayer/release/nanoplayer.html?entry.rtmp.streamname=XXXXX-YYYYY
+```
+
+Whereby `XXXXX-YYYYY` is the Bintu stream name previously set up for SRT ingest.
+
+For ABR playback, you can setup a stream group on the latest dashboard v3.
+Find more information following the video guide in the link: 
+
+[How To Setup Streamgroups Through V3 Dashboard](./how_to_setup_streamgroups.md)
+
+For the corresponding stream group setup, find the player configuration here:
+
+[Stream group configuration](../nanoplayer/nanoplayer_feature_stream_group_configuration.md)
+
+If you are on a secure Bintu organization account, you will find information on playback with secure parameters here:
+
+[Secure playback with H5Live](../nanoplayer/nanoplayer_token_security.md)
+
+### **Using RTMP**
+
+Following, an example using RTMP protocol playback with _ffplay_ from the _ffmpeg_ project on the command line:
+
+```sh
+ffplay rtmp://bintu-play.nanocosmos.de/play/XXXXX-YYYYY
+```
+Whereby `XXXXX-YYYYY` is the Bintu stream name that was configured in the SRT ingest.

docs/assets/obs-srt-us.png

@@ -42,4 +42,4 @@ You need a nanoStream Cloud/Bintu account with nanoMeet enabled.
 
 This sample lets you intialize your created nanoMeet room. If you dont use this sample as a moderator but as a participant you will not be able to see the "Moderator Functions" like "Invite Participant", "Security Options" and "Broadcast Settings".
 
-![nanoMeet Meeting](assets/nanomeet-meeting.jpg)
+![nanoMeet Meeting](assets/nanomeet-meeting.jpg)

docs/assets/obs-srt.png

@@ -1,3 +1,4 @@
 mkdir -p docs/assets
 cp -n docs/cloud-frontend/assets/* docs/assets/
 cp -n docs/nanomeet/assets/* docs/assets/
+cp -n docs/test-programs/srt/assets/* docs/assets/

docs/cloud/cloud_overview.md

@@ -18,6 +18,10 @@
       "cloud-frontend/How_to_Log_in_to_the_nanoStream_Cloud": {
         "title": "cloud-frontend/How_to_Log_in_to_the_nanoStream_Cloud"
       },
+      "cloud-frontend/How_to_Setup_Low_Latency_Stream": {
+        "title": "How to Setup a Low Latency Stream",
+        "sidebar_label": "How to Setup a Low Latency Stream"
+      },
       "cloud-frontend/How_to_Start_a_Stream": {
         "title": "How to start a stream",
         "sidebar_label": "Start streaming"
@@ -50,6 +54,10 @@
         "title": "Cloud Dashboard Overview",
         "sidebar_label": "Cloud Dashboard Overview"
       },
+      "cloud/analytics_for_low_latency_streams": {
+        "title": "Analytics For Low Latency Streams",
+        "sidebar_label": "Analytics For Low Latency Streams"
+      },
       "cloud/analytics-api": {
         "title": "nanoStream Cloud Analytics",
         "sidebar_label": "Analytics API"
@@ -86,10 +94,22 @@
         "title": "iOS Streaming App in 5 Minutes",
         "sidebar_label": "iOS Streaming App in 5 Minutes"
       },
+      "cloud/cloud_news": {
+        "title": "nanoStream Cloud Latest News",
+        "sidebar_label": "Latest News"
+      },
       "cloud/cloud_overview": {
         "title": "nanoStream Cloud Product and Services Overview",
         "sidebar_label": "Overview"
       },
+      "cloud/how_to_setup_ingest_security": {
+        "title": "How To Setup Ingest Security For Your Live Streams",
+        "sidebar_label": "How To Setup Ingest Security For Your Live Streams"
+      },
+      "cloud/how_to_setup_streamgroups": {
+        "title": "How To Setup Streamgroups Through V3 Dashboard",
+        "sidebar_label": "How To Setup Streamgroups Through V3 Dashboard"
+      },
       "cloud/live_encoding": {
         "title": "Live Encoding",
         "sidebar_label": "Live Encoding"
@@ -105,14 +125,14 @@
         "title": "Network Diagnostics",
         "sidebar_label": "Network Diagnostics"
       },
-      "cloud/cloud_news": {
-        "title": "nanoStream Cloud Latest News",
-        "sidebar_label": "Latest News"
-      },
       "cloud/security": {
         "title": "nanoStream Cloud Security",
         "sidebar_label": "nanoStream Cloud Security"
       },
+      "cloud/srt_ingest": {
+        "title": "nanoStream Cloud SRT Ingest Guide",
+        "sidebar_label": "SRT Ingest"
+      },
       "cloud/support": {
         "title": "Support",
         "sidebar_label": "Support"
@@ -290,6 +310,10 @@
         "title": "Stream switching and ABR",
         "sidebar_label": "Stream switching and ABR"
       },
+      "nanoplayer/nanoplayer_feature_video_access_and_processing": {
+        "title": "Video Access and Processing",
+        "sidebar_label": "Video Access and Processing"
+      },
       "nanoplayer/nanoplayer_getting_started": {
         "title": "Getting started",
         "sidebar_label": "Getting started"
@@ -331,6 +355,14 @@
         "title": "Secure playback with H5Live",
         "sidebar_label": "Secure playback with H5Live"
       },
+      "nanoplayer/nanoplayer_tutorial_how_to_setup_latency_modes": {
+        "title": "How to Setup Optimal Latency Modes for Streaming",
+        "sidebar_label": "How to Setup Optimal Latency Modes for Streaming"
+      },
+      "nanoplayer/nanoplayer_tutorial_how_to_setup_player_security": {
+        "title": "Implement Playback Security For Your Live Streams",
+        "sidebar_label": "Implement Playback Security For Your Live Streams"
+      },
       "nanoplayer/nanoplayer_update_source": {
         "title": "update source",
         "sidebar_label": "update source"
@@ -782,6 +814,7 @@
       "Cloud Dashboard": "Cloud Dashboard",
       "Bintu API": "Bintu API",
       "Support": "Support",
+      "Video Tutorials": "Video Tutorials",
       "nanoStream SDKs/Apps": "nanoStream SDKs/Apps",
       "Android": "Android",
       "iOS": "iOS",

docs/cloud/srt_ingest.md

@@ -76,10 +76,11 @@
   "cloud": {
     "nanoStream Cloud": [
       "cloud/cloud_overview",
-	  "cloud/cloud_news",
+      "cloud/cloud_news",
       "cloud/cloud_introduction",
       "cloud/cloud_getting_started",
       "cloud/live_encoding",
+      "cloud/srt_ingest",
       "cloud/live-recording-vod",
       "cloud/security",
       {