Class ReferenceSfuMedia

Reference implementation of SfuMediaInterface and CascadePipeInterface. It owns the correct in-memory bookkeeping of a room's routes and cascade links (so getRoutes and idempotent add/remove work out of the box) and delegates the actual media forwarding to an injected SfuMediaDriver. This is the missing keystone between rtcforge-sfu (control plane) and a real media plane, without coupling the two packages.

Example

const media = new ReferenceSfuMedia({
  onPipeLink: (roomId, from, to) => pipeBetweenNodes(roomId, from, to), // your mediasoup pipe
  onUnpipeLink: (roomId, from, to) => unpipeBetweenNodes(roomId, from, to),
})
const bridge = new SfuBridge(router, media)
const cascade = new CascadeBridge(tree, media)

Implements

Index

Constructors

constructor

Methods

addRoute getLinks getRoutes pipeLink removeCascadeRoute removeRoute unpipeLink

Constructors

constructor

new ReferenceSfuMedia(
driver?: SfuMediaDriver,
logger?: Logger,
): ReferenceSfuMedia
Parameters
- driver: SfuMediaDriver = {}
- logger: Logger = noopLogger
Returns ReferenceSfuMedia
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:45

Methods

addRoute

addRoute(roomId: string, nodeId: string): void
Add a forwarding route for roomId targeting the node nodeId. May be async so real pipe setup can be awaited and surface failures.
Parameters
- roomId: string
- nodeId: string
Returns void
Implementation of SfuMediaInterface.addRoute
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:50

getLinks

getLinks(roomId: string): string[]
Snapshot of the cascade links currently tracked for a room (from>to keys).
Parameters
- roomId: string
Returns string[]
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:95

getRoutes

getRoutes(roomId: string): string[]
Return the node ids currently routed for roomId.
Parameters
- roomId: string
Returns string[]
Implementation of SfuMediaInterface.getRoutes
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:66

pipeLink

pipeLink(roomId: string, fromNodeId: string, toNodeId: string): void
Establish a media pipe carrying roomId from fromNodeId to toNodeId. May be async so the pipe setup can be awaited and surface failures.
Parameters
- roomId: string
- fromNodeId: string
- toNodeId: string
Returns void
Implementation of CascadePipeInterface.pipeLink
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:77

removeCascadeRoute

removeCascadeRoute(roomId: string, nodeId: string): void
Remove only the cascade route from roomId to nodeId.
Parameters
- roomId: string
- nodeId: string
Returns void
Implementation of SfuMediaInterface.removeCascadeRoute
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:70

removeRoute

removeRoute(roomId: string): void
Remove all forwarding routes for roomId.
Parameters
- roomId: string
Returns void
Implementation of SfuMediaInterface.removeRoute
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:58

unpipeLink

unpipeLink(roomId: string, fromNodeId: string, toNodeId: string): void
Tear down the media pipe carrying roomId from fromNodeId to toNodeId.
Parameters
- roomId: string
- fromNodeId: string
- toNodeId: string
Returns void
Implementation of CascadePipeInterface.unpipeLink
- Defined in packages/sfu/src/ReferenceSfuMedia.ts:86

Class ReferenceSfuMedia

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ReferenceSfuMedia

Methods

addRoute

Parameters

Returns void

getLinks

Parameters

Returns string[]

getRoutes

Parameters

Returns string[]

pipeLink

Parameters

Returns void

removeCascadeRoute

Parameters

Returns void

removeRoute

Parameters

Returns void

unpipeLink

Parameters

Returns void

Settings

On This Page