Class Consumer

ReadonlypeerId

closed

• get closed(): boolean

  Whether the entity has been closed.

  Returns boolean

id

• get id(): string

  The underlying entity's id.

  Returns string

kind

• get kind(): MediaKind

  The media kind ("audio" or "video").

  Returns MediaKind

paused

• get paused(): boolean

  Whether the entity is currently paused.

  Returns boolean

close

• close(): void

  Closes the entity and releases its resources. Idempotent: safe to call multiple times, and MediaEntityEvent.Closed is emitted only once.

  Returns void

emit

• emit<K extends keyof MediaEntityEvents>(
      event: K,
      ...args: MediaEntityEvents[K],
  ): boolean

  Synchronously invokes every listener registered for event, in registration order.

  Type Parameters

  • K extends keyof MediaEntityEvents

  Parameters

  • event: K

    The event name to emit.

  • ...args: MediaEntityEvents[K]

    The argument tuple to pass to each listener, matching Events[event].

  Returns boolean

  true if at least one listener was invoked, false if there were none.

  Remarks

  The listener list is snapshotted before dispatch, so mutations made by handlers take effect only on subsequent emissions. Listeners are isolated: if one throws, the remaining listeners still run and the error is surfaced via console.error rather than swallowed silently (consistent with LocalMessageBus).

listenerCount

• listenerCount<K extends keyof MediaEntityEvents>(event: K): number

  Returns the number of listeners currently registered for event.

  Type Parameters

  • K extends keyof MediaEntityEvents

  Parameters

  • event: K

    The event name to count listeners for.

  Returns number

  The count of registered listeners (0 if none).

off

• off<K extends keyof MediaEntityEvents>(
      event: K,
      listener: (...args: MediaEntityEvents[K]) => void,
  ): this

  Removes a previously registered listener for event.

  Type Parameters

  • K extends keyof MediaEntityEvents

  Parameters

  • event: K

    The event name the listener was registered for.

  • listener: (...args: MediaEntityEvents[K]) => void

    The exact function reference passed to on or once.

  Returns this

  This emitter, for chaining.

  Remarks

  If the listener is not currently registered, this is a no-op. Only the first matching registration is removed.

on

• on<K extends keyof MediaEntityEvents>(
      event: K,
      listener: (...args: MediaEntityEvents[K]) => void,
  ): this

  Registers a listener that is invoked every time event is emitted.

  Type Parameters

  • K extends keyof MediaEntityEvents

  Parameters

  • event: K

    The event name to listen for.

  • listener: (...args: MediaEntityEvents[K]) => void

    Callback invoked with the event's argument tuple.

  Returns this

  This emitter, for chaining.

once

• once<K extends keyof MediaEntityEvents>(
      event: K,
      listener: (...args: MediaEntityEvents[K]) => void,
  ): this

  Registers a listener that is invoked at most once: it is removed automatically before being called the first time event is emitted.

  Type Parameters

  • K extends keyof MediaEntityEvents

  Parameters

  • event: K

    The event name to listen for.

  • listener: (...args: MediaEntityEvents[K]) => void

    Callback invoked with the event's argument tuple on the next emission.

  Returns this

  This emitter, for chaining.

  Remarks

  Remove a pending one-time listener by passing the same function reference to off.

pause

• pause(): Promise<void>

  Pauses the entity. No-op if already closed or paused.

  Returns Promise<void>

  Remarks

  Emits MediaEntityEvent.Paused when a pause actually occurs.

removeAllListeners

• removeAllListeners(event?: keyof MediaEntityEvents): this

  Removes listeners for a single event, or for all events.

  Parameters

  • Optionalevent: keyof MediaEntityEvents

    The event name to clear; if omitted, listeners for every event are removed.

  Returns this

  This emitter, for chaining.

resume

• resume(): Promise<void>

  Resumes the entity. No-op if closed or not paused.

  Returns Promise<void>

  Remarks

  Emits MediaEntityEvent.Resumed when a resume actually occurs.