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

    Interface SendTransferParams

    Construction parameters for a SendTransfer, assembled by FileTransferManager.sendFile.

    interface SendTransferParams {
        channels: RTCDataChannel[];
        checksum: boolean;
        chunkSize: number;
        highWaterMark: number;
        id: string;
        lowWaterMark: number;
        offerTimeoutMs: number;
        peerId: string;
        resumable: boolean;
        sendControl: ControlSender;
        source: FileSource;
    }
    Index

    Properties

    channels checksum chunkSize highWaterMark id lowWaterMark offerTimeoutMs peerId resumable sendControl source

    Properties

    channels: RTCDataChannel[]

    Binary data channels (one per parallel channel) that chunks are striped across.

    checksum: boolean

    Whether to compute and send a SHA-256 digest for receiver verification.

    chunkSize: number

    Payload bytes per chunk.

    highWaterMark: number

    Backpressure high-water mark in bytes.

    id: string

    Unique transfer id shared with the remote peer.

    lowWaterMark: number

    Backpressure low-water mark in bytes.

    offerTimeoutMs: number

    Milliseconds to wait for the receiver to accept before failing; 0 disables.

    peerId: string

    Identifier of the receiving peer.

    resumable: boolean

    When true, a mid-transfer channel drop pauses (not fails) so the send can be resumed.

    sendControl: ControlSender

    Callback used to emit control messages (offer, sent, cancel, …) to the peer.

    source: FileSource

    Source the file bytes are read from.

    Settings

    Member Visibility

    On This Page

    Properties