jdxi_editor.midi.data.parameter.digital.spec
============================================

.. py:module:: jdxi_editor.midi.data.parameter.digital.spec

.. autoapi-nested-parse::

   Digital Spec File



Classes
-------

.. autoapisummary::

   jdxi_editor.midi.data.parameter.digital.spec.DigitalGroup
   jdxi_editor.midi.data.parameter.digital.spec.TabKey
   jdxi_editor.midi.data.parameter.digital.spec.TabDefinitionMixin
   jdxi_editor.midi.data.parameter.digital.spec.GroupBoxDefinitionMixin
   jdxi_editor.midi.data.parameter.digital.spec.DigitalTab
   jdxi_editor.midi.data.parameter.digital.spec.DigitalLFOTab
   jdxi_editor.midi.data.parameter.digital.spec.DigitalLFO
   jdxi_editor.midi.data.parameter.digital.spec.DigitalFilterTab
   jdxi_editor.midi.data.parameter.digital.spec.DigitalAmpTab
   jdxi_editor.midi.data.parameter.digital.spec.DigitalOscillatorTab
   jdxi_editor.midi.data.parameter.digital.spec.DigitalGroupBox
   jdxi_editor.midi.data.parameter.digital.spec.DigitalAmp
   jdxi_editor.midi.data.parameter.digital.spec.DigitalFilter
   jdxi_editor.midi.data.parameter.digital.spec.DigitalWave
   jdxi_editor.midi.data.parameter.digital.spec.DigitalToneModifyDisplay
   jdxi_editor.midi.data.parameter.digital.spec.DigitalDisplay
   jdxi_editor.midi.data.parameter.digital.spec.JDXiMidiDigital


Module Contents
---------------

.. py:class:: DigitalGroup

   Digital GroupBox Name Definitions


   .. py:attribute:: ADSR
      :type:  str
      :value: 'Envelope'



   .. py:attribute:: PWM
      :type:  str
      :value: 'PWM'



   .. py:attribute:: TUNING
      :type:  str
      :value: 'Tuning'



.. py:class:: TabKey

   Bases: :py:obj:`Protocol`


   tab ley


   .. py:attribute:: value
      :type:  str


   .. py:property:: label
      :type: str



   .. py:property:: icon
      :type: str



   .. py:property:: attr_name
      :type: str



.. py:class:: TabDefinitionMixin

   Tab Widget Definition


   .. py:attribute:: key
      :type:  str


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: icon
      :type:  Any


   .. py:property:: attr_name
      :type: str



.. py:class:: GroupBoxDefinitionMixin

   Group Box Widget Definition


   .. py:attribute:: key
      :type:  str


   .. py:attribute:: label
      :type:  str


   .. py:property:: attr_name
      :type: str



.. py:class:: DigitalTab(key: str, label: str, icon: Any)

   Bases: :py:obj:`TabDefinitionMixin`, :py:obj:`enum.Enum`


   Definition of Digital Editor-Level Tabs


   .. py:attribute:: PRESETS


   .. py:attribute:: PARTIAL_1
      :value: ('partial_1', 'Partial 1', 'mdi.numeric-1-circle-outline')



   .. py:attribute:: PARTIAL_2
      :value: ('partial_2', 'Partial 2', 'mdi.numeric-2-circle-outline')



   .. py:attribute:: PARTIAL_3
      :value: ('partial_3', 'Partial 3', 'mdi.numeric-3-circle-outline')



   .. py:attribute:: COMMON


   .. py:attribute:: MISC


   .. py:attribute:: OSCILLATOR


   .. py:attribute:: FILTER


   .. py:attribute:: AMP


   .. py:attribute:: LFO


   .. py:attribute:: MODLFO


   .. py:attribute:: key


   .. py:attribute:: label


   .. py:attribute:: icon


.. py:class:: DigitalLFOTab(key: str, label: str, icon: Any)

   Bases: :py:obj:`TabDefinitionMixin`, :py:obj:`enum.Enum`


   Definition of Digital LFO Section Tabs


   .. py:attribute:: RATE


   .. py:attribute:: DEPTHS


   .. py:attribute:: key


   .. py:attribute:: label


   .. py:attribute:: icon


.. py:class:: DigitalLFO

   Digital LFO


   .. py:attribute:: Shape
      :type:  jdxi_editor.midi.data.digital.lfo.DigitalLFOShape


   .. py:attribute:: Tab
      :type:  DigitalLFOTab


.. py:class:: DigitalFilterTab(key: str, label: str, icon: Any)

   Bases: :py:obj:`TabDefinitionMixin`, :py:obj:`enum.Enum`


   Definition of Digital Filter Section Tabs


   .. py:attribute:: CONTROLS


   .. py:attribute:: ADSR


   .. py:attribute:: key


   .. py:attribute:: label


   .. py:attribute:: icon


.. py:class:: DigitalAmpTab(key: str, label: str, icon: Any)

   Bases: :py:obj:`TabDefinitionMixin`, :py:obj:`enum.Enum`


   Definition of Digital Amp Section Tabs


   .. py:attribute:: CONTROLS


   .. py:attribute:: ADSR


   .. py:attribute:: key


   .. py:attribute:: label


   .. py:attribute:: icon


.. py:class:: DigitalOscillatorTab(key: str, label: str, icon: Any)

   Bases: :py:obj:`TabDefinitionMixin`, :py:obj:`enum.Enum`


   Definition of Digital Oscillator Section Tabs


   .. py:attribute:: TUNING


   .. py:attribute:: PULSE_WIDTH


   .. py:attribute:: PITCH


   .. py:attribute:: PCM


   .. py:attribute:: ADSR


   .. py:attribute:: key


   .. py:attribute:: label


   .. py:attribute:: icon


.. py:class:: DigitalGroupBox(key: str, label: str)

   Bases: :py:obj:`GroupBoxDefinitionMixin`, :py:obj:`enum.Enum`


   Definition of Digital Group Boxes


   .. py:attribute:: ENVELOPE
      :value: ('envelope', 'Envelope')



   .. py:attribute:: PULSE_WIDTH
      :value: ('pulse_width', 'Pulse Width')



   .. py:attribute:: PITCH_ENVELOPE
      :value: ('pitch_envelope', 'Pitch Envelope')



   .. py:attribute:: PCM_WAVE
      :value: ('pcm_wave', 'PCM Wave')



   .. py:attribute:: TUNING
      :value: ('tuning', 'Tuning')



   .. py:attribute:: CONTROLS
      :value: ('controls', 'Controls')



   .. py:attribute:: COMMON
      :value: ('common', 'Common')



   .. py:attribute:: key


   .. py:attribute:: label


.. py:class:: DigitalAmp

   Bases: :py:obj:`jdxi_editor.midi.data.parameter.base.spec.AmpSpec`


   Digital Amp


   .. py:attribute:: ADSR
      :type:  jdxi_editor.ui.adsr.type.ADSRType


   .. py:attribute:: Tab
      :type:  DigitalAmpTab


.. py:class:: DigitalFilter

   Bases: :py:obj:`jdxi_editor.midi.data.parameter.base.spec.FilterSpec`


   Digital Filter


   .. py:attribute:: Mode
      :type:  jdxi_editor.midi.data.digital.filter.DigitalFilterMode


   .. py:attribute:: ModeType
      :type:  jdxi_editor.midi.data.digital.filter.DigitalFilterModeType


   .. py:attribute:: FilterType
      :type:  jdxi_editor.midi.data.digital.filter.DigitalFilterType


   .. py:attribute:: ADSR
      :type:  jdxi_editor.ui.adsr.type.ADSRType


   .. py:attribute:: Tab
      :type:  DigitalFilterTab


.. py:class:: DigitalWave

   Bases: :py:obj:`jdxi_editor.midi.data.parameter.base.spec.WaveSpec`


   Digital Wave


   .. py:attribute:: LFO
      :type:  jdxi_editor.midi.data.digital.lfo.DigitalLFOShape


   .. py:attribute:: Osc
      :type:  jdxi_editor.midi.data.digital.DigitalWaveOsc


   .. py:attribute:: SubOsc
      :value: None



   .. py:attribute:: WaveType
      :type:  jdxi_editor.midi.data.digital.oscillator.WaveForm


   .. py:attribute:: Tab
      :type:  DigitalOscillatorTab


   .. py:attribute:: OscillatorTab
      :type:  DigitalOscillatorTab


.. py:class:: DigitalToneModifyDisplay

   Bases: :py:obj:`jdxi_editor.midi.data.parameter.base.spec.DisplaySpec`


   Digital Tone Modify Display names and options


   .. py:attribute:: Names
      :type:  jdxi_editor.midi.data.parameter.digital.tone_modify.DigitalModifyNames


   .. py:attribute:: Options
      :type:  jdxi_editor.midi.data.parameter.digital.tone_modify.DigitalModifyOptions


.. py:class:: DigitalDisplay

   Bases: :py:obj:`jdxi_editor.midi.data.parameter.base.spec.DisplaySpec`


   Digital Display class


   .. py:attribute:: Name
      :type:  jdxi_editor.midi.data.parameter.digital.name.DigitalDisplayName


   .. py:attribute:: Options
      :type:  jdxi_editor.midi.data.parameter.digital.option.DigitalDisplayOptions


   .. py:attribute:: Values
      :type:  jdxi_editor.midi.data.parameter.digital.values.DigitalDisplayValues


.. py:class:: JDXiMidiDigital

   Bases: :py:obj:`jdxi_editor.midi.data.parameter.base.spec.MidiSynthSpec`


   Digital Spec Class


   .. py:attribute:: Param
      :type:  jdxi_editor.midi.data.parameter.digital.DigitalPartialParam


   .. py:attribute:: Common
      :type:  jdxi_editor.midi.data.parameter.digital.DigitalCommonParam


   .. py:attribute:: Display
      :type:  DigitalDisplay


   .. py:attribute:: ModifyParam
      :type:  jdxi_editor.midi.data.parameter.digital.DigitalModifyParam


   .. py:attribute:: ModifyDisplay
      :type:  DigitalToneModifyDisplay


   .. py:attribute:: Wave
      :type:  DigitalWave


   .. py:attribute:: Filter
      :type:  DigitalFilter


   .. py:attribute:: LFO
      :type:  DigitalLFO


   .. py:attribute:: Amp
      :type:  DigitalAmp


   .. py:attribute:: Tab
      :type:  DigitalTab


   .. py:attribute:: GroupBox
      :type:  DigitalGroupBox