YD_AiBasicProject/sdks/Yztob.AiSports.Sensors.xml
2025-09-10 13:53:07 +08:00

381 lines
15 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0"?>
<doc>
<assembly>
<name>Yztob.AiSports.Sensors</name>
</assembly>
<members>
<member name="T:Yztob.AiSports.Sensors.Abstractions.CameraProtocol">
<summary>
相机操控协议
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Abstractions.CameraProtocol.Local">
<summary>
本机设备本机连接USB、自带等相机
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Abstractions.CameraProtocol.RTSP">
<summary>
实时流传输协议(Real Time Streaming Protocol RTSP)
</summary>
</member>
<member name="T:Yztob.AiSports.Sensors.Abstractions.CameraStatus">
<summary>
相机设备状态
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Abstractions.CameraStatus.Unknown">
<summary>
状态未知
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Abstractions.CameraStatus.Initialized">
<summary>
设备连接已初始化
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Abstractions.CameraStatus.Connected">
<summary>
已连接
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Abstractions.CameraStatus.Closed">
<summary>
已关闭/已断开
</summary>
</member>
<member name="T:Yztob.AiSports.Sensors.Abstractions.FrameExtracted">
<summary>
抽到帧回调到响应委托
</summary>
<param name="frame">提取的视频帧</param>
</member>
<member name="T:Yztob.AiSports.Sensors.Abstractions.WebcamClient">
<summary>
网络相机抽象客户端
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Abstractions.WebcamClient.#ctor(Yztob.AiSports.Sensors.Abstractions.CameraProtocol)">
<summary>
初始化相机客户端
</summary>
<param name="protocol">相机协议</param>
</member>
<member name="P:Yztob.AiSports.Sensors.Abstractions.WebcamClient.Protocol">
<summary>
获取当前客户端支持的协议
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Abstractions.WebcamClient.Status">
<summary>
获取或设置当前设备状态
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Abstractions.WebcamClient.OnExtractFrame">
<summary>
获取或设置帧处理回调
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Abstractions.WebcamClient.Connect">
<summary>
连接当前设备
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Abstractions.WebcamClient.Disconnect">
<summary>
断开设备设备连接
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Abstractions.WebcamClient.StartExtract">
<summary>
开始抽取帧图像
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Abstractions.WebcamClient.StopExtract">
<summary>
停止抽取帧图像
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Abstractions.WebcamClient.Dispose">
<summary>
释放当前设备资源
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Abstractions.WebcamClient.CreateRTSP(System.String,System.String,System.String,System.UInt32)">
<summary>
创建RTSP客户端实例
</summary>
<param name="host">主机名/IP地址</param>
<param name="port">端口号</param>
<param name="userName">用户名</param>
<param name="password">密码</param>
<returns></returns>
</member>
<member name="T:Yztob.AiSports.Sensors.Implement.Extensions">
<summary>
一些扩展方法
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.Extensions.ResolvingAVStringError(System.Int32)">
<summary>
调用av_strerror解析错误说明
</summary>
<param name="error">错误代码地址</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.Extensions.ThrowExceptionIfError(System.Int32)">
<summary>
如果AV相关函数执行有错误则抛异常
</summary>
<param name="error">错代码地址</param>
<returns></returns>
<exception cref="T:System.ApplicationException">抛出程序异常</exception>
</member>
<member name="T:Yztob.AiSports.Sensors.Implement.FFmpegLoader">
<summary>
FFmpeg框架加载器
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.FFmpegLoader.RegisterFFmpegBinaries">
<summary>
注册FFmpeg二进制库
</summary>
<exception cref="T:System.NotSupportedException">非windows平台时引发</exception>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.FFmpegLoader.Initiailze">
<summary>
初始化FFmpeg类库
</summary>
</member>
<member name="T:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient">
<summary>
RTSP协议网络相机客户端
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.#cctor">
<summary>
全局初始化
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.#ctor(System.String,System.UInt32,System.String,System.String)">
<summary>
初始化RTSP相机客户端
</summary>
<param name="host">相机主机名、IP</param>
<param name="port">端口号</param>
<param name="userName">用户名</param>
<param name="password">密码</param>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.Extracting">
<summary>
执行抽帧
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.Connect">
<inheritdoc />
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.Disconnect">
<inheritdoc />
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.StartExtract">
<inheritdoc />
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.StopExtract">
<inheritdoc />
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.RTSPWebcamClient.Dispose">
<inheritdoc />
</member>
<member name="T:Yztob.AiSports.Sensors.Implement.VideoFrameConverter">
<summary>
视频帧格式转换器
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.VideoFrameConverter.#ctor(System.Drawing.Size,FFmpeg.AutoGen.Abstractions.AVPixelFormat,System.Drawing.Size,FFmpeg.AutoGen.Abstractions.AVPixelFormat)">
<summary>
初始化帧转换器
</summary>
<param name="sourceSize">帧原始大小</param>
<param name="sourcePixelFormat">帧图像像素格式</param>
<param name="destinationSize">目标大小</param>
<param name="destinationPixelFormat">目标像素格式</param>
<exception cref="T:System.ApplicationException">ffmpeg原始异常</exception>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.VideoFrameConverter.Convert(FFmpeg.AutoGen.Abstractions.AVFrame)">
<summary>
执行帧转
</summary>
<param name="sourceFrame">原始帧</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.VideoFrameConverter.Dispose">
<summary>
释放当前转换器资源
</summary>
</member>
<member name="T:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder">
<summary>
视频流解码器
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder.#ctor(System.String,FFmpeg.AutoGen.Abstractions.AVHWDeviceType)">
<summary>
初始化解码器
</summary>
<param name="url">设备访问url</param>
<param name="HWDeviceType">硬件设备类型</param>
</member>
<member name="P:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder.CodecName">
<summary>
获取解码器名称
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder.FrameSize">
<summary>
获取帧图像大小
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder.PixelFormat">
<summary>
获取帧格式
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder.TryDecodeNextFrame(FFmpeg.AutoGen.Abstractions.AVFrame@)">
<summary>
偿试获取流的下一帧
</summary>
<param name="frame">输出的图像帧</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder.GetContextInfo">
<summary>
获取当前帧格式信息
</summary>
<returns>帧上下文信息字典</returns>
</member>
<member name="M:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder.Dispose">
<summary>
释放当前解码器资源
</summary>
</member>
<member name="T:Yztob.AiSports.Sensors.Things.ImageFormat">
<summary>
图像格式
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Things.ImageFormat.Jpeg">
<summary>
jpg、jpeg格式
</summary>
</member>
<member name="F:Yztob.AiSports.Sensors.Things.ImageFormat.Png">
<summary>
png格式
</summary>
</member>
<member name="T:Yztob.AiSports.Sensors.Things.VideoFrame">
<summary>
表示一个视频帧
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Things.VideoFrame.#ctor(Yztob.AiSports.Sensors.Implement.VideoFrameConverter,System.Int32,System.Int32,FFmpeg.AutoGen.Abstractions.AVFrame)">
<summary>
初始化视频帧
</summary>
<param name="converter">帧格式转换器,由<seealso cref="T:Yztob.AiSports.Sensors.Implement.VideoStreamDecoder"/>提供</param>
<param name="width">帧宽度</param>
<param name="height">帧高度</param>
<param name="frame">ffpmeg帧数据指针</param>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrame.Number">
<summary>
获取或设置帧序号每次播放从0开始
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrame.Width">
<summary>
获取帧宽度,单位:像素
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrame.Height">
<summary>
获取帧高度,单位:像素
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrame.Frame">
<summary>
获取FFmpeg原始帧
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrame.Timestamp">
<summary>
获取或设置时间戳从UTC:2000-01-01开始的耗秒数
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Things.VideoFrame.GetImageBuffer(Yztob.AiSports.Sensors.Things.ImageFormat)">
<summary>
将当前帧转换成指定格式图像,并返回图像缓冲区数组
</summary>
<param name="format">要转换的格式</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Sensors.Things.VideoFrame.GetImageStream(Yztob.AiSports.Sensors.Things.ImageFormat)">
<summary>
将当前帧转换成指定格式图像,并获取二进制流
</summary>
<param name="format">要转换的目标格式</param>
<returns></returns>
</member>
<member name="T:Yztob.AiSports.Sensors.Things.VideoFrameWithBuffer">
<summary>
表示一个携带帧缓冲区的视频信息
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Things.VideoFrameWithBuffer.#ctor(System.Int32,System.Int32,System.Byte[])">
<summary>
初始化帧缓冲区的视频信息
</summary>
<param name="width">帧宽度</param>
<param name="height">帧高度</param>
<param name="buffer">帧缓冲区</param>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrameWithBuffer.Number">
<summary>
获取或设置帧序号每次播放从0开始
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrameWithBuffer.Width">
<summary>
获取帧宽度,单位:像素
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrameWithBuffer.Height">
<summary>
获取帧高度,单位:像素
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrameWithBuffer.Buffer">
<summary>
获取FFmpeg原始帧
</summary>
</member>
<member name="P:Yztob.AiSports.Sensors.Things.VideoFrameWithBuffer.Timestamp">
<summary>
获取或设置时间戳从UTC:2000-01-01开始的耗秒数
</summary>
</member>
<member name="T:Yztob.AiSports.Sensors.Utility">
<summary>
一些相关的公共工具方法
</summary>
</member>
<member name="M:Yztob.AiSports.Sensors.Utility.GetHWPixelFormat(FFmpeg.AutoGen.Abstractions.AVHWDeviceType)">
<summary>
根据<paramref name="hwDevice"/>返回相互格式
</summary>
<param name="hwDevice">解码设备类型</param>
<returns></returns>
</member>
</members>
</doc>