Skip to content
dsp-kitchen

dspk serve

Serve a recording over QUIC (signal and views)

dspk serve [OPTIONS] [RECORDING]

Arguments

  • [RECORDING]
    Recording every client starts with (any format dspk-io reads); a synthetic one when neither this nor –data is given

Options

  • --data <DATA>: env DSPK_SERVE_DATA
    Data root: clients list and open the recordings under it (paths relative to it; hidden files and links out of it are refused)
  • -b, --bind <BIND>: default 127.0.0.1:50051
    UDP address to listen on
  • -v, --verbose
    Show debug logs (runtimes, transport)
  • --channels <CHANNELS>: default 384
    Channels of the synthetic recording
  • --sample-rate <SAMPLE_RATE>: default 30000
    Sample rate of the synthetic recording (Hz)
  • --frame-sec <FRAME_SEC>: default 0.02
    Seconds of signal per frame
  • --loop
    Start over at the end of the recording
  • --unpaced
    Send as fast as clients take it, not at the recording’s rate
  • --certificate <CERTIFICATE>
    Certificate chain (PEM); when omitted, the server’s authority issues one for the –name names at every start
  • --private-key <PRIVATE_KEY>
    Private key (PEM) of –certificate
  • --certificate-out <CERTIFICATE_OUT>
    Where to write the certificate clients trust (DER): the server’s authority. Clients enrolled with dspk clients enroll have it in their identity file already
  • --auth-dir <AUTH_DIR>: env DSPK_SERVE_AUTH_DIR
    The server’s authority folder: its CA and the enrolled clients (default: <data dir>/serve, e.g. ~/.local/share/dspk/serve; created on first use)
  • --runtime <RUNTIME>
    The compute runtime jobs (sorts) run on: wgpu, cuda, cpu (default: $DSPK_RUNTIME, else the first compiled in, as dspk doctor shows)
  • --allow-anonymous
    Also let in clients without a certificate, read only. Anyone who reaches the port can then read the recording: trusted networks only
  • --max-clients <MAX_CLIENTS>: default 32
    Clients connected at once; more are refused until one leaves
  • --name <NAMES>
    Host names or addresses clients reach the server by, for the self-signed certificate (besides localhost and the –bind address); repeat for several
  • -h, --help
    Print help