@mega-yfue/eufy-sdk / LiveStreamHandle
Interface: LiveStreamHandle
The consumer-facing surface of a live stream — a STRUCTURAL subset of the concrete transport/p2p/LiveStream (an EventEmitter), so the media contract can live in core without importing transport. The concrete LiveStream is assignable to this.
Extended by
Methods
nudge()?
nudge?(force?): void;Re-issue the media-start command (start-race retry / keepalive nudge). Optional.
force states that the channel is NOT being served, so a real start is required rather than a keepalive. An own-session camera sends one or the other depending on whether its session believes the channel is already started — a belief that outlives a station which acknowledged a start and then served nothing.
Parameters
force?
boolean
Returns
void
on()
Call Signature
on(event, listener): this;Parameters
event
"video"
listener
(frame) => void
Returns
this
Call Signature
on(event, listener): this;Parameters
event
"audio"
listener
(frame) => void
Returns
this
Call Signature
on(event, listener): this;Parameters
event
"start" | "stop"
listener
() => void
Returns
this
Call Signature
on(event, listener): this;Parameters
event
"error"
listener
(err) => void
Returns
this
Call Signature
on(event, listener): this;Battery-budget elapsed — extend to keep streaming or let it auto-stop (battery cameras only).
Parameters
event
"budget"
listener
(notice) => void
Returns
this
Call Signature
on(event, listener): this;A media start was repeated to its acknowledgement deadline and abandoned.
The start is repeated byte-identically, so an abandonment is many sends with no reply — the device was never told to stream, and a warm-up waiting on it can only time out. Distinct from error: the transport is intact and the session is simply not being heard.
Parameters
event
"unacknowledged"
listener
() => void
Returns
this
start()
start(): this;Returns
this
stop()
stop(): void;Returns
void