VideoDB 技能
感知 + 記憶 + 動作:適用於影片、直播串流與桌面會話。
當你需要以下功能時,請使用此技能:
使用時機
- 你需要從檔案、URL、桌面會話或直播串流中進行影片或音訊的感知、索引、搜尋或時間線編輯。
- 任務涉及時間戳記、可搜尋的證據、字幕、剪輯、疊加層或即時監控警示。
- 你想要一個整合攝取、理解、檢索與媒體動作的工作流程。
1) 桌面感知
- 啟動/停止桌面會話,擷取螢幕、麥克風與系統音訊。
- 串流即時情境,儲存片段式會話記憶。
- 對說話內容與螢幕發生的事件執行即時警示/觸發。
- 產生會話摘要、可搜尋的時間線與可播放的證據連結。
2) 影片攝取 + 串流
- 攝取檔案或 URL,並回傳可播放的網路串流連結。
- 轉碼/標準化:編碼器、位元率、fps、解析度、畫面比例。
3) 索引 + 搜尋(時間戳記 + 證據)
- 建立視覺、語音與關鍵字索引。
- 搜尋並回傳確切時刻,附時間戳記與可播放的證據。
- 從搜尋結果自動建立剪輯。
4) 時間線編輯 + 生成
- 字幕:生成、翻譯、嵌入。
- 疊加層:文字/圖片/品牌標誌、動態字幕。
- 音訊:背景音樂、旁白、配音。
- 透過時間線操作進行程式化組合與匯出。
5) 直播串流 (RTSP) + 監控
- 連接 RTSP/即時饋送。
- 執行即時視覺與語音理解,並發出事件/警示以進行監控工作流程。
常見輸入
- 本地檔案路徑、公開 URL 或 RTSP URL。
- 桌面擷取請求:開始 / 停止 / 摘要會話。
- 所需操作:取得理解所需情境、轉碼規格、索引規格、搜尋查詢、剪輯範圍、時間線編輯、警示規則。
常見輸出
- 串流 URL
- 附時間戳記與證據連結的搜尋結果
- 生成的資產:字幕、音訊、圖片、剪輯
- 直播串流的事件/警示負載
- 桌面會話摘要與記憶條目
典型提示範例
- 「啟動桌面擷取,並在密碼欄位出現時發出警示。」
- 「錄製我的會話,並在結束時產生可操作的摘要。」
- 「攝取此檔案並回傳一個可播放的串流連結。」
- 「索引此資料夾,找出所有有人物的場景,回傳時間戳記。」
- 「產生字幕,將其嵌入,並加上柔和的背景音樂。」
- 「連接這個 RTSP 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
如果在 Linux 上 videodb[capture] 失敗,請在不加 capture extra 的情況下安裝:
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檔案中
在 https://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("product demo")
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="The End", 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 | 方案限制的功能——通知使用者關於方案限制的資訊 |
其他文件
參考文件位於此 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 - 常見影片處理模式與範例
螢幕錄製(桌面擷取)
使用 ws_listener.py 在錄製會話期間擷取 WebSocket 事件。桌面擷取僅支援 macOS。
快速開始
- 啟動監聽器:
python scripts/ws_listener.py & - 取得 WebSocket ID:
cat /tmp/videodb_ws_id - 執行擷取程式碼(請參閱 reference/capture.md 取得完整工作流程)
- 事件寫入至:
/tmp/videodb_events.jsonl
查詢事件
import json
events = [json.loads(l) for l in open("/tmp/videodb_events.jsonl")]
# 取得所有轉錄文字
transcripts = [e["data"]["text"] for e in events if e.get("channel") == "transcript"]
# 取得過去 5 分鐘的視覺描述
import time
cutoff = time.time() - 300
recent_visual = [e for e in events
if e.get("channel") == "visual_index" and e["unix_ts"] > cutoff]
工具指令稿
- scripts/ws_listener.py - WebSocket 事件監聽器(傾印至 JSONL)
如需完整的擷取工作流程,請參閱 reference/capture.md。
當 VideoDB 支援該操作時,請勿使用 ffmpeg、moviepy 或本地編碼工具。以下所有操作均由 VideoDB 在伺服器端處理——修剪、組合剪輯、疊加音訊或音樂、新增字幕、文字/圖片疊加、轉碼、解析度變更、畫面比例轉換、為平台需求調整大小、轉錄與媒體生成。僅對 reference/editor.md 中「限制」部分所列的操作(過場、速度變更、裁切/縮放、調色、音量混合)才回退至本地工具。
何時使用何種工具
| 問題 | VideoDB 解決方案 |
|---|---|
| 平台拒絕影片的畫面比例或解析度 | video.reframe() 或 conn.transcode() 搭配 VideoConfig |
| 需要為 Twitter/Instagram/TikTok 調整影片大小 | video.reframe(target="vertical") 或 target="square" |
| 需要變更解析度(例如 1080p → 720p) | conn.transcode() 搭配 VideoConfig(resolution=720) |
| 需要在影片上疊加音訊/音樂 | 在 Timeline 上使用 AudioAsset |
| 需要新增字幕 | video.add_subtitle() 或 CaptionAsset |
| 需要組合/修剪剪輯 | 在 Timeline 上使用 VideoAsset |
| 需要生成旁白、音樂或音效 | coll.generate_voice()、generate_music()、generate_sound_effect() |
倉庫
https://github.com/video-db/skills
維護者: VideoDB
限制
- 僅在任務明確符合上述範圍時使用此技能。
- 請勿將輸出視為環境特定驗證、測試或專家審查的替代品。
- 如果所需的輸入、權限、安全邊界或成功標準遺失,請停止並要求澄清。