Class MediaEntity`Abstract`

Server-side (mediasoup SFU) base class shared by Producer and Consumer. Wraps a mediasoup entity, forwards its transportclose to a MediaEntityEvent.Closed event (emitted at most once), and guards pause/ resume/close so they are idempotent.

Hierarchy (View Summary)

EventEmitter<MediaEntityEvents>
- MediaEntity
  - Producer
  - Consumer

Index

Constructors

constructor

new MediaEntity(peerId: string, entity: MediaEntityHandle): MediaEntity
Parameters
- peerId: string
  Id of the owning peer.
- entity: MediaEntityHandle
  The underlying mediasoup producer/consumer handle to wrap.
Returns MediaEntity
Overrides EventEmitter.constructor
- Defined in media/src/MediaEntity.ts:73

Properties

`Protected` `Readonly`_entity

_entity: MediaEntityHandle

The wrapped mediasoup producer/consumer handle.

`Readonly`peerId

peerId: string

Id of the peer this entity belongs to.

`Abstract` `Readonly`role

role: MediaEntityRole

Whether this entity produces or consumes media.

Accessors

closed

get closed(): boolean
Whether the entity has been closed.

Returns boolean
- Defined in media/src/MediaEntity.ts:96

id

get id(): string
The underlying entity's id.

Returns string
- Defined in media/src/MediaEntity.ts:81

kind

get kind(): MediaKind
The media kind ("audio" or "video").

Returns MediaKind
- Defined in media/src/MediaEntity.ts:86

paused

get paused(): boolean
Whether the entity is currently paused.

Returns boolean
- Defined in media/src/MediaEntity.ts:91

Methods

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
- Defined in media/src/MediaEntity.ts:126

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).
Inherited from EventEmitter.emit
- Defined in core/src/EventEmitter.ts:95

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).
Inherited from EventEmitter.listenerCount
- Defined in core/src/EventEmitter.ts:128

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.
Inherited from EventEmitter.off
- Defined in core/src/EventEmitter.ts:74

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.
Inherited from EventEmitter.on
- Defined in core/src/EventEmitter.ts:43

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.
Inherited from EventEmitter.once
- Defined in core/src/EventEmitter.ts:57

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.
- Defined in media/src/MediaEntity.ts:105

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.
Inherited from EventEmitter.removeAllListeners
- Defined in core/src/EventEmitter.ts:116

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.
- Defined in media/src/MediaEntity.ts:116

Class MediaEntityAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MediaEntity

Properties

Protected Readonly_entity

ReadonlypeerId

Abstract Readonlyrole

Accessors

closed

Returns boolean

id

Returns string

kind

Returns MediaKind

paused

Returns boolean

Methods

close

Returns void

emit

Type Parameters

Parameters

Returns boolean

Remarks

listenerCount

Type Parameters

Parameters

Returns number

off

Type Parameters

Parameters

Returns this

Remarks

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

Remarks

pause

Returns Promise<void>

Remarks

removeAllListeners

Parameters

Returns this

resume

Returns Promise<void>

Remarks

Settings

On This Page

Class MediaEntity`Abstract`

`Protected` `Readonly`_entity

`Readonly`peerId

`Abstract` `Readonly`role