Properties

Automatically generated property docs.

AudioProps

  • scene.audio.file: PathProp
    Name

    Audio File

    Description

    Path to audio file.

    Animatable

    False

    Required

    True

    Is File

    True

  • scene.audio.start: FloatProp
    Name

    Start Time

    Description

    Timestamp, in seconds, you press the first note.

    Animatable

    False

    Required

    True

    Default

    0.0

BlocksProps

  • scene.blocks.speed: FloatProp
    Name

    Speed

    Description

    If X is the distance between the top of the screen and thetop of the keyboard, the blocks travel speed * X per second.

    Animatable

    True

    Required

    True

    Default

    0.5

  • scene.blocks.color: RGBProp
    Name

    Color

    Description

    Color of the blocks.

    Animatable

    True

    Required

    True

    Default

    [150 160 240]

  • scene.blocks.radius: FloatProp
    Name

    Corner Radius

    Description

    Corner rounding radius in coords.

    Animatable

    True

    Modifiers

    Coords

    Required

    True

    Default

    0.25

    Minimum

    0

  • scene.blocks.glow_intensity: FloatProp
    Name

    Glow Intensity

    Description

    Intensity of glow around blocks.

    Animatable

    True

    Required

    True

    Default

    0.3

    Minimum

    0

  • scene.blocks.glow_color: RGBProp
    Name

    Glow Color

    Description

    Color of the glow.

    Animatable

    True

    Required

    True

    Default

    [230 230 255]

  • scene.blocks.glow_radius: FloatProp
    Name

    Glow Radius

    Description

    Radius of glow around blocks in coords.

    Animatable

    True

    Modifiers

    Coords

    Required

    True

    Default

    0.4

CompositionProps

  • scene.composition.margin_start: FloatProp
    Name

    Start Margin

    Description

    Pause, in seconds, before first note starts.

    Animatable

    False

    Required

    True

    Default

    3.0

    Minimum

    0

  • scene.composition.margin_end: FloatProp
    Name

    End Margin

    Description

    Pause, in seconds, after the last note ends.

    Animatable

    False

    Required

    True

    Default

    3.0

    Minimum

    0

  • scene.composition.fade_in: FloatProp
    Name

    Fade In

    Description

    Seconds of fade in.

    Animatable

    False

    Required

    True

    Default

    1.0

    Minimum

    0

  • scene.composition.fade_out: FloatProp
    Name

    Fade Out

    Description

    Seconds of fade out.

    Animatable

    False

    Required

    True

    Default

    1.0

    Minimum

    0

  • scene.composition.fade_blur: FloatProp
    Name

    Fade Blur

    Description

    Blur radius of fade in coords.

    Animatable

    False

    Modifiers

    Coords

    Required

    True

    Default

    1.0

GlareProps

  • scene.glare.radius: FloatProp
    Name

    Radius

    Description

    Radius of glare in coords.

    Animatable

    True

    Modifiers

    Coords

    Required

    True

    Default

    3.0

    Minimum

    0

  • scene.glare.intensity: FloatProp
    Name

    Intensity

    Description

    Intensity of glare.

    Animatable

    True

    Required

    True

    Default

    0.9

    Minimum

    0

  • scene.glare.jitter: FloatProp
    Name

    Jitter

    Description

    Range of random multiplier.

    Animatable

    True

    Required

    True

    Default

    0.08

    Minimum

    0

  • scene.glare.streaks: IntProp
    Name

    Streaks

    Description

    Number of streaks.

    Animatable

    True

    Required

    True

    Default

    6

    Minimum

    0

    Maximum

    20

KeyboardProps

  • scene.keyboard.file: PathProp
    Name

    Video File

    Description

    Path to video recording of keyboard.

    Animatable

    False

    Required

    True

    Is File

    True

  • scene.keyboard.start: FloatProp
    Name

    Start

    Description

    Timestamp, in seconds, when the first note starts in the video.

    Animatable

    False

    Required

    True

  • scene.keyboard.end: FloatProp
    Name

    End

    Description

    Timestamp, in seconds, when the last note starts in the video.

    Animatable

    False

    Required

    True

  • scene.keyboard.crop: ArrayProp
    Name

    Crop

    Description

    Crop points of the keyboard. See docs for more info.

    Animatable

    False

    Required

    True

  • scene.keyboard.dim_mult: FloatProp
    Name

    Multiplicative Dimming

    Description

    Multiplier to pixel brightness.

    Animatable

    True

    Required

    True

    Default

    1.0

    Minimum

    0

  • scene.keyboard.dim_add: FloatProp
    Name

    Additive Dimming

    Description

    Value added to pixel brightness (0 to 255).

    Animatable

    True

    Required

    True

    Default

    0.0

  • scene.keyboard.below_length: FloatProp
    Name

    Length of Below Section

    Description

    Length in coords of section below keyboard.

    Animatable

    True

    Modifiers

    Coords

    Required

    True

    Default

    7.0

    Minimum

    0

  • scene.keyboard.octave_lines: BoolProp
    Name

    Octave Lines

    Description

    Whether to render octave lines.

    Animatable

    True

    Required

    True

    Default

    True

MidiProps

  • scene.midi.file: PathProp
    Name

    MIDI File

    Description

    Path to MIDI file.

    Animatable

    False

    Required

    True

    Is File

    True

  • scene.midi.speed: FloatProp
    Name

    Speed Multiplier

    Description

    MIDI notes speed multiplier.

    Animatable

    False

    Required

    True

    Default

    1.0

  • scene.midi.min_length: FloatProp
    Name

    Minimum Duration

    Description

    Min duration of a note in seconds.

    Animatable

    False

    Required

    True

    Default

    0.08

    Minimum

    0

PianoProps

  • scene.piano.black_width_fac: FloatProp
    Name

    Black Key Width Factor

    Description

    Black key width as factor of white key width.

    Animatable

    False

    Required

    True

    Default

    0.6

    Minimum

    0

ParticleProps

  • scene.ptcls.pps: FloatProp
    Name

    Particles per Second

    Description

    Number of particles to emit per note per second.

    Animatable

    True

    Required

    True

    Default

    40.0

    Minimum

    0

  • scene.ptcls.air_resist: FloatProp
    Name

    Air Resistance

    Description

    Velocity multiplies by this every second.

    Animatable

    True

    Required

    True

    Default

    0.6

    Minimum

    0

  • scene.ptcls.lifetime: FloatProp
    Name

    Lifetime

    Description

    Particle lifetime in seconds.

    Animatable

    True

    Required

    True

    Default

    3.0

    Minimum

    0

  • scene.ptcls.x_vel: FloatProp
    Name

    X Velocity

    Description

    Initial X velocity range in coords/sec.

    Animatable

    True

    Modifiers

    Coords, SecToFrame

    Required

    True

    Default

    1.0

    Minimum

    0

  • scene.ptcls.y_vel: FloatProp
    Name

    Y Velocity

    Description

    Initial Y velocity range in coords/sec.

    Animatable

    True

    Modifiers

    Coords, SecToFrame

    Required

    True

    Default

    4.0

    Minimum

    0

  • scene.ptcls.wind_strength: FloatProp
    Name

    Wind Strength

    Description

    Strength multiplier of wind affecting particles.

    Animatable

    True

    Required

    True

    Default

    1.0

  • scene.ptcls.heat_strength: FloatProp
    Name

    Heat Strength

    Description

    Strength multiplier of heat affecting particles.

    Animatable

    True

    Required

    True

    Default

    1.0

  • scene.ptcls.gravity: FloatProp
    Name

    Gravity

    Description

    Strength multiplier of gravity affecting particles.

    Animatable

    True

    Required

    True

    Default

    1.0

VideoProps

  • scene.video.resolution: ArrayProp
    Name

    Resolution

    Description

    Output video resolution.

    Animatable

    False

    Required

    True

    Default

    [1920 1080]

  • scene.video.fps: IntProp
    Name

    FPS

    Description

    Frames per second of output video.

    Animatable

    False

    Required

    True

    Default

    30

    Minimum

    1

  • scene.video.vcodec: StrProp
    Name

    Video Codec

    Description

    Codec for video, passed to FFmpeg.

    Animatable

    False

    Required

    True

    Default

    libx265