Interface RdmTransport

interface RdmTransport {
    send(
        request: RdmRequest,
        options?: RdmTransportOptions,
    ): Promise<RdmResponse | null>;
    sendDiscoveryUniqueBranch(
        lower: UID,
        upper: UID,
        options?: RdmTransportOptions,
    ): Promise<DiscoveryUniqueBranchResult>;
    sendMute?(uid: UID, options?: RdmTransportOptions): Promise<boolean>;
    sendUnMute?(uid: UID, options?: RdmTransportOptions): Promise<boolean>;
}

Index

Methods

send sendDiscoveryUniqueBranch sendMute? sendUnMute?

Methods

send

send(
request: RdmRequest,
options?: RdmTransportOptions,
): Promise<RdmResponse | null>
Send one standard RDM request and return decoded response (or null on timeout).
Parameters
- request: RdmRequest
- Optionaloptions: RdmTransportOptions
Returns Promise<RdmResponse | null>
- Defined in src/protocols/artnet/rdm/transport.ts:21

sendDiscoveryUniqueBranch

sendDiscoveryUniqueBranch(
    lower: UID,
    upper: UID,
    options?: RdmTransportOptions,
): Promise<DiscoveryUniqueBranchResult>
Execute DISC_UNIQUE_BRANCH for an inclusive UID range.
Parameters
- lower: UID
- upper: UID
- Optionaloptions: RdmTransportOptions
Returns Promise<DiscoveryUniqueBranchResult>
- Defined in src/protocols/artnet/rdm/transport.ts:23

`Optional`sendMute

sendMute?(uid: UID, options?: RdmTransportOptions): Promise<boolean>
Optional transport-native DISC_MUTE helper.
Parameters
- uid: UID
- Optionaloptions: RdmTransportOptions
Returns Promise<boolean>
- Defined in src/protocols/artnet/rdm/transport.ts:29

`Optional`sendUnMute

sendUnMute?(uid: UID, options?: RdmTransportOptions): Promise<boolean>
Optional transport-native DISC_UN_MUTE helper.
Parameters
- uid: UID
- Optionaloptions: RdmTransportOptions
Returns Promise<boolean>
- Defined in src/protocols/artnet/rdm/transport.ts:31