node-dmx
    Preparing search index...

    Class Packet

    Parsed or encoded sACN packet model.

    Construct with:

    • Buffer to parse a received packet
    • Options to build a sendable packet
    Index

    Constructors

    constructor

    Properties

    cid options priority propertyValueCount sequence sourceAddress? sourceName syncUniverse universe

    Accessors

    buffer payload payloadAsBuffer

    Constructors

    • Parse or build an sACN packet.

      Parameters

      • input: Buffer<ArrayBufferLike> | Options

        Raw buffer to parse, or packet options to encode.

      • OptionalsourceAddress: string

        Optional sender address when parsing.

      Returns Packet

    Properties

    cid: Buffer = ...

    Component Identifier (CID) from root layer.

    options: number = 0

    Framing options byte.

    priority: number = 100

    Packet priority (default 100).

    propertyValueCount: number = 0x0201
    sequence: number = 0

    Packet sequence number (0-255).

    sourceAddress?: string

    Optional sender address when parsing.

    sourceName: string = ''

    Source name from framing layer.

    syncUniverse: number = 0

    Synchronization universe (usually 0).

    universe: number = 1

    Universe number for payload.

    Accessors

    • get payload(): Payload

      Payload in sparse object form (channel => percentage value). If the source was raw bytes, values are converted from 0-255 to 0-100%.

      Returns Payload

    • get payloadAsBuffer(): Buffer<ArrayBufferLike> | null

      Raw payload buffer when packet originated from raw bytes, else null.

      Returns Buffer<ArrayBufferLike> | null

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors