VideoDB 技能
视频、直播流和桌面会话的感知、记忆与操作。
使用场景
桌面感知
- 启动/停止 桌面会话,采集 屏幕、麦克风和系统音频
- 流式传输 实时上下文 并存储 情景会话记忆
- 对屏幕上的语音和事件运行 实时告警/触发器
- 生成 会话摘要、可搜索的时间线以及 可播放的证据链接
视频接入与流媒体
- 接入 文件或 URL 并返回 可播放的 Web 流链接
- 转码/归一化:编解码器、比特率、帧率、分辨率、宽高比
索引与搜索(时间戳与证据)
- 构建 视觉、语音 和 关键词 索引
- 搜索并返回带 时间戳 和 可播放证据 的精确时刻
- 从搜索结果中 自动创建剪辑
时间线编辑与生成
- 字幕:生成、翻译、烧录
- 叠加:文字/图像/品牌标识,动态字幕
- 音频:背景音乐、画外音、配音
- 通过 时间线操作 进行程序化合成和导出
直播流(RTSP)与监控
- 连接 RTSP/直播源
- 运行 实时视觉和语音理解,为监控工作流生成 事件/告警
工作原理
常见输入
- 本地 文件路径、公共 URL 或 RTSP URL
- 桌面采集请求:开始 / 停止 / 总结会话
- 所需操作:获取上下文以进行理解、转码规范、索引规范、搜索查询、剪辑范围、时间线编辑、告警规则
常见输出
- 流 URL
- 包含 时间戳 和 证据链接 的搜索结果
- 生成的资产:字幕、音频、图像、剪辑
- 直播流的 事件/告警负载
- 桌面 会话摘要 和记忆条目
运行 Python 代码
在运行任何 VideoDB 代码前,切换到项目目录并加载环境变量:
from dotenv import load_dotenv
load_dotenv(".env")
import videodb
conn = videodb.connect()
这将从以下位置读取 VIDEO_DB_API_KEY:
- 环境变量(如果已导出)
- 当前目录下的项目
.env文件
如果密钥缺失,videodb.connect() 会自动引发 AuthenticationError。
当简短的內联命令足以完成任务时,不要编写脚本文件。
当编写内联 Python (python -c "...") 时,始终使用格式正确的代码——使用分号分隔语句并保持可读性。对于超过约 3 条语句的情况,改用 heredoc:
python << 'EOF'
from dotenv import load_dotenv
load_dotenv(".env")
import videodb
conn = videodb.connect()
coll = conn.get_collection()
print(f"视频数量: {len(coll.get_videos())}")
EOF
设置
当用户要求“设置 videodb”或类似操作时:
1. 安装 SDK
pip install "videodb[capture]" python-dotenv
如果 videodb[capture] 在 Linux 上安装失败,则安装不包含 capture 扩展的版本:
pip install videodb python-dotenv
2. 配置 API 密钥
用户必须使用 任一 方法设置 VIDEO_DB_API_KEY:
- 在终端中导出(启动 Claude 前):
export VIDEO_DB_API_KEY=your-key - 项目
.env文件:将VIDEO_DB_API_KEY=your-key保存到项目的.env文件中
在 console.videodb.io 获取免费 API 密钥(50 次免费上传,无需信用卡)。
不要自行读取、写入或处理 API 密钥。始终让用户设置它。
快速参考
上传媒体
# URL
video = coll.upload(url="https://example.com/video.mp4")
# YouTube
video = coll.upload(url="https://www.youtube.com/watch?v=VIDEO_ID")
# 本地文件
video = coll.upload(file_path="/path/to/video.mp4")
转录与字幕
# force=True 可在视频已索引时跳过错误
video.index_spoken_words(force=True)
text = video.get_transcript_text()
stream_url = video.add_subtitle()
在视频内搜索
from videodb.exceptions import InvalidRequestError
video.index_spoken_words(force=True)
# search() 在未找到结果时引发 InvalidRequestError。
# 始终用 try/except 包裹并将“未找到结果”视为空。
try:
results = video.search("产品演示")
shots = results.get_shots()
stream_url = results.compile()
except InvalidRequestError as e:
if "No results found" in str(e):
shots = []
else:
raise
场景搜索
import re
from videodb import SearchType, IndexType, SceneExtractionType
from videodb.exceptions import InvalidRequestError
# index_scenes() 没有 force 参数——如果场景索引已存在则会引发错误。
# 从错误中提取现有的索引 ID。
try:
scene_index_id = video.index_scenes(
extraction_type=SceneExtractionType.shot_based,
prompt="描述此场景的视觉内容。",
)
except Exception as e:
match = re.search(r"id\s+([a-f0-9]+)", str(e))
if match:
scene_index_id = match.group(1)
else:
raise
# 使用 score_threshold 过滤低相关性噪声(建议:0.3 或更高)
try:
results = video.search(
query="一个人在写白板",
search_type=SearchType.semantic,
index_type=IndexType.scene,
scene_index_id=scene_index_id,
score_threshold=0.3,
)
shots = results.get_shots()
stream_url = results.compile()
except InvalidRequestError as e:
if "No results found" in str(e):
shots = []
else:
raise
时间线编辑
重要: 在构建时间线之前始终验证时间戳:
start必须 >= 0(负值会被静默接受但会产生损坏的输出)start必须 <endend必须 <=video.length
from videodb.timeline import Timeline
from videodb.asset import VideoAsset, TextAsset, TextStyle
timeline = Timeline(conn)
timeline.add_inline(VideoAsset(asset_id=video.id, start=10, end=30))
timeline.add_overlay(0, TextAsset(text="结束", duration=3, style=TextStyle(fontsize=36)))
stream_url = timeline.generate_stream()
转码视频(分辨率/质量更改)
from videodb import TranscodeMode, VideoConfig, AudioConfig
# 在服务端更改分辨率、质量或宽高比
job_id = conn.transcode(
source="https://example.com/video.mp4",
callback_url="https://example.com/webhook",
mode=TranscodeMode.economy,
video_config=VideoConfig(resolution=720, quality=23, aspect_ratio="16:9"),
audio_config=AudioConfig(mute=False),
)
重新调整宽高比(用于社交平台)
警告: reframe() 是一个慢速的服务端操作。对于长视频可能需要几分钟,并可能超时。最佳实践:
- 尽可能使用
start/end将操作限制在短片段上 - 对于完整长度的视频,使用
callback_url进行异步处理 - 先在
Timeline上修剪视频,然后重新调整较短结果的宽高比
from videodb import ReframeMode
# 始终优先重新调整短视频片段:
reframed = video.reframe(start=0, end=60, target="vertical", mode=ReframeMode.smart)
# 完整长度视频的异步重新调整(返回 None,结果通过 webhook 返回):
video.reframe(target="vertical", callback_url="https://example.com/webhook")
# 预设:"vertical" (9:16), "square" (1:1), "landscape" (16:9)
reframed = video.reframe(start=0, end=60, target="square")
# 自定义尺寸
reframed = video.reframe(start=0, end=60, target={"width": 1280, "height": 720})
生成式媒体
image = coll.generate_image(
prompt="山上的日落",
aspect_ratio="16:9",
)
错误处理
from videodb.exceptions import AuthenticationError, InvalidRequestError
try:
conn = videodb.connect()
except AuthenticationError:
print("检查你的 VIDEO_DB_API_KEY")
try:
video = coll.upload(url="https://example.com/video.mp4")
except InvalidRequestError as e:
print(f"上传失败: {e}")
常见陷阱
| 场景 | 错误消息 | 解决方案 |
|---|---|---|
| 为已索引的视频建立索引 | Spoken word index for video already exists | 使用 video.index_spoken_words(force=True) 在已索引时跳过 |
| 场景索引已存在 | Scene index with id XXXX already exists | 使用 re.search(r"id\s+([a-f0-9]+)", str(e)) 从错误中提取现有的 scene_index_id |
| 搜索未找到匹配项 | InvalidRequestError: No results found | 捕获异常并视为空结果 (shots = []) |
| 重新调整宽高比超时 | 在长视频上无限阻塞 | 使用 start/end 限制片段,或传递 callback_url 进行异步处理 |
| 时间线上的负时间戳 | 静默生成损坏的流 | 在创建 VideoAsset 前始终验证 start >= 0 |
generate_video() / create_collection() 失败 | Operation not allowed 或 maximum limit | 计划限制功能——告知用户有关计划限制的信息 |
示例
规范提示词
- "启动桌面采集,并在出现密码字段时发出警报。"
- "录制我的会话,并在结束时生成可操作的摘要。"
- "接入此文件并返回一个可播放的流链接。"
- "索引此文件夹并找到所有包含人物的场景,返回时间戳。"
- "生成字幕,烧录进去,并添加轻量背景音乐。"
- "连接此 RTSP URL,并在有人进入区域时发出警报。"
屏幕录制(桌面采集)
使用 ws_listener.py 在录制会话期间捕获 WebSocket 事件。桌面采集仅支持 macOS。
快速开始
- 选择状态目录:
STATE_DIR="${VIDEODB_EVENTS_DIR:-$HOME/.local/state/videodb}" - 启动监听器:
VIDEODB_EVENTS_DIR="$STATE_DIR" python scripts/ws_listener.py --clear "$STATE_DIR" & - 获取 WebSocket ID:
cat "$STATE_DIR/videodb_ws_id" - 运行采集代码(完整工作流程参见 reference/capture.md)
- 事件写入:
$STATE_DIR/videodb_events.jsonl
每次开始新的采集运行时使用 --clear,这样旧的字幕和视觉事件不会泄漏到新会话中。
查询事件
import json
import os
import time
from pathlib import Path
events_dir = Path(os.environ.get("VIDEODB_EVENTS_DIR", Path.home() / ".local" / "state" / "videodb"))
events_file = events_dir / "videodb_events.jsonl"
events = []
if events_file.exists():
with events_file.open(encoding="utf-8") as handle:
for line in handle:
try:
events.append(json.loads(line))
except json.JSONDecodeError:
continue
transcripts = [e["data"]["text"] for e in events if e.get("channel") == "transcript"]
cutoff = time.time() - 300
recent_visual = [
e for e in events
if e.get("channel") == "visual_index" and e["unix_ts"] > cutoff
]
附加文档
参考文档位于此 SKILL.md 文件旁边的 reference/ 目录中。如有需要,请使用 Glob 工具定位。
- reference/api-reference.md - 完整的 VideoDB Python SDK API 参考
- reference/search.md - 视频搜索深度指南(语音和场景搜索)
- reference/editor.md - 时间线编辑、资产和合成
- reference/streaming.md - HLS 流媒体和即时播放
- reference/generative.md - AI 驱动的媒体生成(图像、视频、音频)
- reference/rtstream.md - 直播流接入工作流(RTSP/RTMP)
- reference/rtstream-reference.md - RTStream SDK 方法和 AI 流水线
- reference/capture.md - 桌面采集工作流
- reference/capture-reference.md - 采集 SDK 和 WebSocket 事件
- reference/use-cases.md - 常见视频处理模式和示例
除非 VideoDB 不支持该操作,否则不要使用 ffmpeg、moviepy 或本地编码工具。 以下所有操作均由 VideoDB 在服务端处理——裁剪、组合剪辑、叠加音频或音乐、添加字幕、文本/图像叠加、转码、分辨率更改、宽高比转换、为平台要求调整大小、转录和媒体生成。仅在 reference/editor.md 中“限制”部分列出的操作(转场、速度更改、裁剪/缩放、调色、音量混合)时才回退到本地工具。
何时使用什么
| 问题 | VideoDB 解决方案 |
|---|---|
| 平台拒绝视频宽高比或分辨率 | video.reframe() 或使用 VideoConfig 的 conn.transcode() |
| 需要为 Twitter/Instagram/TikTok 调整视频大小 | video.reframe(target="vertical") 或 target="square" |
| 需要更改分辨率(例如 1080p → 720p) | 使用 VideoConfig(resolution=720) 的 conn.transcode() |
| 需要在视频上叠加音频/音乐 | 在 Timeline 上使用 AudioAsset |
| 需要添加字幕 | video.add_subtitle() 或 CaptionAsset |
| 需要合并/修剪剪辑 | 在 Timeline 上使用 VideoAsset |
| 需要生成画外音、音乐或音效 | coll.generate_voice()、generate_music()、generate_sound_effect() |
来源
此技能的参考材料已在本地以 skills/videodb/reference/ 形式提供。请使用本地的副本,而不是在运行时遵循外部仓库链接。