Add USAGE.md
This commit is contained in:
60
docs/USAGE.md
Normal file
60
docs/USAGE.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# Usage Guide
|
||||
|
||||
This document provides usage instructions for the video_probe tool.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```bash
|
||||
video_probe video.mp4
|
||||
```
|
||||
|
||||
This will create `video.probe.json` in the same directory.
|
||||
|
||||
## Example Output
|
||||
|
||||
```bash
|
||||
$ video_probe sample.mp4
|
||||
|
||||
Probing video: /path/sample.mp4
|
||||
========================================
|
||||
✓ Video probed successfully!
|
||||
|
||||
File: sample.mp4
|
||||
Format: QuickTime / MOV
|
||||
Duration: 120.50 seconds
|
||||
Size: 50.00 MB
|
||||
Bit rate: 3473 kbps
|
||||
|
||||
Video Stream:
|
||||
Codec: h264 (High)
|
||||
Resolution: 1920x1080
|
||||
Frame rate: 30/1
|
||||
|
||||
Audio Streams: 1
|
||||
[1] aac - 2 channels @ 48000 Hz
|
||||
|
||||
✓ Metadata saved to: /path/sample.probe.json
|
||||
```
|
||||
|
||||
## JSON Output Format
|
||||
|
||||
The JSON file contains structured metadata:
|
||||
|
||||
```json
|
||||
{
|
||||
"video_path": "/path/to/video.mp4",
|
||||
"probed_at": "2026-03-06T10:30:00Z",
|
||||
"format": {
|
||||
"duration": 120.5,
|
||||
"size": 52428800,
|
||||
"bit_rate": 3473408
|
||||
},
|
||||
"video_stream": {
|
||||
"codec_name": "h264",
|
||||
"width": 1920,
|
||||
"height": 1080
|
||||
},
|
||||
"audio_streams": [...],
|
||||
"subtitle_streams": [...]
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user