Class UniverseDiscoverySource

Advertises a source's active universe list via periodic Universe Discovery packets.

Index

Constructors

Methods

advertiseOnce close setUniverses start stop

Constructors

constructor

new UniverseDiscoverySource(
options?: UniverseDiscoverySourceOptions,
): UniverseDiscoverySource
Parameters
- options: UniverseDiscoverySourceOptions = {}
Returns UniverseDiscoverySource
- Defined in src/protocols/sacn/discovery.ts:37

Methods

advertiseOnce

advertiseOnce(): Promise<void>
Sends the current universe list as one or more discovery pages immediately.

Returns Promise<void>
- Defined in src/protocols/sacn/discovery.ts:62

close

close(): void
Returns void
- Defined in src/protocols/sacn/discovery.ts:108

setUniverses

setUniverses(universes: number[]): void
Replaces the advertised universe list (sorted, de-duplicated).
Parameters
- universes: number[]
Returns void
- Defined in src/protocols/sacn/discovery.ts:57

start

start(): void
Starts periodic advertisement (sends immediately, then every intervalMs).

Returns void
- Defined in src/protocols/sacn/discovery.ts:83

stop

stop(): void
Stops periodic advertisement without closing the socket.

Returns void
- Defined in src/protocols/sacn/discovery.ts:92