SeydSessionOptions

Defined in: seyd/sdks/js/core/src/session.ts:13

Properties

allowMultiple?

optional allowMultiple?: boolean

Defined in: seyd/sdks/js/core/src/session.ts:48

Allow more than one live session to the same robot from this document (multi-view). Default: a new session closes the previous one.

---

canvas?

optional canvas?: HTMLCanvasElement | null

Defined in: seyd/sdks/js/core/src/session.ts:17

Canvas to render the primary video channel into.

---

clientName?

optional clientName?: string

Defined in: seyd/sdks/js/core/src/session.ts:30

---

emitFrames?

optional emitFrames?: boolean

Defined in: seyd/sdks/js/core/src/session.ts:19

Also emit frame events (VideoFrame, transferred) — needed if you render yourself.

---

host?

optional host?: "auto" | "worker" | "inline"

Defined in: seyd/sdks/js/core/src/session.ts:21

‘worker’ (default when supported) or ‘inline’.

---

loss?

optional loss?: { burst: number; rate: number; } | null

Defined in: seyd/sdks/js/core/src/session.ts:25

---

paths?

optional paths?: string[] | null

Defined in: seyd/sdks/js/core/src/session.ts:29

Debug: only race candidates with these labels (e.g. [‘srflx’]).

---

presentationDelayMs?

optional presentationDelayMs?: number

Defined in: seyd/sdks/js/core/src/session.ts:39

Hold each decoded frame until its capture timestamp is due, up to this many ms behind the capture timeline — trading latency for immunity to pipeline jitter, chiefly the once-per-GOP keyframe burst (ADR 0005). 0 restores decode-on-arrival. Leave unset to take the value from the robot’s QoS profile (latency 50, balanced 100, quality 150); setting it overrides the profile for this session.

---

qos?

optional qos?: string | null

Defined in: seyd/sdks/js/core/src/session.ts:24

---

relay?

optional relay?: boolean

Defined in: seyd/sdks/js/core/src/session.ts:46

Fall back to the cloud relay when no direct path connects and the robot allows it (ADR 0010). Default true. The session then reports transport: 'relay' and emits relay with the direct-path diagnosis.

---

retryMs?

optional retryMs?: number

Defined in: seyd/sdks/js/core/src/session.ts:40

---

signalUrl

signalUrl: string

Defined in: seyd/sdks/js/core/src/session.ts:14

---

token?

optional token?: string

Defined in: seyd/sdks/js/core/src/session.ts:15

---

trace?

optional trace?: boolean

Defined in: seyd/sdks/js/core/src/session.ts:27

Collect a per-frame pipeline trace in lastStats.trace (debugging).

---

worker?

optional worker?: Worker

Defined in: seyd/sdks/js/core/src/session.ts:23

Supply your own Worker (built from @seyd/core/worker) if your bundler needs it.