IBM Aspera JavaScript Library
    Preparing search index...

    Interface ModifyTransferOptions

    interface ModifyTransferOptions {
        lock_min_rate?: boolean;
        lock_min_rate_kbps?: boolean;
        lock_rate_policy?: boolean;
        lock_target_rate?: boolean;
        lock_target_rate_kbps?: boolean;
        min_rate_kbps?: number;
        rate_policy?: "fixed" | "high" | "low" | "fair";
        target_rate_cap_kbps?: number;
        target_rate_kbps?: number;
    }
    Index

    Properties

    lock_min_rate? lock_min_rate_kbps? lock_rate_policy? lock_target_rate? lock_target_rate_kbps? min_rate_kbps? rate_policy? target_rate_cap_kbps? target_rate_kbps?

    Properties

    lock_min_rate?: boolean

    Use lock_min_rate_kbps instead.

    lock_min_rate_kbps?: boolean

    If true, lock the minimum transfer rate to the value set for min_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

    lock_rate_policy?: boolean

    Lock the rate policy to the value set for rate_policy.

    lock_target_rate?: boolean

    Use lock_target_rate_kbps instead.

    lock_target_rate_kbps?: boolean

    If true, lock the target transfer rate to the default value set for target_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

    min_rate_kbps?: number
    rate_policy?: "fixed" | "high" | "low" | "fair"

    The congestion control behavior to use when sharing bandwidth.

    • fixed - Transfer at the target rate regardless of actual network capacity. Do not share bandwidth. Not recommended.
    • high - When sharing bandwidth, transfer at twice the rate of a transfer using "fair" policy.
    • fair - Share bandwidth equally with other traffic.
    • low - Use only unutilized bandwidth.
    target_rate_cap_kbps?: number

    Maximum target rate for incoming transfers, in kilobits per second.

    target_rate_kbps?: number

    Ideal transfer rate, in kilobits per second.

    Settings

    Member Visibility

    On This Page

    Properties