_stream_.streamoptions.md

@ericrabil/phea.js

Globals / "stream" / StreamOptions

Interface: StreamOptions

Hierarchy

• StreamOptions

Index

Properties

• engine
• lights
• renderCallback
• updateFrequency

Properties

engine

• engine: DTLS

Defined in src/stream.ts:18

DTLS color engine

---

lights

• lights: Light[]

Defined in src/stream.ts:14

Lights to be rendered

---

renderCallback

• renderCallback: () => void | Promise<void>

Defined in src/stream.ts:22

Called during a render frame

---

updateFrequency

• updateFrequency: number

Defined in src/stream.ts:10

Number of times a second to issue an update