Elgato Camera Hub
Control Elgato Facecam and compatible cameras with full access to zoom, pan, tilt, brightness, contrast, saturation, focus, and white balance settings.
Overview
FaustBot integrates with Elgato Camera Hub to provide complete control over your Elgato Facecam and other compatible cameras. This allows you to dynamically adjust camera settings during your stream based on triggers and events.
Zoom & Framing
Digital zoom from 100-400% with pan and tilt control.
Image Adjustments
Brightness, contrast, saturation, and sharpness.
Focus Control
Auto-focus toggle and manual focus adjustment.
White Balance
Auto or manual temperature from 2800-10000K.
Multi-Camera
Support for multiple connected cameras.
Quick Reset
Instantly restore default camera settings.
Setup
Prerequisites
Before connecting FaustBot to Camera Hub, ensure you have the following:
- An Elgato Facecam or compatible camera
- Elgato Camera Hub software installed and running
- Camera Hub WebSocket API enabled (default port: 1825)
Install Elgato Camera Hub
Download and install Elgato Camera Hub from the Elgato website if you haven't already.
Connect Your Camera
Connect your Elgato Facecam via USB and ensure it appears in Camera Hub. Configure your preferred baseline settings in Camera Hub first.
Connect from FaustBot
In FaustBot, go to Camera Hub in the sidebar. The default
connection settings are localhost:1825. Click Connect to establish the connection.
Auto-Connect
Enable Auto-Connect to automatically connect when FaustBot starts. Ensure Camera Hub is running before launching FaustBot.
Effects
Zoom & Framing
Set Zoom
Adjust zoom level (100-400%).
Set Pan
Adjust horizontal position (-100 to 100).
Set Tilt
Adjust vertical position (-100 to 100).
Image Settings
Set Brightness
Adjust image brightness (0-100).
Set Contrast
Adjust image contrast (0-100).
Set Saturation
Adjust color saturation (0-100).
Set Sharpness
Adjust image sharpness (0-100).
Focus & White Balance
Set Auto Focus
Enable or disable auto-focus.
Set Manual Focus
Set focus manually (0-100).
Set Auto White Balance
Enable or disable auto white balance.
Set White Balance
Set color temperature (2800-10000K).
Camera Management
Select Camera
Switch between connected cameras.
Reset to Defaults
Restore all settings to factory defaults.
Scripting API
Control Camera Hub from your scripts using the CPH API:
Camera Selection
# Get list of available cameras
cameras = CPH.CameraHubGetCameras()
for cam in cameras:
CPH.Log(f"Camera: {cam['name']} ({cam['id']})")
# Get active camera
active = CPH.CameraHubGetActiveCamera()
# Select a specific camera
CPH.CameraHubSelectCamera("facecam-001")Zoom, Pan & Tilt
# Set zoom level (100-400%)
CPH.CameraHubSetZoom(200)
# Set pan position (-100 to 100)
CPH.CameraHubSetPan(25)
# Set tilt position (-100 to 100)
CPH.CameraHubSetTilt(-10)
# Set all three at once for smoother transitions
CPH.CameraHubSetZoomPanTilt(150, 0, 0)
# Get current values
zoom = CPH.CameraHubGetZoom()
pan = CPH.CameraHubGetPan()
tilt = CPH.CameraHubGetTilt()Image Settings
# Set brightness (0-100)
CPH.CameraHubSetBrightness(60)
# Set contrast (0-100)
CPH.CameraHubSetContrast(55)
# Set saturation (0-100)
CPH.CameraHubSetSaturation(50)
# Set sharpness (0-100)
CPH.CameraHubSetSharpness(45)
# Get all settings at once
settings = CPH.CameraHubGetSettings()
CPH.Log(f"Brightness: {settings['brightness']}")Focus & White Balance
# Enable/disable auto-focus
CPH.CameraHubSetAutoFocus(True)
CPH.CameraHubSetAutoFocus(False)
# Set manual focus (0-100) when auto-focus is off
CPH.CameraHubSetManualFocus(70)
# Enable/disable auto white balance
CPH.CameraHubSetAutoWhiteBalance(True)
CPH.CameraHubSetAutoWhiteBalance(False)
# Set white balance temperature (2800-10000 Kelvin)
CPH.CameraHubSetWhiteBalance(5600) # Daylight
# Reset all settings to defaults
CPH.CameraHubResetToDefaults()Parameter Ranges
- Zoom: 100-400% (100 = no zoom)
- Pan/Tilt: -100 to 100 (0 = centered)
- Brightness/Contrast/Saturation/Sharpness: 0-100
- Manual Focus: 0-100
- White Balance: 2800-10000 Kelvin
See the full API reference for all available Camera Hub methods.