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

    Interface SendOptions

    Per-send overrides accepted by FileTransferManager.sendFile; merged over the manager defaults.

    interface SendOptions {
        checksum?: boolean;
        chunkSize?: number;
        highWaterMark?: number;
        lowWaterMark?: number;
        offerTimeoutMs?: number;
        parallelChannels?: number;
        transferId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    checksum? chunkSize? highWaterMark? lowWaterMark? offerTimeoutMs? parallelChannels? transferId?

    Properties

    checksum?: boolean

    Whether to compute and verify a SHA-256 checksum for this transfer.

    inherited from the manager (true unless overridden)

    chunkSize?: number

    Payload bytes per chunk (excluding the frame header).

    DEFAULT_CHUNK_SIZE

    highWaterMark?: number

    Data-channel bufferedAmount (bytes) at which the sender pauses to apply backpressure.

    DEFAULT_HIGH_WATER_MARK

    lowWaterMark?: number

    bufferedAmountLowThreshold (bytes) at which the paused sender resumes.

    DEFAULT_LOW_WATER_MARK

    offerTimeoutMs?: number

    Milliseconds a sender waits for the receiver to accept an offer before the transfer fails (releasing its open channels). 0 disables the timeout.

    DEFAULT_OFFER_TIMEOUT_MS

    parallelChannels?: number

    Number of parallel binary data channels opened per transfer; chunks are striped across them.

    DEFAULT_PARALLEL_CHANNELS

    transferId?: string

    Explicit transfer id; a random id is generated when omitted.

    Settings

    Member Visibility

    On This Page

    Properties