FCListenToMidiResult Class Reference

Class to return the results of the ListenToMidi dialog box. More...

#include <ff_playback.h>

Inheritance diagram for FCListenToMidiResult:

Public Member Functions
const char *	ClassName () const override
	Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class. More...
	FCListenToMidiResult ()=default
	The constructor. More...
eMidiChannel	GetMidiChannel () const
	Returns the midi channel. More...
void	SetMidiChannel (eMidiChannel value)
	Sets the midi channel. More...
int	GetStatus () const
	Returns the MIDI message status code. More...
void	SetStatus (int value)
	Sets the MIDI message status code. More...
int	GetData1 () const
	Returns data byte 1 (counting from 1). More...
void	SetData1 (int value)
	Sets data byte 1 (counting from 1). More...
int	GetData2 () const
	Returns data byte 2 (counting from 1). More...
void	SetData2 (int value)
	Sets data byte 2 (counting from 1). More...

Friends
bool	FCUI::DisplayListenToMidiDialog (FCListenToMidiResult *result)

Detailed Description

Class to return the results of the ListenToMidi dialog box.

For details on MIDI messages, see the 1.0 MIDI standard document at https://www.midi.org/

If you are listening for a Note On event, the values are:

• status: 0x9n (where n is the MIDI channel 0..f) identifies it as Note On
• data1: the MIDI note number (C4 == 60)
• data2: the key velocity (0..127)

Lua-supported (0.68)

Constructor & Destructor Documentation

FCListenToMidiResult()

FCListenToMidiResult::FCListenToMidiResult ( )

default

The constructor.

Lua-supported (0.68).

Member Function Documentation

ClassName()

const char * FCListenToMidiResult::ClassName ( ) const

inlineoverridevirtual

Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child class.

Lua-supported.

Implements __FCBase.

GetData1()

int FCListenToMidiResult::GetData1 ( ) const

inline

Returns data byte 1 (counting from 1).

Lua-supported (also as property) (0.68)

GetData2()

int FCListenToMidiResult::GetData2 ( ) const

inline

Returns data byte 2 (counting from 1).

Lua-supported (also as property) (0.68)

GetMidiChannel()

eMidiChannel FCListenToMidiResult::GetMidiChannel ( ) const

inline

Returns the midi channel.

This is the strict MIDI channel (0..15).

Lua-supported (also as property) (0.68)

GetStatus()

int FCListenToMidiResult::GetStatus ( ) const

inline

Returns the MIDI message status code.

For channel messages, the low-order nybble is the same as GetMidiChannel.

Lua-supported (also as property) (0.68)

SetData1()

void FCListenToMidiResult::SetData1 ( int  value )

inline

Sets data byte 1 (counting from 1).

Lua-supported (also as property) (0.68)

SetData2()

void FCListenToMidiResult::SetData2 ( int  value )

inline

Sets data byte 2 (counting from 1).

Lua-supported (also as property) (0.68)

SetMidiChannel()

void FCListenToMidiResult::SetMidiChannel ( eMidiChannel  value )

inline

Sets the midi channel.

This is the strict MIDI channel (0..15).

Lua-supported (also as property) (0.68)

SetStatus()

void FCListenToMidiResult::SetStatus ( int  value )

inline

Sets the MIDI message status code.

For channel messages, the low-order nybble is the same as GetMidiChannel.

Lua-supported (also as property) (0.68)