git.sesse.net Git - mlt/blob - src/modules/core/filter_panner.yml

   1 schema_version: 0.2
   2 type: filter
   3 identifier: panner
   4 title: Audio Pan
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Dan Dennedy
   8 license: LGPLv2.1
   9 language: en
  10 tags:
  11   - Audio
  12 description: Pan an audio channel, adjust balance, or adjust fade.
  13 notes: Only handles up to 6 channels. Needs more work balance for surround and other channel layouts.
  14 parameters:
  15   - identifier: start
  16     title: Start
  17     description: >
  18       The position of the audio relative to its neighbor channel. For example,
  19       when channel is set to 0 for left, then start 0 is full left, 0.5 is
  20       center, and 1.0 is full right.
  21     type: float
  22     argument: true
  23     mutable: yes
  24     minimum: 0
  25     maximum: 1
  26
  27   - identifier: end
  28     title: End
  29     description: >
  30       The ending value of the audio position. It will be interpolated from
  31       start to end over the in-out range.
  32     type: float
  33     mutable: yes
  34     minimum: 0
  35     maximum: 1
  36
  37   - identifier: channel
  38     title: Channel
  39     type: integer
  40     description: >
  41       For stereo: 0 for front left, 1 for front right, -1 for front balance.
  42       For quad: 2 for back left, 3 for back right, -2 for rear balance,
  43       -3 for left fade, -4 for right fade.
  44     minimum: -4
  45     maximum: 5
  46     default: -1
  47
  48   - identifier: gang
  49     title: Gang
  50     description: >
  51       Whether to gang together the front and back when using balance or to
  52       gang together the left and right when using fade.
  53     type: integer
  54     minimum: 0
  55     maximum: 1
  56     default: 0
  57     widget: checkbox