meadowbrook/docs/help.yml

Alternative meyda cli

title: meadowbrook
example: meadowbrook [options] <INPUT_PATH> <...FEATURES> [options]
type: object
properties:
  INPUT_PATH:
    title: Audio file to read
    type: string
  FEATURES:
    title: Features to extract
    type: array
    description: >
      List of features to extract seperated by space,
      If 'all' is in the list extract all
    items:
      enum:
        -  all
        -  rms
        -  energy
        -  zcr
        -  amplitudeSpectrum
        -  powerSpectrum
        -  spectralCentroid
        -  spectralFlatness
        -  spectralSlope
        -  spectralRolloff
        -  spectralSpread
        -  spectralSkewness
        -  spectralKurtosis
        -  loudness
        -  perceptualSpread
        -  perceptualSharpness
        -  mfcc
  "--o":
    title: Output path
    description: >
      File to write data too,
      if not specified prints to stdout
    type: string
    example: --o=<outputPath>
  "--bs":
    title: Buffer size
    example: --bs=<bufferSize>
    defaut: 512
    type: number
  "--w":
    title: Windowing function
    example: --w=<windowingFunction>
    defaut: hanning
    enum:
      -  blackman
      -  sine
      -  hanning
      -  hamming
  "--f":
    title: Frames per second
    example: --f=<fps>
    type: number
    description: >
      How many frames of feature data should
      be captured per second of audio
    defaut: 60
  "--format":
    title: Output format
    example: --format=<format>
    description: Structure of output json
    default: array
    enum:
      -  array
      -  object
  "-h":
    title: Print help
    type: boolean