AIPC Platform Python SDK

用户指南

  • 设备开通
    • 获得设备
    • 首次开机与登录
      • 找到设备
      • 登录 Web 控制台
      • SSH 与网页终端
    • aipc-cli：设备自带，无需安装
    • 下一步
  • 学习路径
    • 路径总览
    • 阶段 1 —— 首跑（5 分钟）
    • 阶段 2 —— 看每个核心模式活的样子（15 分钟）
    • 阶段 3 —— 拿来用（约 1 小时）
    • 阶段 4 —— 交付
    • 阶段 5 —— 查阅层（随时）
    • 卡住了？
  • 安装指南
    • 系统要求
    • 依赖项
    • 安装方法
      • 从 PyPI 安装
      • 从源码安装
      • 构建 Wheel 包
      • GitHub Actions Wheel Artifact
    • 验证安装
    • 开发环境安装
    • Docker 环境
    • 故障排除
      • 权限问题
      • gRPC 连接失败
      • 依赖冲突
  • 快速开始
    • 基本概念
    • 第一个应用
    • 配置环境变量
    • 核心功能示例
      • AI 推理
        • 单次推理
        • 流式推理
        • 模型管理
      • 事件总线
        • 发布事件
        • 订阅事件
      • 设备控制
        • 灯光控制
        • 云台控制
        • GPIO 控制
      • 视频流访问
    • 错误处理
    • 日志记录
    • 下一步
  • 应用镜像制作与导入指南
    • 概述
    • 步骤 1: 准备应用文件
      • 创建应用目录
      • 应用代码（app.py）
      • Dockerfile
      • 应用清单（app.yaml）
    • 步骤 2: 构建 Docker 镜像
    • 步骤 3: 导出镜像并打包 .neoapp
    • 步骤 4: Web Console 导入（推荐）
      • 打开导入对话框
      • 第 1 屏 — 选择来源
      • 第 2 屏 — 配置应用
      • 第 3 屏 — 安装进度
    • 步骤 5: 命令行导入（备选方案）
    • 应用清单参考（app.yaml）
      • 元数据（metadata）
      • 资源限制（spec.resources）
      • 权限配置（spec.permissions）
      • 生命周期配置
      • 健康检查（healthcheck）
    • 常见问题
      • 镜像构建失败
      • 应用包过大
      • 导入失败
      • 权限错误
  • 示例代码
    • 人员检测应用
    • 车辆计数应用
    • 智能灯光控制
    • 视频录制应用
    • 多模型融合应用

API 参考

  • AI 推理 API
    • InferenceClient
    • 数据类型
      • InferenceResult
      • BatchInferItem
        • BatchInferItem
      • DetectedObject
        • DetectedObject
      • BoundingBox
      • LandmarkPoint
        • LandmarkPoint
      • LandmarkSet
        • LandmarkSet
      • SegmentationMask
        • SegmentationMask
      • OcrLine
        • OcrLine
      • Embedding
        • Embedding
      • DepthMap
        • DepthMap
      • Classification
        • Classification
      • ModelInfo
        • ModelInfo
    • 使用示例
      • 单次推理
      • 流式推理
      • 张量推理
      • 模型管理
      • 获取统计信息
      • 会话管理
      • 处理不同类型的结果
      • 上下文管理器
      • 错误处理
      • 分割结果
      • OCR 结果
      • 嵌入 (CLIP 图像)
      • CLIP 文本编码
      • 深度估计
      • 运行时更新后处理配置
      • GenAI (LLM/VLM)
  • 视频流 API
    • FdMediaClient
    • 数据类型
      • Frame
      • FrameHandle
        • FrameHandle
      • StreamInfo
        • StreamInfo
      • PixelFormat
        • PixelFormat
      • EncodedStreamClient
        • EncodedStreamClient
      • EncodedFrame
        • EncodedFrame
    • 使用示例
      • 获取原始视频流
      • 不跳过帧
      • 获取单帧
      • 获取流信息
      • 列出可用流
      • 帧处理回调
      • 图像处理
      • 保存图像
      • 获取编码流
      • 多流处理
      • 帧率控制
      • 保存视频
      • 上下文管理器
      • 零拷贝访问
      • 错误处理
  • 事件总线 API
    • EventClient
    • 数据类型
      • Event
        • Event
      • TopicInfo
        • TopicInfo
    • 使用示例
      • 发布事件
      • 订阅事件
      • 使用回调函数
      • 主题通配符
      • 列出主题
      • 获取统计信息
      • 取消订阅
      • 事件过滤
      • 上下文管理器
      • 错误处理
  • 设备控制 API
    • DeviceClient
    • 数据类型
      • DeviceStatus
        • DeviceStatus
      • DeviceEvent
        • DeviceEvent
      • IrCutMode
        • IrCutMode
    • 使用示例
      • 灯光控制
      • 云台控制 (PTZ)
      • 预置位控制
      • 镜头控制
      • GPIO 控制
      • 韦根 (Wiegand) 控制
      • RS-485 串口控制
      • 获取设备状态
      • 监控设备事件
      • 上下文管理器
      • 错误处理
  • 应用管理器客户端
    • AppInfo
      • AppInfo.id
      • AppInfo.name
      • AppInfo.version
      • AppInfo.state
      • AppInfo.container_id
      • AppInfo.pid
      • AppInfo.installed_at
      • AppInfo.started_at
      • AppInfo.stopped_at
      • AppInfo.restart_count
      • AppInfo.manifest_path
      • AppInfo.instance_path
      • AppInfo.__init__()
    • AppStats
      • AppStats.app_id
      • AppStats.cpu_usage_percent
      • AppStats.memory_usage_bytes
      • AppStats.memory_limit_bytes
      • AppStats.thread_count
      • AppStats.uptime_seconds
      • AppStats.__init__()
    • LogLine
      • LogLine.timestamp
      • LogLine.level
      • LogLine.message
      • LogLine.datetime
      • LogLine.__init__()
    • AppClient
      • AppClient.register_web_url()
      • AppClient.install_app()
      • AppClient.start_app()
      • AppClient.stop_app()
      • AppClient.uninstall_app()
      • AppClient.restart_app()
      • AppClient.list_apps()
      • AppClient.get_app()
      • AppClient.get_app_stats()
      • AppClient.get_logs()
      • AppClient.get_logs_text()
    • 使用示例
      • 应用生命周期管理
      • 获取应用信息
      • 查看应用日志
      • 注册 Web 访问路径
      • 上下文管理器
  • 配置 API
    • Config
      • Config
        • Config.get_app_id()
        • Config.get_inference_endpoint()
        • Config.get_event_bus_endpoint()
        • Config.get_device_control_endpoint()
        • Config.get_shm_base_path()
        • Config.get_camera_control_endpoint()
        • Config.get_app_manager_endpoint()
        • Config.get_encoded_socket_dir()
        • Config.get_host_prefix()
        • Config.translate_path_to_host()
        • Config.is_debug()
        • Config.get_log_level()
    • 使用示例
      • 静态方法
      • 环境变量配置
  • DSP 硬件加速 API
    • DspClient
      • DspBufferPool
        • DspBufferPool
      • DspError
        • DspError
      • PendingDspJob
        • PendingDspJob
    • 使用示例
      • 整帧缩放（模型输入预处理）
      • 批量裁剪（letterbox 缩放）
      • 单区域裁剪
      • 格式转换（RGB ↔ NV12 / 灰度）
      • 单帧 JPEG 编码（快照/缩略图）
      • 标注合成（检测框画到 NV12 上，dsp-offload P1）
      • 异步作业（submit 后择机 wait，dsp-offload P2）
      • 零拷贝合成链（固件缺陷记录：默认拒绝）
      • 预分配缓冲池（高帧率重复任务）
      • 上下文管理器
  • 帧注入 API（输出写路径）
    • FramePublisher
    • InjectionResult
      • InjectionResult
        • InjectionResult.success
        • InjectionResult.message
        • InjectionResult.error_code
        • InjectionResult.injected_frame_id
        • InjectionResult.accepted_frame_count
        • InjectionResult.session_id
        • InjectionResult.in_flight_buffer_ids
        • InjectionResult.__init__()
    • InjectionStatus
      • InjectionStatus
        • InjectionStatus.success
        • InjectionStatus.message
        • InjectionStatus.active
        • InjectionStatus.mode
        • InjectionStatus.frames_injected
        • InjectionStatus.frames_dropped
        • InjectionStatus.queue_depth
        • InjectionStatus.session_id
        • InjectionStatus.in_flight_buffer_ids
        • InjectionStatus.reports_in_flight_buffers
        • InjectionStatus.__init__()
    • CameraClient 注入 RPC
      • CameraClient
        • CameraClient.set_isp()
        • CameraClient.get_isp()
        • CameraClient.get_transform()
        • CameraClient.set_transform()
        • CameraClient.set_encoder()
        • CameraClient.reconfigure_encoder()
        • CameraClient.set_rtsp_enabled()
        • CameraClient.set_osd()
        • CameraClient.set_ai_overlay()
        • CameraClient.set_imaging_mode()
        • CameraClient.get_infrared_status()
        • CameraClient.set_infrared_settings()
        • CameraClient.clear_infrared_manual()
        • CameraClient.list_ir_presets()
        • CameraClient.save_ir_preset()
        • CameraClient.delete_ir_preset()
        • CameraClient.get_privacy_mask()
        • CameraClient.set_privacy_mask()
        • CameraClient.get_osd()
        • CameraClient.get_config_field()
        • CameraClient.set_config_field()
        • CameraClient.get_stream_status()
        • CameraClient.push_frame()
        • CameraClient.push_frame_stream()
        • CameraClient.injection_status()
        • CameraClient.stop_injection()
        • CameraClient.add_stream()
        • CameraClient.remove_stream()
        • CameraClient.reconfigure_pipeline()
        • CameraClient.get_profile()
        • CameraClient.list_profiles()
        • CameraClient.switch_profile()
        • CameraClient.backup_profile()
        • CameraClient.get_sensor_info()
        • CameraClient.get_capabilities()
        • CameraClient.get_hardware_status()
        • CameraClient.set_led_duty()
        • CameraClient.get_led_duty()
        • CameraClient.set_ircut()
        • CameraClient.get_ircut()
        • CameraClient.mcu_raw_request()
        • CameraClient.set_fan()
        • CameraClient.get_fan()
        • CameraClient.set_heat()
        • CameraClient.get_heat()
        • CameraClient.set_radar()
        • CameraClient.get_radar()
        • CameraClient.set_alarm_out()
        • CameraClient.get_alarm_out()
        • CameraClient.get_alarm_outputs()
        • CameraClient.rs485_init()
        • CameraClient.rs485_deinit()
        • CameraClient.rs485_tx()
    • 使用示例
      • 把处理后的 NV12 帧发布到子码流编码器
      • 语义要点
  • 整管线 API（平台调度管线）
    • StreamPipeline
    • StreamPipelineStatus
      • StreamPipelineStatus
        • StreamPipelineStatus.running
        • StreamPipelineStatus.results_seen
        • StreamPipelineStatus.results_annotated
        • StreamPipelineStatus.annotate_errors
        • StreamPipelineStatus.result_queue_drops
        • StreamPipelineStatus.subscribe_dropped
        • StreamPipelineStatus.last_error
        • StreamPipelineStatus.last_latency_ms
        • StreamPipelineStatus.avg_latency_ms
        • StreamPipelineStatus.last_skew_us
        • StreamPipelineStatus.avg_skew_us
        • StreamPipelineStatus.__init__()
    • 使用示例
      • 一次启动：订阅推理 + 硬件叠加 + 应用侧结果
      • 语义要点
  • 相机控制 API
    • CameraClient
    • 数据类型
      • ISPConfig
        • ISPConfig
      • TransformConfig
        • TransformConfig
      • Capabilities
        • Capabilities
      • SensorInfo
        • SensorInfo
      • StreamStatus
        • StreamStatus
      • HardwareStatus
        • HardwareStatus
      • EnvStatus
        • EnvStatus
      • PipelineStreamConfig
        • PipelineStreamConfig
      • EncoderReconfigResult
        • EncoderReconfigResult
      • InfraredStatus
        • InfraredStatus
      • IrPreset
        • IrPreset
      • PrivacyMaskSettings
        • PrivacyMaskSettings
    • 使用示例
      • ISP 图像调节
      • 图像变换（翻转 / 旋转 / 灰度）
      • 红外与夜视
      • 编码器与码流
      • 隐私遮挡
      • 环境与外设
      • 能力查询
      • 上下文管理器
  • 音频控制 API
    • AudioClient
    • 数据类型
      • AudioDevice
        • AudioDevice
      • AudioStatus
        • AudioStatus
    • 使用示例
      • 查询设备与状态
      • 开始/停止采集
      • 播放文件（对讲放音）
      • 流式播放 PCM（实时对讲）
      • 音量与静音
      • 上下文管理器
  • 音频流 API
    • AudioStreamClient
    • AudioFrame
      • AudioFrame
        • AudioFrame.codec
        • AudioFrame.flags
        • AudioFrame.pts_ns
        • AudioFrame.sample_rate
        • AudioFrame.channels
        • AudioFrame.bits_per_sample
        • AudioFrame.data
        • AudioFrame.dts_ns
        • AudioFrame.is_keyframe
        • AudioFrame.codec_name
        • AudioFrame.duration_ms
        • AudioFrame.__init__()
    • 使用示例
      • 迭代订阅音频帧
      • 获取单帧
      • 回调订阅
      • 原始 PCM 与编码帧
      • 错误处理与资源释放
  • AI 叠加层 API
    • OverlayClient
    • OverlayConfig
      • OverlayConfig
        • OverlayConfig.enabled
        • OverlayConfig.show_label
        • OverlayConfig.show_confidence
        • OverlayConfig.line_thickness
        • OverlayConfig.box_color
        • OverlayConfig.label_color
        • OverlayConfig.font_size
        • OverlayConfig.strict_frame_lock
        • OverlayConfig.strict_wait_cap_ms
        • OverlayConfig.to_proto()
        • OverlayConfig.__init__()
    • 使用示例
      • 启用叠加层
      • 自定义样式
      • 结构化配置
      • 严格对帧模式（P1-6）
      • 与推理结果联动（annotate）
      • 其他结果类型
      • 生命周期会话标记（P2-13）
      • 两种模式与视频副作用契约
      • 平台结果绑定（daemon 配置）
      • 帧同步绑定（frame_sequence / stream_epoch）
      • keep_fd 帧的只读配方
      • 上下文管理器
  • 录像 API
    • TsWriter
      • TsWriter
        • TsWriter.__init__()
        • TsWriter.write()
        • TsWriter.close()
    • HlsWriter
      • HlsWriter
        • HlsWriter.__init__()
        • HlsWriter.write()
        • HlsWriter.close()
    • PrerollBuffer
      • PrerollBuffer
        • PrerollBuffer.__init__()
        • PrerollBuffer.push()
        • PrerollBuffer.frames
        • PrerollBuffer.dump()
    • 使用示例
      • 录制 MP4（TsWriter）
      • HLS 直播切片
      • 预滚录像（事件前缓存）
      • 自定义帧回调
  • Web 预览 API
    • MjpegServer
    • MjpegStream
      • MjpegStream
        • MjpegStream.__init__()
        • MjpegStream.push_jpeg()
        • MjpegStream.push_frame()
        • MjpegStream.latest()
        • MjpegStream.latest_seq()
        • MjpegStream.wait_new()
    • mjpeg_wsgi_app
      • mjpeg_wsgi_app()
    • platform_stream_url
      • platform_stream_url()
    • 使用示例
      • 独立 MJPEG 预览服务器
      • 推入已有 JPEG
      • 配合 WSGI 应用（Flask / 内置服务器）
      • 低延迟读取最新帧
      • 零服务器预览（复用平台流地址）
  • 检测框绘制 API
    • draw_boxes
      • draw_boxes()
    • draw_text
      • draw_text()
    • draw_detections
      • draw_detections()
    • draw_polygons
      • draw_polygons()
    • render_overlay_rgba
      • render_overlay_rgba()
    • 使用示例
      • 绘制检测框与标签
      • 绘制任意文本
      • 直接渲染推理结果
      • 多边形与轨迹（区域/轨迹可视化，dsp-offload P2）
  • 色彩转换 API
    • 函数
      • nv12_to_rgb / nv12_to_bgr
      • rgb_to_nv12 / bgr_to_nv12
      • nv12_resize
    • 使用示例
      • 编码结果直推 NV12 模型
      • 配合 DSP 硬件缩放
  • 后处理 API
    • 函数
      • nms
    • 使用示例
      • 模型输出解码后过滤重叠框
      • 配合加速路由（硬件 NMS 就绪后自动切换）
  • 加速路由 API
    • 类与函数
      • AccelRouter
      • RoutePolicy
      • RouteDecision / DegradationRecord
        • RouteDecision
        • DegradationRecord
      • get_default_router
    • 使用示例
      • 默认路由器：硬件优先，自动降级
      • 颜色转换同样走硬件腿
      • JPEG 编码：daemon 一发 RPC，CPU 兜底
      • 检测标注：NV12 走 DSP blend，RGB 走软件光栅
      • 降级事件转发到事件总线
      • 只信硬件：失败即抛错
      • 能力探测
  • 插件 API
    • PluginDiscovery
      • PluginDiscovery
        • PluginDiscovery.__init__()
        • PluginDiscovery.reload()
        • PluginDiscovery.get()
        • PluginDiscovery.require()
        • PluginDiscovery.list_plugins()
        • PluginDiscovery.list_capabilities()
        • PluginDiscovery.watch()
        • PluginDiscovery.close()
    • PluginEndpoint
      • PluginEndpoint
        • PluginEndpoint.app_id
        • PluginEndpoint.capability_id
        • PluginEndpoint.version
        • PluginEndpoint.transport
        • PluginEndpoint.socket_path
        • PluginEndpoint.grpc_service
        • PluginEndpoint.event_publish
        • PluginEndpoint.event_subscribe
        • PluginEndpoint.state
        • PluginEndpoint.connect()
        • PluginEndpoint.is_available
        • PluginEndpoint.__init__()
    • PluginServer
      • PluginServer
        • PluginServer.__init__()
        • PluginServer.create_server()
        • PluginServer.start()
        • PluginServer.wait()
        • PluginServer.stop()
    • 使用示例
      • App 侧：发现并调用插件
      • 监听插件上下线
      • 插件侧：发布能力
      • 热加载

其他

  • 更新日志
    • v0.8.1 (2026-10-15)
      • 改进
      • 文档
    • v0.8.0 (2026-09-16)
      • 新增功能
      • 改进
      • 修复
      • 弃用
      • 文档
    • v0.7.4 (2026-09-08)
      • 新增功能
      • 修复
    • v0.7.3 (2026-09-07)
      • 新增功能
      • 修复
    • v0.7.2 (2026-09-03)
      • 修复
    • v0.7.1 (2026-09-03)
    • v0.7.0 (2026-09-02)
      • 新增功能
      • 重构
      • 修复
      • 其他
    • v0.5.0 (2026-08-20)
      • 重构
      • 修复
      • 其他
    • v0.4.0 (2026-07-14)
      • 新增功能
      • 改进
    • v0.2.0 (2026-03-02)
      • 新增功能
      • 改进
      • 修复
    • v0.1.0 (2025-12-15)
      • 初始版本
  • 贡献指南
    • 开发环境设置
    • 代码规范
    • 测试
    • 提交代码
      • 提交信息规范
    • 文档
    • 问题反馈
    • 许可证
  • 许可证
AIPC Platform Python SDK
  • Search

© Copyright 2025-2026, CamThink.

Built with Sphinx using a theme provided by Read the Docs.