→ home

→ index of namespace default

→ index of project tkmidi

→ index of module tkmidi

Class `tkmidi.MIDIOut`

Synopsis: Represents a MIDI output device

Base classes:

core.Object

Methods:

allNotesOff(byte midiCh) - Send all-notes-off MIDI message
bankSelect(byte midiCh, bank) - Send bank-select MIDI message
close() - Close MIDI device
getDeviceIdx() : int - Return device index.
getDeviceName() : String - Return name of currently opened MIDI device
GetDeviceNameByIdx(int devIdx) : String - Query MIDI device name by index (pseudo-static method)
GetDeviceTypeByIdx(int ) : int - Query MIDI device caps (pseudo-static method)
GetNumDevices() : int - Query number of available MIDI output device (pseudo-static method)
noteOff(byte midiCh, note, vel) - Send note-off MIDI message
noteOn(byte midiCh, note, vel) - Send note-on MIDI message
openByIdx(int devIdx) : boolean - Open MIDI device by index
openByName(String devName) : boolean - Open MIDI device by name
programChange(byte midiCh, prog) - Send program-select MIDI message
sendBuffer(Buffer b) : boolean - Send buffer (regular or system exclusive data)

Constants:

int MOD_FMSYNTH -
int MOD_MAPPER -
int MOD_MIDIPORT -
int MOD_SQSYNTH -
int MOD_SWSYNTH -
int MOD_SYNTH -
int MOD_WAVETABLE -

Method allNotesOff

Send all-notes-off MIDI message

Signature

allNotesOff

(

byte

midiCh

)

Arguments

byte

midiCh

–

MIDI channel (0..15)

→ top of page

Method bankSelect

Send bank-select MIDI message

Signature

bankSelect	(	byte	midiCh	,
		byte	bank
		)

Arguments

byte	midiCh	–	MIDI channel (0..15)
byte	bank	–	Bank (0..127)

→ top of page

Method close

Close MIDI device

Signature

(

)

→ top of page

Method getDeviceIdx

Return device index.

Signature

getDeviceIdx

(

)

int

Returns

int

–

Description

This can be used for finding the matching input device for an output device.

→ top of page

Method getDeviceName

Return name of currently opened MIDI device

Signature

getDeviceName

(

)

String

Returns

String

–

MIDI device name

→ top of page

Method GetDeviceNameByIdx

Query MIDI device name by index (pseudo-static method)

Signature

GetDeviceNameByIdx	(	int	devIdx	)
	:	String

Arguments

int

devIdx

–

MIDI output device index (0..GetNumDevices())

Returns

String

–

MIDI device name

→ top of page

Method GetDeviceTypeByIdx

Query MIDI device caps (pseudo-static method)

Signature

GetDeviceTypeByIdx	(	int		)
	:	int

Arguments

int

–

Returns

int – Device capabilities/type. One of MOD_MIDIPORT, MOD_SYNTH, MOD_SQSYNTH, MOD_FMSYNTH, MOD_MAPPER, MOD_WAVETABLE, MOD_SWSYNTH. -1 if this call is not supported.

Description

The returned value should be considered merely a "hint": Not all audio drivers may support this.

→ top of page

Method GetNumDevices

Query number of available MIDI output device (pseudo-static method)

Signature

GetNumDevices

(

)

int

Returns

int

–

Number of available MIDI output devices

→ top of page

Method noteOff

Send note-off MIDI message

Signature

noteOff	(	byte	midiCh	,
		byte	note	,
		byte	vel
		)

Arguments

byte	midiCh	–	MIDI channel (0..15)
byte	note	–	MIDI note (0..127)
byte	vel	–	Note-off velocity (0..127)

→ top of page

Method noteOn

Send note-on MIDI message

Signature

noteOn	(	byte	midiCh	,
		byte	note	,
		byte	vel
		)

Arguments

byte	midiCh	–	MIDI channel (0..15)
byte	note	–	MIDI note (0..127)
byte	vel	–	Note-on velocity (0..127)

→ top of page

Method openByIdx

Open MIDI device by index

Signature

openByIdx	(	int	devIdx	)
	:	boolean

Arguments

int

devIdx

–

Device index

Returns

boolean

–

true(1) if the device has been opened, false(0) if an error occurred

→ top of page

Method openByName

Open MIDI device by name

Signature

openByName	(	String	devName	)
	:	boolean

Arguments

String

devName

–

Device name (platform dependent)

Returns

boolean

–

true(1) if the device has been opened, false(0) if an error occured

→ top of page

Method programChange

Send program-select MIDI message

Signature

programChange	(	byte	midiCh	,
		byte	prog
		)

Arguments

byte	midiCh	–	MIDI channel (0..15)
byte	prog	–	Program (0..127)

→ top of page

Method sendBuffer

Send buffer (regular or system exclusive data)

Signature

sendBuffer	(	Buffer	b	)
	:	boolean

Arguments

Buffer

–

Buffer that holds the MIDI data to be send. The "offset" field is used to determine how many bytes to send.

Returns

boolean

–

true(1) if the data has been sent, false(0) otherwise

Description

This method can also be used to send a series of regular MIDI commands.

→ top of page

Constant `MOD_FMSYNTH (int)`

Constant `MOD_MAPPER (int)`

Constant `MOD_MIDIPORT (int)`

Constant `MOD_SQSYNTH (int)`

Constant `MOD_SWSYNTH (int)`

Constant `MOD_SYNTH (int)`

Constant `MOD_WAVETABLE (int)`

Project Modules:	`tkmidi`
Project Classes:	`MIDIIn` , `MIDIOut` , `MIDITimer` , `RecordedMIDIEvent`
Project Functions:
All Namespaces:	`default` , `ui`
All Projects:	`core` , `debugtext` , `tkfreetype2` , `tkmath` , `tkmidi` , `tkopengl` , `tkportaudio` , `tksdl` , `tkui` , `tkunit`

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54

Class tkmidi.MIDIOut

Class `tkmidi.MIDIOut`