SharpRTSPtoWebRTC 0.0.13
dotnet add package SharpRTSPtoWebRTC --version 0.0.13
NuGet\Install-Package SharpRTSPtoWebRTC -Version 0.0.13
<PackageReference Include="SharpRTSPtoWebRTC" Version="0.0.13" />
<PackageVersion Include="SharpRTSPtoWebRTC" Version="0.0.13" />
<PackageReference Include="SharpRTSPtoWebRTC" />
paket add SharpRTSPtoWebRTC --version 0.0.13
#r "nuget: SharpRTSPtoWebRTC, 0.0.13"
#addin nuget:?package=SharpRTSPtoWebRTC&version=0.0.13
#tool nuget:?package=SharpRTSPtoWebRTC&version=0.0.13
SharpRTSP to WebRTC
This is a proof of concept bridge in between RTSP and WebRTC implemented in C#. It can take any H264/H265 RTSP stream and feed it through WebRTC to the web browser. It does not perform any video transcoding which makes it lightweight and portable. It does support audio transcoding from AAC to Opus, all implemented in netstandard and NET8 without any native dependencies.
What can it do?
- Re-stream H264/H265 RTSP from any source to the web browser
- Stream aggregation - there is only a single session in between the gateway and the RTSP source, no matter how many users are watching the stream
- Transcode AAC audio to Opus with a small latency in audio
Compatibility
Because no video transcoding is being performed, the web browsers must support decoding of the source video codecs in WebRTC.
H264
This should be supported by the majority of web browsers as it is among the codecs required by WebRTC. There might be an exception for Firefox on Android according to this: https://developer.mozilla.org/en-US/docs/Web/Media/Formats/WebRTC_codecs.
H265
Although most of the web browsers today support H265 video decoding, it does not mean H265 will also work in WebRTC. As of April 2025, H265 in WebRTC is supported in the latest releases of Safari. It is also supported in Chrome Canary 136+.
Samples
RTSPtoWebRTCGateway
There is a sample ASP.NET Core app that demonstrates the functionality on multiple live streams. To change the default configuration, just modify the appsettings.json
:
"Cameras": [
{
"Name": "name1",
"Url": "rtsp://url1",
"UserName": "MyUserName",
"Password": "MyPassword"
},
{
"Name": "name2",
"Url": "rtsp://url2",
"UserName": null,
"Password": null
}
]
Minimal example
In Startup.cs
, add the following piece of code to register the RTSPtoWebRTCProxyService
:
builder.Services.AddSingleton<RTSPtoWebRTCProxyService>();
Then (optionally) add the configuration of streams from appsettings.json
:
builder.Services.Configure<List<CameraConfiguration>>(builder.Configuration.GetSection("Cameras"));
Implement a minimal WebRTC signalling controller, for instance:
[ApiController]
[Route("api/[controller]")]
public class WebRTCController : ControllerBase
{
private readonly IList<CameraConfiguration> _cameras;
private readonly RTSPtoWebRTCProxyService _webRTCServer;
public WebRTCController(IOptions<List<CameraConfiguration>> cameras, RTSPtoWebRTCProxyService webRTCServer)
{
_cameras = cameras.Value;
_webRTCServer = webRTCServer;
}
[HttpGet]
[Route("getcameras")]
public IActionResult GetCameras()
{
return Ok(_cameras.Select(x => x.Name).ToList());
}
[HttpGet]
[Route("getoffer")]
public async Task<IActionResult> GetOffer(string id, string name)
{
return Ok(await _webRTCServer.GetOfferAsync(id, camera.Url, camera.UserName, camera.Password, camera.StartPort, camera.EndPort));
}
[HttpPost]
[Route("setanswer")]
public IActionResult SetAnswer(string id, [FromBody] RTCSessionDescriptionInit answer)
{
_webRTCServer.SetAnswer(id, answer);
return Ok();
}
[HttpPost]
[Route("addicecandidate")]
public IActionResult AddIceCandidate(string id, [FromBody] RTCIceCandidateInit iceCandidate)
{
_webRTCServer.AddIceCandidate(id, iceCandidate);
return Ok();
}
}
Finally, for the WebRTC viewer you can refer to src/rtsptowebrtc.client/src/CameraViewer.jsx
.
Hosting on a public IP address
It is recommended to use a TURN server such as https://github.com/coturn/coturn when hosting this project on the Internet.
To host this project on a public IP address without using a TURN server, you will have to configure port ranges (StartPort
, EndPort
) for each camera in appsettings.json
. Then you have to configure port forwarding of all the ports in the configured port ranges to this server + port forwarding for the web application.
In some cases, you might also want to configure your server public IP address to be included in the ICE candidates. You can use PublicIPv4
and PublicIPv6
in appsettings.json
for this purpose.
Credits
- sipsorcery - WebRTC implementation in netstandard which has made this project possible https://github.com/sipsorcery-org/sipsorcery
- SharpRTSP - RTSP client https://github.com/ngraziano/SharpRTSP
- concentus - Opus codec implementation https://github.com/lostromb/concentus
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Concentus (>= 2.2.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- SharpJaad.AAC (>= 0.0.6)
- SharpRTSPClient (>= 0.1.0)
- SIPSorcery (>= 8.0.11)
- System.Net.Http (>= 4.3.4)
- System.Net.Security (>= 4.3.2)
-
net8.0
- Concentus (>= 2.2.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- SharpJaad.AAC (>= 0.0.6)
- SharpRTSPClient (>= 0.1.0)
- SIPSorcery (>= 8.0.11)
- System.ServiceModel.Http (>= 8.1.2)
- System.ServiceModel.Primitives (>= 8.1.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.0.13 | 51 | a day ago |
0.0.12 | 41 | 2 days ago |
0.0.11 | 44 | 2 days ago |
0.0.10 | 127 | 6 days ago |
0.0.8 | 65 | 9 days ago |
0.0.6 | 305 | 5 months ago |
0.0.5 | 375 | 10 months ago |
0.0.3-alpha | 172 | 1/24/2024 |
0.0.2-alpha | 182 | 12/14/2023 |
0.0.1-alpha | 160 | 6/4/2023 |