node-dmx
    Preparing search index...

    Type Alias ControllerOptions

    Configuration for the DMX controller.

    type ControllerOptions = {
        artnet?: Partial<ArtNetSenderConfiguration>;
        artSync?: boolean;
        defaultPacketOptions?: Partial<
            Pick<Options, "cid" | "sourceName" | "priority" | "useRawDmxValues">,
        >;
        iface?: string;
        port?: number;
        protocol?: "sacn" | "artnet";
        refreshRate?: number;
        reuseAddr?: boolean;
        sacn?: Partial<SenderConfiguration>;
        senderFactory?: (universeId: number) => DmxSender;
        unicastDestination?: string;
    }
    Index

    Properties

    artnet? artSync? defaultPacketOptions? iface? port? protocol? refreshRate? reuseAddr? sacn? senderFactory? unicastDestination?

    Properties

    artnet?: Partial<ArtNetSenderConfiguration>

    Art-Net specific overrides.

    artSync?: boolean

    If true, send a single ArtSync after each flush.

    defaultPacketOptions?: Partial<
        Pick<Options, "cid" | "sourceName" | "priority" | "useRawDmxValues">,
    >

    Default E1.31 packet metadata applied to every send.

    iface?: string

    Local network interface IPv4 address.

    port?: number

    UDP port used by protocol sender.

    protocol?: "sacn" | "artnet"

    Which network protocol to use for sending. Defaults to sacn.

    refreshRate?: number

    Keep-alive resend rate in packets/second (sACN sender option).

    reuseAddr?: boolean

    Allow multiple listeners/senders on same UDP port.

    sacn?: Partial<SenderConfiguration>

    sACN specific overrides.

    senderFactory?: (universeId: number) => DmxSender

    Provide a custom sender factory if you want full control.

    unicastDestination?: string

    Optional unicast destination instead of multicast/broadcast.

    Settings

    Member Visibility

    On This Page

    Properties