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

    Interface ReceiveTransferParams

    Construction parameters for a ReceiveTransfer, derived from the sender's offer.

    interface ReceiveTransferParams {
        checksum: boolean;
        chunkSize: number;
        id: string;
        metadata: FileMetadata;
        peerId: string;
        sendControl: ControlSender;
        totalChunks: number;
    }
    Index

    Properties

    checksum: boolean

    Whether the sender will provide a SHA-256 digest to verify against.

    chunkSize: number

    Payload bytes per chunk, as chosen by the sender.

    id: string

    Transfer id from the offer.

    metadata: FileMetadata

    File metadata advertised in the offer.

    peerId: string

    Identifier of the sending peer.

    sendControl: ControlSender

    Callback used to emit control messages (accept, reject, complete, …) to the sender.

    totalChunks: number

    Total number of chunks expected.