Logo

Installation & Development

  • Contributing to LedFx
  • Installation and Setup
  • Command Line Options
  • Security
  • Development Setup
  • Architecture notes
  • Developer Guides
  • Document Development

Configuration

  • Configuration
  • Assets Workflow
  • Scenes
  • Playlists
  • Directing Audio
  • Settings
    • General
    • Directing Audio
    • Sendspin Audio Streaming
    • Now-Playing

Devices

  • Devices

Effects

  • Effects

How To

  • Tips and Tricks
  • How to: Create a Dummy Matrix
  • How to: Create a Dummy VuMeter
  • How to: Load Example Config
  • How to: Create a Keybeat gif
  • How to: Create and Edit Virtuals
  • How To: Complex Segments
  • How to: Reorder Device and Virtuals
  • How to: Enable Alpha Mode

LedFx API

  • REST API
  • Assets API
  • Images and Cache APIs
  • Log API
  • WebSocket API
  • WebSocket Client API
  • Scenes API
  • Sendspin Servers API
  • Now Playing API
  • Playlists API
  • Global Configuration API

Help

  • Misc Troubleshooting
  • Network & Performance Troubleshooting
  • How to: Report an issue
LedFx
  • Settings

Settings

Note

This documentation is a work in progress, and contributions are welcome.

  • General
  • Directing Audio
    • Linux
    • Linux CLI
    • macOS
    • Windows
    • Webaudio
    • Sendspin
  • Sendspin Audio Streaming
    • Overview
    • Requirements
    • Adding a Sendspin Server
    • Selecting a Sendspin Server as Audio Input
    • Always-On Mode
  • Now-Playing
    • Overview
    • Sources
    • Accessing Now Playing Settings
    • Gradient
    • Track Text
    • Album Art
Previous Next

© Copyright 2018-2026, LedFx Developers & contributors.

Built with Sphinx using a theme provided by Read the Docs.