jdxi_editor.midi.data.parameter.program.common

Defines the ProgramCommonParameter class for managing common program-level parameters in the JD-Xi synthesizer.

This class provides attributes and methods for handling program-wide settings, such as program name, level, tempo, and vocal effects. It also includes methods for retrieving digital values, validating parameter values, and handling partial-specific addressing.

Example usage:

# Create an instance for Program Level program_level = ProgramCommonParameter(*ProgramCommonParameter.PROGRAM_LEVEL)

# Validate a value within range validated_value = program_level.validate_value(100)

# Get the digital name of a parameter display_name = program_level.display_name # “Program Level”

# Get digital value range display_range = program_level.get_display_value() # (0, 127)

# Retrieve a parameter by name param = ProgramCommonParameter.get_by_name(“PROGRAM_TEMPO”) if param:

print(param.name, param.min_val, param.max_val)

# Get switch text representation switch_text = program_level.get_switch_text(1) # “ON” or “—”

Classes

SystemCommonParam	Program Common parameters
ProgramCommonParam	Program Common parameters

Module Contents

class jdxi_editor.midi.data.parameter.program.common.SystemCommonParam(address: int, min_val: int | None = None, max_val: int | None = None, display_min: int | None = None, display_max: int | None = None, tooltip: str | None = None, display_name: str | None = None, options: list | None = None, values: list | None = None)

Bases: picomidi.sysex.parameter.address.AddressParameter

Program Common parameters

display_min

display_max

tooltip

_display_name = None

options = None

values = None

MASTER_TUNE

MASTER_KEY_SHIFT

MASTER_LEVEL

get_display_value() → Tuple[int, int]

Get the digital value range (min, max) for the parameter

property display_name: str

Get digital name for the parameter (from ParameterSpec or fallback).

get_address_for_partial(partial_number: int = 0) → Tuple[int, int]

Get parameter area and address adjusted for partial number.

Parameters:

partial_number – int The partial number

Returns:

Tuple[int, int] The address

property is_switch: bool

Returns True if parameter is address binary/enum switch

get_switch_text(value: int) → str

Get digital text for switch values :param value: int The value :return: str The digital text

validate_value(value: int) → int

Validate and convert parameter value :param value: int The value :return: int The validated value

get_partial_number() → int | None

Returns the partial number (1-3) if this is address partial parameter, None otherwise

static get_by_name(param_name: str) → object | None

Get the Parameter by name. :param param_name: str The parameter name :return: Optional[object] The parameter Return the parameter member by name, or None if not found

class jdxi_editor.midi.data.parameter.program.common.ProgramCommonParam(address: int, min_val: int | None = None, max_val: int | None = None, display_min: int | None = None, display_max: int | None = None, tooltip: str | None = None, display_name: str | None = None)

Bases: picomidi.sysex.parameter.address.AddressParameter

Program Common parameters

display_min

display_max

tooltip

_display_name = None

TONE_NAME_1

TONE_NAME_2

TONE_NAME_3

TONE_NAME_4

TONE_NAME_5

TONE_NAME_6

TONE_NAME_7

TONE_NAME_8

TONE_NAME_9

TONE_NAME_10

TONE_NAME_11

TONE_NAME_12

PROGRAM_LEVEL

PROGRAM_TEMPO

VOCAL_EFFECT

VOCAL_EFFECT_NUMBER

VOCAL_EFFECT_PART

AUTO_NOTE_SWITCH

get_display_value() → Tuple[int, int]

Get the digital value range (min, max) for the parameter

property display_name: str

Get digital name for the parameter (from ParameterSpec or fallback).

get_address_for_partial(partial_number: int = 0) → Tuple[int, int]

Get parameter area and address adjusted for partial number.

Parameters:

partial_number – int The partial number

Returns:

Tuple[int, int] The address

property is_switch: bool

Returns True if parameter is address binary/enum switch

get_switch_text(value: int) → str

Get digital text for switch values :param value: int The value :return: str The digital text

validate_value(value: int) → int

Validate and convert parameter value :param value: int The value :return: int The validated value

get_partial_number() → int | None

Returns the partial number (1-3) if this is address partial parameter, None otherwise

static get_by_name(param_name: str) → object | None

Get the Parameter by name. :param param_name: str The parameter name :return: Optional[object] The parameter Return the parameter member by name, or None if not found