RTCForge API Reference v1.1.1
    Preparing search index...

    Variable SfuMessageTypeConst

    SfuMessageType: {
        ConnectTransport: "sfu-connect-transport";
        Consume: "sfu-consume";
        CreateTransport: "sfu-create-transport";
        GetCapabilities: "sfu-caps";
        Produce: "sfu-produce";
        ResumeConsumer: "sfu-resume-consumer";
    } = ...

    Request/response message types for the SFU control handshake carried over your signaling channel. A client walks this sequence to publish and subscribe: caps → create-transport → connect-transport → produce/consume → resume.

    SfuSignalHandler implements the server side so integrators do not have to hand-roll the protocol (the gap called out in the review). Deep mediasoup parameter objects (dtlsParameters, rtpParameters, rtpCapabilities) are carried opaquely and validated by mediasoup itself when applied; the envelope fields below are zod-validated on ingress.

    Type Declaration

    • ReadonlyConnectTransport: "sfu-connect-transport"
    • ReadonlyConsume: "sfu-consume"
    • ReadonlyCreateTransport: "sfu-create-transport"
    • ReadonlyGetCapabilities: "sfu-caps"
    • ReadonlyProduce: "sfu-produce"
    • ReadonlyResumeConsumer: "sfu-resume-consumer"