@mega-yfue/eufy-sdk / LiveStream

Class: LiveStream

Extends

• EventEmitter

Constructors

Constructor

new LiveStream(session, opts?): LiveStream;

Parameters

session

P2PSession

opts?

LiveStreamOptions = {}

Returns

LiveStream

Overrides

EventEmitter.constructor

Methods

emit()

Call Signature

emit(event, frame): boolean;

Parameters

event

"video"

frame

LiveVideoFrame

Returns

boolean

Inherited from

EventEmitter.emit

Call Signature

emit(event, frame): boolean;

Parameters

event

"audio"

frame

LiveAudioFrame

Returns

boolean

Inherited from

EventEmitter.emit

Call Signature

emit(event): boolean;

Parameters

event

"start" | "stop" | "unacknowledged"

Returns

boolean

Inherited from

EventEmitter.emit

Call Signature

emit(event, err): boolean;

Parameters

event

"error"

err

Error

Returns

boolean

Inherited from

EventEmitter.emit

---

nudge()

nudge(force?): void;

Re-issue the start command (idempotent while listening) — the media-start / keepalive nudge. The shared source calls this to retry a start that raced key negotiation, until frames flow. Safe to call repeatedly: startLiveMedia self-selects start vs keepalive per the session state.

Parameters

force?

boolean

Returns

void

---

on()

Call Signature

on(event, listener): this;

Parameters

event

"video"

listener

(frame) => void

Returns

this

Inherited from

EventEmitter.on

Call Signature

on(event, listener): this;

Parameters

event

"audio"

listener

(frame) => void

Returns

this

Inherited from

EventEmitter.on

Call Signature

on(event, listener): this;

Parameters

event

"start" | "stop"

listener

() => void

Returns

this

Inherited from

EventEmitter.on

Call Signature

on(event, listener): this;

Parameters

event

"error"

listener

(err) => void

Returns

this

Inherited from

EventEmitter.on

Call Signature

on(event, listener): this;

Parameters

event

"budget"

listener

(notice) => void

Returns

this

Inherited from

EventEmitter.on

Call Signature

on(event, listener): this;

This channel's media start was abandoned unacknowledged — see LiveStreamHandle.

Parameters

event

"unacknowledged"

listener

() => void

Returns

this

Inherited from

EventEmitter.on

---

start()

start(): this;

Begin streaming: attach the frame listener and tell the station to start realtime media.

Returns

this

---

stop()

stop(): void;

Stop streaming: detach the listener and tell the station to stop. Idempotent.

Returns

void