ledfx
    Preparing search index...

    Interface Keybeat2dEffectConfig

    Specific configuration for the 'keybeat2d' effect.

    interface Keybeat2dEffectConfig {
        beat_frames?: string;
        center_horizontal?: number;
        center_vertical?: number;
        deep_diag?: boolean;
        fake_beat?: boolean;
        force_fit?: boolean;
        half_beat?: boolean;
        image_brightness?: number;
        image_location?: string;
        keep_aspect_ratio?: boolean;
        ping_pong?: boolean;
        ping_pong_skip?: boolean;
        skip_frames?: string;
        stretch_horizontal?: number;
        stretch_vertical?: number;
        type: "keybeat2d";
    }
    Index

    Properties

    beat_frames?: string

    Frame index to interpolate beats between

    ''
    
    center_horizontal?: number

    Center offset in horizontal direction percent of matrix width

    0
    

    -95

    95

    center_vertical?: number

    Center offset in vertical direction percent of matrix height

    0
    

    -95

    95

    deep_diag?: boolean

    Diagnostic overlayed on matrix

    False
    
    fake_beat?: boolean

    Trigger test code with 0.05 beat per frame

    False
    
    force_fit?: boolean

    Force fit to matrix

    False
    
    half_beat?: boolean

    half the beat input impulse, slow things down

    False
    
    image_brightness?: number

    Image brightness

    1.0
    

    0.1

    3.0

    image_location?: string

    Load gif from url or path

    ''
    
    keep_aspect_ratio?: boolean

    Preserve aspect ratio if force fit

    False
    
    ping_pong?: boolean

    Play gif forward and reverse, not just loop

    False
    
    ping_pong_skip?: boolean

    When ping pong, skip the first beat key frame on both ends, use when key beat frames are very close to start and ends only

    False
    
    skip_frames?: string

    Frames to remove from gif animation

    ''
    
    stretch_horizontal?: number

    Percentage of original to matrix width

    100
    

    1

    200

    stretch_vertical?: number

    Percentage of original to matrix height

    100
    

    1

    200

    type: "keybeat2d"