RtspViewer 2.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package RtspViewer --version 2.1.0
                    
NuGet\Install-Package RtspViewer -Version 2.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RtspViewer" Version="2.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RtspViewer" Version="2.1.0" />
                    
Directory.Packages.props
<PackageReference Include="RtspViewer" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RtspViewer --version 2.1.0
                    
#r "nuget: RtspViewer, 2.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package RtspViewer@2.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=RtspViewer&version=2.1.0
                    
Install as a Cake Addin
#tool nuget:?package=RtspViewer&version=2.1.0
                    
Install as a Cake Tool

RtspViewer

RTSP 视频显示与录制 WinForms 控件。RtspClientSharp 纯 C# 拉流 + Windows 自带 Media Foundation 解码/编码/封装,不再依赖 ffmpeg.exe,装包即用。

  • 分发体积仅约 0.16MB,且只有一个 RtspViewer.dll(RtspClientSharp 源码直接编入本程序集),旧版 ffmpeg.exe 为 22.8MB
  • 实时预览:RtspClientSharp 拉 RTP/H264,Media Foundation 硬/软解码,无第三方图像处理库
  • 三种录制方式:H264 直通封装(默认,最省 CPU)/ 目标码率 CBR / 质量档
  • 断流自动重连,RTSP 支持 tcp/udp 传输切换
  • 全部为系统组件与 MIT 库,无 GPL 传染

说明:RtspClientSharp 支持 H264/MJPEG/AAC/G711/G726,不支持 H265;H265 相机需另选拉流库。

安装

dotnet add package RtspViewer

RtspClientSharp(MIT)的源码直接编入 RtspViewer.dll(源码在解决方案 RtspClientSharp/ 目录,可随意修改,改完 dotnet pack 即出新包)。装包后引用目录里只有 RtspViewer.dll 一个文件,无任何原生二进制或其他依赖。

快速开始

using RtspViewer;

var video = new VideoDisplay
{
    Dock = DockStyle.Fill,
    VideoAddress = "rtsp://admin:123456@192.168.1.64:554/Streaming/Channels/102", // 建议用子码流
    RecordDirectory = "Recordings",
    RecordMode = RecordModeKind.Quality,  // 质量档:体积小画质够用;存档用 Direct 直通无损
};
Controls.Add(video);   // AutoStart=true,句柄创建后自动连接

video.IsRecording = true;    // 开始录制
video.IsRecording = false;   // 停止并保存 mp4

三种录制方式(RecordMode)

模式 说明 实测体积* CPU 适用
Direct(控件默认) H264 码流不解码、不重编码,直接封装进 MP4 4600 KB(≈4700 kbps) 最低 画质无损存档
Bitrate 解码后按 RecordBitrate 目标码率重编码,可缩放 330 KB(≈335 kbps) 中 需要精确统一码率
Quality(Demo 默认) 按 RecordQuality(1~100) 映射目标码率的 VBR 重编码 170 KB(≈175 kbps) 中 日常回查(推荐)

* 2560x1440 相机、8 秒实测;再编码两档均缩放 0.5(1280x720@15fps)。对照:旧 ffmpeg CRF28 方案约 60 KB(≈70 kbps)——Quality 档体积约为其 2~3 倍(微软软编在低码率下效率不如 x264),但画面清晰度相当,且完全脱离 ffmpeg.exe。

本机微软 H264 编码器的 ICodecAPI 为只读(SetValue 返回 E_NOTIMPL),码率控制经输出类型的 MT_AVG_BITRATE 生效;Quality 档的"质量→码率"映射已按 720p@15fps 标定:q50≈215kbps、 q75≈385kbps、q100≈560kbps。要更小体积:调低 RecordQuality / RecordFps / RecordScale。

常用属性

属性 默认 说明
VideoAddress - RTSP 流地址
AutoStart true 控件创建后自动连接
ReconnectInterval 1500 断流重连间隔(ms)
IsRecording false 置 true 开始录制,false 停止保存
RecordMode Direct 录制方式:Direct / Bitrate / Quality
RecordBitrate 400000 Bitrate 模式目标码率(bps)
RecordQuality 50 Quality 模式质量档(1~100)
RecordDirectory Recordings 录像保存目录;相对路径按程序(exe)目录解析,避免宿主进程工作目录不同导致文件写到别处
RecordFileName "" 自定义文件名,空=按时间戳命名;同名覆盖,没带 .mp4 自动补
RecordFps 15 录制帧率(不要超过相机实际帧率)
RecordScale 0.5 录制分辨率缩放,1=原始,0.5=宽高减半(Direct 直通时不缩放)
RecordFaststart true 录制结束把索引(moov)移到文件头,浏览器/播放器可直接拖放播放;超长录像会多一次文件重写,可关闭
PreviewFps 15 预览帧率上限(1~60),越低越省 CPU,不影响录像帧率
RtspTransport tcp tcp 稳定不花屏(推荐),udp 延迟低
IsConnected - (只读)是否已连接
FrameSize - (只读)当前视频分辨率
CurrentRecordFile - (只读)当前录制文件完整路径
LastError - (只读)最近一次录制/保存错误信息,无错误为空串

事件与方法

video.RecordSaved += (_, path) => Console.WriteLine("已保存: " + path);  // 录像成功保存(UI线程)
video.RecordError += (_, msg)  => Console.WriteLine("录像失败: " + msg);  // 录制/保存失败(UI线程)
video.Snapshot(@"D:\snap\a.jpg");   // 抓取当前画面存 JPG,无画面返回 false

录制失败不再静默:错误会叠加显示在画面左下角,并通过 RecordError 事件 / LastError 属性上报。 停止录制后立刻重新开始会被拒绝(上一段正在封存),画面会提示"上一段录像保存中"。

进一步缩小录像体积

  1. 相机切子码流:海康/大华地址把 Channels/101(主码流)改为 102(子码流,通常 640x360/480p), 直通模式下体积直接降到子码率,且几乎不占 CPU。
  2. 再编码场景用 RecordScale=0.5、降低 RecordFps(12~15)、调小 RecordBitrate 或 RecordQuality。

常见问题

画面花屏/丢帧 保持 RtspTransport=tcp;udp 延迟低但丢包会花屏。

录制停止后文件稍晚才定稿 录像定稿(写 moov)在拉流线程完成,停止录制后约一帧时间(几十~上百 ms)即落盘;程序关闭时会自动兜底定稿。

相机是 H265 RtspClientSharp 不支持 H265,需更换支持 H265 的拉流库。

许可证说明

  • RtspViewer.dll(控件代码):版权所有 (c) GreatBear,允许免费在项目(含商业项目)中引用使用;未经许可不得二次打包、转售或作为控件库再分发。
  • RtspClientSharp 源码(编入 RtspViewer.dll):版权所有 (c) Kirill Bogdanov,MIT 许可证。
  • Media Foundation:Windows 系统自带组件,不随包再分发。

完整文本见包内 LICENSE.txt。

Product Compatible and additional computed target framework versions.
.NET net8.0-windows7.0 is compatible.  net9.0-windows was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0-windows7.0

    • No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on RtspViewer:

Package Downloads
PCHMI

PCHMI工控组态控件,支持Modbus‑TCP、SIEMENS S7、KEYENCE HOSTLINK、PANASONIC MEWTOCOL、MITSUBISHI MC、OPC Ua、MQTT、BECKHOFF ADS、CODESYS V3、AB LogixE/IP、OMRON FINS E/IP等多种PLC通信协议,快速搭建上位机HMI画面。实时数据采集JSON、EXCEL、SQLITE、MYSQL、POSTGRESQL、SQLSERVER等统一数据库操作接口

PCHMI.Core

PCHMI工控组态控件,支持Modbus‑TCP、SIEMENS S7、KEYENCE HOSTLINK、PANASONIC MEWTOCOL、MITSUBISHI MC、OPC Ua、MQTT、BECKHOFF ADS、CODESYS V3、AB LogixE/IP、OMRON FINS E/IP等多种PLC通信协议,快速搭建上位机HMI画面。实时数据采集JSON、EXCEL、SQLITE、MYSQL、POSTGRESQL、SQLSERVER等统一数据库操作接口

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.1.8 267 10/17/2026
2.1.6 120 10/16/2026
2.1.1 119 10/15/2026
2.1.0 120 10/13/2026
1.0.5 146 10/4/2026
1.0.2 130 10/3/2026