Skip to content

Latest commit

 

History

History
83 lines (67 loc) · 3.27 KB

README.md

File metadata and controls

83 lines (67 loc) · 3.27 KB
Raw

Logo C# RTSP Client for .NET

NuGet version (RtspClientSharp) Build Status

This repo contains C# RTSP client implementation (called "RtspClientSharp") for .NET Standard 2.0

Features

  • Supported transport protocols: TCP/HTTP/UDP
  • Supported media codecs: H.264/MJPEG/AAC/G711A/G711U/PCM/G726
  • No external dependencies, pure C# code
  • Asynchronous nature with cancellation tokens support
  • Designed to be fast and scaleable
  • Low GC pressure during receive stage (when RTSP session is established); low amount of freezes under high load

Installation

The easiest way to get started is to use the NuGet package for RtspClientSharp

You can install using NuGet like this:

nuget install RtspClientSharp

Or select it from the NuGet packages UI on Visual Studio.

On Visual Studio, make sure that you are targeting .NET 4.6.1/.NET Core 2.0 or later, as this package uses some features of newer .NETs. Otherwise, the package will not be added. Once you do this, you can just use the RtspClientSharp nuget

Alternatively, you can download it directly.

Using RtspClientSharp

Something like this:

var serverUri = new Uri("rtsp://192.168.1.77:554/ucast/11");
var credentials = new NetworkCredential("admin", "123456");
var connectionParameters = new ConnectionParameters(serverUri, credentials);
connectionParameters.RtpTransport = RtpTransportProtocol.TCP;
using(var rtspClient = new RtspClient(connectionParameters))
{
    rtspClient.FrameReceived += (sender, frame) =>
    {
        //process (e.g. decode/save to file) encoded frame here or 
        //make deep copy to use it later because frame buffer (see FrameSegment property) will be reused by client
        switch (frame)
        {
            case RawH264IFrame h264IFrame:
            case RawH264PFrame h264PFrame:
            case RawJpegFrame jpegFrame:
            case RawAACFrame aacFrame:
            case RawG711AFrame g711AFrame:
            case RawG711UFrame g711UFrame:
            case RawPCMFrame pcmFrame:
            case RawG726Frame g726Frame:
               break;
        }
    }
	
    await rtspClient.ConnectAsync(token);
    await rtspClient.ReceiveAsync(token);
}

You could find more complex samples here (e.g. simple RTSP player with full frame decoding and rendering processes): https://github.com/BogdanovKirill/RtspClientSharp/tree/master/Examples

Donation

If this project help you reduce time to develop, you can give me a cup of coffee :) You could also make per-feature donations, write me to [email protected]

paypal

Backers

Thank you to all project backers! Especially for:

  • Roman Minyaylov
  • Dat Ta
  • Michael Norman

Sponsors

jetbrains