VideoDB 技能

視覺 + 記憶 + 動作，適用於影片、即時串流與桌面工作階段。

使用時機

桌面感知

開始/停止桌面工作階段，擷取螢幕、麥克風與系統音訊
串流即時上下文並儲存情節式工作階段記憶
對說話內容與螢幕上發生的事件執行即時警報/觸發
產生工作階段摘要、可搜尋的時間軸與可播放的證據連結

影片擷取 + 串流

擷取檔案或 URL 並回傳可播放的網路串流連結
轉碼/正規化：編碼、位元率、影格率、解析度、寬高比

索引 + 搜尋（時間戳 + 證據）

建立視覺、語音與關鍵字索引
搜尋並回傳精確的時刻，附上時間戳與可播放的證據
從搜尋結果自動建立片段

時間軸編輯 + 生成

字幕：生成、翻譯、燒錄
疊加：文字/圖片/品牌、動態字幕
音訊：背景音樂、旁白、配音
透過時間軸操作進行程式化組合與匯出

即時串流 (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 必須 < end
end 必須 <= 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 上修剪影片，再對較短的結果進行 reframe

from videodb import ReframeMode

# 優先對短片段進行 reframe：
reframed = video.reframe(start=0, end=60, target="vertical", mode=ReframeMode.smart)

# 全長影片的非同步 reframe（回傳 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 = []`）
Reframe 逾時	長時間影片會無限期阻塞	使用 `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()` 或 `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()`

來源

此技能的參考資料已在地端存放於 skills/videodb/reference/ 目錄下。請使用上述本地副本，而非在執行時遵循外部儲存庫連結。

在你喜歡的 AI 中提問

說明文件