Skip to content

COMPILE.md

Latest commit

 

History

History
56 lines (34 loc) · 1.87 KB

COMPILE.md

File metadata and controls

56 lines (34 loc) · 1.87 KB
Raw

Building FastVideoStream

Prerequisites

  • A working microphone and/or Windows playback device for audio smoke tests.

Automated One-Click Build

From the repository root:

compile.bat

mvn exec:java -Dexec.mainClass=fastvideostream.FastVideoStreamCli -Dexec.args="--camera=20,20,480,270 --audio --fps=60 --bitrate=6000" The script runs a clean Maven install without tests.

Maven Java Packaging

The default encoder is h264_nvenc; select another encoder explicitly when the installed FFmpeg build or GPU does not support NVENC. Audio uses 48 kHz, 16-bit stereo PCM and is encoded as AAC at 160 kbit/s. run-demo.bat starts the Swing control window; run-cli.bat starts the headless CLI. mvn clean test mvn clean package -DskipTests



### Audio capture is unavailable

Start without `--audio`, verify microphone and playback permissions, and check that the FastAudioCapture native dependency is available through the selected Maven/JitPack version.
The executable artifact is written to `target/FastVideoStream-0.1.0.jar`.

## CLI Smoke Test

Set stream keys without committing them:

```powershell
$env:FAST_YOUTUBE_KEY = "your-youtube-key"
$env:FAST_TWITCH_KEY = "your-twitch-key"
mvn exec:java -Dexec.args="--camera --fps=60 --bitrate=6000"

Runtime Notes

Use --ffmpeg=... when FFmpeg is not on PATH. The default encoder is h264_nvenc; select another encoder explicitly when the installed FFmpeg build or GPU does not support NVENC.

Troubleshooting

FFmpeg is not found

Install FFmpeg and add its bin directory to PATH, or pass an absolute path with --ffmpeg.

The encoder is unavailable

Run ffmpeg -encoders and choose an installed encoder, for example h264_qsv, h264_amf, or libx264.

The camera is unavailable

Start without --camera, verify Windows camera permissions, and check that another application is not holding the device.