OpenShot Audio Library | OpenShotAudio: juce::MPEZoneLayout Class Reference

OpenShot Audio Library | OpenShotAudio 0.3.1

Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
juce::MPEZoneLayout Class Reference

`#include <juce_MPEZoneLayout.h>`

## Classes
class | Listener
struct | Zone

## Public Member Functions
| MPEZoneLayout () noexcept
| MPEZoneLayout (const MPEZoneLayout &other)
MPEZoneLayout & | operator= (const MPEZoneLayout &other)
void | setLowerZone (int numMemberChannels=0, int perNotePitchbendRange=48, int masterPitchbendRange=2) noexcept
void | setUpperZone (int numMemberChannels=0, int perNotePitchbendRange=48, int masterPitchbendRange=2) noexcept
const Zone | getLowerZone () const noexcept
const Zone | getUpperZone () const noexcept
void | clearAllZones ()
void | processNextMidiEvent (const MidiMessage &message)
void | processNextMidiBuffer (const MidiBuffer &buffer)
void | addListener (Listener *const listenerToAdd) noexcept
void | removeListener (Listener *const listenerToRemove) noexcept

## Detailed Description

This class represents the current MPE zone layout of a device capable of handling MPE.

An MPE device can have up to two zones: a lower zone with master channel 1 and allocated MIDI channels increasing from channel 2, and an upper zone with master channel 16 and allocated MIDI channels decreasing from channel 15. MPE mode is enabled on a device when one of these zones is active and disabled when both are inactive.

Use the MPEMessages helper class to convert the zone layout represented by this object to MIDI message sequences that you can send to an Expressive MIDI device to set its zone layout, add zones etc.

See also
  MPEInstrument

Definition at line 44 of file juce_MPEZoneLayout.h.

## Constructor & Destructor Documentation

## ◆ MPEZoneLayout() [1/2]

juce::MPEZoneLayout::MPEZoneLayout | ( |  | ) |
| noexcept

Default constructor.

This will create a layout with inactive lower and upper zones, representing a device with MPE mode disabled.

You can set the lower or upper MPE zones using the setZone() method.

See also
  setZone

Definition at line 26 of file juce_MPEZoneLayout.cpp.

## ◆ MPEZoneLayout() [2/2]

juce::MPEZoneLayout::MPEZoneLayout | ( | const MPEZoneLayout & | other | ) |

Copy constuctor. This will not copy the listeners registered to the MPEZoneLayout.

Definition at line 28 of file juce_MPEZoneLayout.cpp.

## Member Function Documentation

## ◆ addListener()

void juce::MPEZoneLayout::addListener | ( | Listener *const | listenerToAdd | ) |
| noexcept

Adds a listener.

Definition at line 181 of file juce_MPEZoneLayout.cpp.

## ◆ clearAllZones()

void juce::MPEZoneLayout::clearAllZones | ( |  | ) |

Clears the lower and upper zones of this layout, making them both inactive and disabling MPE mode.

Definition at line 87 of file juce_MPEZoneLayout.cpp.

Referenced by juce::MPEInstrument::enableLegacyMode().

## ◆ getLowerZone()

const Zone juce::MPEZoneLayout::getLowerZone | ( |  | ) | const
| inlinenoexcept

Returns a struct representing the lower MPE zone.

Definition at line 142 of file juce_MPEZoneLayout.h.

Referenced by juce::MPEMessages::setZoneLayout().

## ◆ getUpperZone()

const Zone juce::MPEZoneLayout::getUpperZone | ( |  | ) | const
| inlinenoexcept

Returns a struct representing the upper MPE zone.

Definition at line 145 of file juce_MPEZoneLayout.h.

Referenced by juce::MPEMessages::setZoneLayout().

## ◆ operator=()

MPEZoneLayout & juce::MPEZoneLayout::operator= | ( | const MPEZoneLayout & | other | ) |

Copy assignment operator. This will not copy the listeners registered to the MPEZoneLayout.

Definition at line 34 of file juce_MPEZoneLayout.cpp.

## ◆ processNextMidiBuffer()

void juce::MPEZoneLayout::processNextMidiBuffer | ( | const MidiBuffer & | buffer | ) |

Pass incoming MIDI buffers to an object of this class if you want the zone layout to properly react to MPE RPN messages like an MPE device.

MPEMessages::rpnNumber will add or remove zones; RPN 0 will set the per-note or master pitchbend ranges.

Any other MIDI messages will be ignored by this class.

See also
  MPEMessages

Definition at line 170 of file juce_MPEZoneLayout.cpp.

## ◆ processNextMidiEvent()

void juce::MPEZoneLayout::processNextMidiEvent | ( | const MidiMessage & | message | ) |

Pass incoming MIDI messages to an object of this class if you want the zone layout to properly react to MPE RPN messages like an MPE device.

MPEMessages::rpnNumber will add or remove zones; RPN 0 will set the per-note or master pitchbend ranges.

Any other MIDI messages will be ignored by this class.

See also
  MPEMessages

Definition at line 96 of file juce_MPEZoneLayout.cpp.

Referenced by processNextMidiBuffer(), and juce::MPEInstrument::processNextMidiEvent().

## ◆ removeListener()

void juce::MPEZoneLayout::removeListener | ( | Listener *const | listenerToRemove | ) |
| noexcept

Removes a listener.

Definition at line 186 of file juce_MPEZoneLayout.cpp.

## ◆ setLowerZone()

void juce::MPEZoneLayout::setLowerZone | ( | int | numMemberChannels = `0`,
|  | int | perNotePitchbendRange = `48`,
|  | int | masterPitchbendRange = `2`
| ) |  |
| noexcept

Sets the lower zone of this layout.

Definition at line 77 of file juce_MPEZoneLayout.cpp.

Referenced by juce::MPESynthesiser::MPESynthesiser().

## ◆ setUpperZone()

void juce::MPEZoneLayout::setUpperZone | ( | int | numMemberChannels = `0`,
|  | int | perNotePitchbendRange = `48`,
|  | int | masterPitchbendRange = `2`
| ) |  |
| noexcept

Sets the upper zone of this layout.

Definition at line 82 of file juce_MPEZoneLayout.cpp.

The documentation for this class was generated from the following files:

- juce_MPEZoneLayout.h
- juce_MPEZoneLayout.cpp