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

    Variable TransferEventConst

    TransferEvent: {
        Complete: "complete";
        Error: "error";
        Progress: "progress";
        StateChanged: "state-changed";
    } = ...

    Events emitted by an individual Transfer.

    Type Declaration

    • ReadonlyComplete: "complete"

      Fires once when the transfer reaches TransferState.Completed, with the transfer id.

    • ReadonlyError: "error"

      Fires when the transfer fails or is cancelled with a reason, carrying a FileTransferError.

    • ReadonlyProgress: "progress"

      Fires as bytes move, carrying a TransferProgress snapshot.

    • ReadonlyStateChanged: "state-changed"

      Fires on every state change, with the new and previous TransferState.