index :: ui

ui.env

envelope editor widget

доступно с версии: 0.5

---

информация

Editor of sound envelope function

методы:

• adsr creates ADSR envelope with one stop point
  параметры:

  • ATTACK attack time
    тип: float
    единица: ms
    обязательно: True
    

  • DECAY decay time
    тип: float
    единица: ms
    обязательно: True
    

  • SUSTAIN sustain level
    тип: float
    единица: %
    обязательно: True
    

  • RELEASE release time
    тип: float
    единица: ms
    обязательно: True
    

• ar creates AR envelope without stop points
  параметры:

  • ATTACK attack time
    тип: float
    единица: ms
    обязательно: True
    

  • RELEASE release time
    тип: float
    единица: ms
    обязательно: True
    

• asr creates ASR envelope with one stop point
  параметры:

  • ATTACK attack time
    тип: float
    единица: ms
    обязательно: True
    

  • RELEASE release time
    тип: float
    единица: ms
    обязательно: True
    

• at output envelope value at specified position to second outlet
  параметры:

  • VAL position (in milliseconds if unit arg is ommited )
    тип: float
    обязательно: True
    

  • [UNIT] position unit: ms, % or *(phase)
    тип: symbol
    

• clear clear specified preset
  параметры:
  • IDX preset index
    тип: int
    обязательно: True
    
• eadsr creates exponential ADSR envelope with one stop point
  параметры:

  • ATTACK attack time
    тип: float
    единица: ms
    обязательно: True
    

  • ATTACK_CURVE attack segment curve
    тип: float
    обязательно: True
    

  • DECAY decay time
    тип: float
    единица: ms
    обязательно: True
    

  • DECAY_CURVE decay segment curve
    тип: float
    обязательно: True
    

  • SUSTAIN sustain level
    тип: float
    единица: %
    обязательно: True
    

  • RELEASE release time
    тип: float
    единица: ms
    обязательно: True
    

  • RELEASE_CURVE release segment curve
    тип: float
    обязательно: True
    

• ear creates exponential AR envelope without stop points
  параметры:

  • ATTACK attack time
    тип: float
    единица: ms
    обязательно: True
    

  • ATTACK_CURVE attack segment curve
    тип: float
    обязательно: True
    

  • RELEASE release time
    тип: float
    единица: ms
    обязательно: True
    

  • RELEASE_CURVE release segment curve
    тип: float
    обязательно: True
    

• easr creates exponential AR envelope with one stop point
  параметры:

  • ATTACK attack time
    тип: float
    единица: ms
    обязательно: True
    

  • ATTACK_CURVE attack segment curve
    тип: float
    обязательно: True
    

  • RELEASE release time
    тип: float
    единица: ms
    обязательно: True
    

  • RELEASE_CURVE release segment curve
    тип: float
    обязательно: True
    

• exp creates exponential-segmented envelope with arbitrary number of segments
  параметры:

  • VAL0 begin value
    тип: float
    обязательно: True
    

  • LEN0 line length
    тип: float
    единица: ms
    обязательно: True
    

  • CURVE0 segment curve
    тип: float
    обязательно: True
    

  • VAL1 value
    тип: float
    обязательно: True
    

  • [LEN1] segment length
    тип: float
    

  • [CURVE1] segment curve
    тип: float
    

  • [VAL2] value
    тип: float
    

• interp for this object acts as load, no interpolation performed
  

• line creates line-segmented envelope with arbitrary number of segments
  параметры:

  • VAL0 begin value
    тип: float
    обязательно: True
    

  • LEN0 line length
    тип: float
    единица: ms
    обязательно: True
    

  • VAL1 value
    тип: float
    обязательно: True
    

  • [LEN1] segment length
    тип: float
    

  • [VAL2] value
    тип: float
    

• load loads specified preset
  параметры:
  • IDX preset index
    тип: int
    обязательно: True
    
• pos set UI element position
  параметры:

  • X top left x-coord
    тип: float
    обязательно: True
    

  • Y top right y-coord
    тип: float
    обязательно: True
    

• sigmoid creates sigmoid-segmented envelope with arbitrary number of segments
  параметры:

  • VAL0 begin value
    тип: float
    обязательно: True
    

  • LEN0 line length
    тип: float
    единица: ms
    обязательно: True
    

  • CURVE0 segment curve
    тип: float
    обязательно: True
    

  • VAL1 value
    тип: float
    обязательно: True
    

  • [LEN1] segment length
    тип: float
    

  • [CURVE1] segment curve
    тип: float
    

  • [VAL2] value
    тип: float
    

• sin2 creates quadratic sine-segmented envelope with arbitrary number of segments
  параметры:

  • VAL0 begin value
    тип: float
    обязательно: True
    

  • LEN0 line length
    тип: float
    единица: ms
    обязательно: True
    

  • VAL1 value
    тип: float
    обязательно: True
    

  • [LEN1] segment length
    тип: float
    

  • [VAL2] value
    тип: float
    

• step creates step-segmented envelope with arbitrary number of segments
  параметры:

  • VAL0 begin value
    тип: float
    обязательно: True
    

  • LEN0 step length
    тип: float
    единица: ms
    обязательно: True
    

  • VAL1 value
    тип: float
    обязательно: True
    

  • [LEN1] segment length
    тип: float
    

  • [VAL2] value
    тип: float
    

• store stores specified preset
  параметры:
  • IDX preset index
    тип: int
    обязательно: True
    

свойства:

• @length Запросить/установить envelope time length
  тип: float
  единица: ms
  минимальное значение: 10
  по умолчанию: 400
  

• @presetname Запросить/установить preset name for using with [ui.preset]
  тип: symbol
  по умолчанию: (null)
  

• @send Запросить/установить send destination
  тип: symbol
  по умолчанию: (null)
  

• @receive Запросить/установить receive source
  тип: symbol
  по умолчанию: (null)
  

• @size Запросить/установить element size (width, height pair)
  тип: list
  по умолчанию: 200 150
  

• @pinned Запросить/установить pin mode. if 1 - put element to the lowest level
  тип: bool
  по умолчанию: 0
  

• @norm Запросить/установить normalize input values
  тип: bool
  по умолчанию: 1
  

• @active_color Запросить/установить element active color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0 0.75 1 1
  

• @line_color Запросить/установить line color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0.1 0.1 0.1 1
  

• @background_color Запросить/установить element background color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0.93 0.93 0.93 1
  

• @border_color Запросить/установить border color (list of red, green, blue values in 0-1 range)
  тип: list
  по умолчанию: 0.6 0.6 0.6 1
  

• @fontsize Запросить/установить fontsize
  тип: int
  диапазон: 4..100
  по умолчанию: 11
  

• @fontname Запросить/установить fontname
  тип: symbol
  варианты: Courier, DejaVu, Helvetica, Monaco, Times
  по умолчанию: Helvetica
  

• @fontweight Запросить/установить font weight
  тип: symbol
  варианты: normal, bold
  по умолчанию: normal
  

• @fontslant Запросить/установить font slant
  тип: symbol
  варианты: roman, italic
  по умолчанию: roman
  

• @mouse_events Запросить/установить mouse events output mode. If on outputs @mouse_down, @mouse_up and @mouse_drag events
  тип: bool
  по умолчанию: 0
  

• @output_mode Запросить/установить output envelope mode. If set to "mouse_up" - output envelope on mouse up if Ctrl/Cmd key not pressed. If set to "drag" - output envelope on every change. Note: in any mode you can output evenlope with Ctrl/Cmd + mouse down.
  тип: symbol
  варианты: mouse_up, drag
  по умолчанию: mouse_up
  

входы:

• set new envelope and output it
  тип: control

выходы:

• envelope
  тип: control
• float: envelope value at time moment
  тип: control

ключевые слова:

ui envelope

Авторы: Serge Poltavsky

Лицензия: GPL3 or later