FCHyperClick Class Reference

Class for Hyperscript click data. It corresponds to the data fields associated with the Metronome Source in the "Click and Countoff" dialog box. More...

#include <ff_playback.h>

Inheritance diagram for FCHyperClick:

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...
int	GetVirtualChannel () const
	Returns the Finale virtual MIDI channel. More...
void	SetVirtualChannel (int value)
	Sets the Finale virtual MIDI channel. More...
int	GetDuration () const
	Returns the hyper click duration in milliseconds. (The Finale UI shows a percentage. This is the percentage of a second, so the value returned is 10x the percentage value.) More...
void	SetDuration (int value)
	Sets the hyper click duration in milliseconds. (The Finale UI shows a percentage. This is the percentage of a second, so the value to pass in is 10x the percentage value.) More...
int	GetMidiStatus () const
	Returns the status byte value of the Click On MIDI message. More...
void	SetMidiStatus (int value)
	Sets the status byte value of the MIDI message. More...
int	GetMidiData1 () const
	Returns the data 1 (counting from 1) byte value of the Click On MIDI message. More...
void	SetMidiData1 (int value)
	Sets the data 1 (counting from 1) byte value of the Click On MIDI message. More...
int	GetMidiData2 () const
	Returns the data 2 (counting from 1) byte value of the Click On MIDI message. More...
void	SetMidiData2 (int value)
	Sets the data 2 (counting from 1) byte value of the Click On MIDI message. More...

Friends
class	FCPlaybackPrefs

Detailed Description

Class for Hyperscript click data. It corresponds to the data fields associated with the Metronome Source in the "Click and Countoff" dialog box.

This class exists to provide Lua access to the members of EDTHyperClick. It wraps around a pointer to a EDTHyperClick member variable and cannot be constructed independently. To update its contents, save the class instance from which you got it.

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

Lua-supported (0.68)

Member Function Documentation

ClassName()

const char * FCHyperClick::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.

GetDuration()

int FCHyperClick::GetDuration ( ) const

inline

Returns the hyper click duration in milliseconds. (The Finale UI shows a percentage. This is the percentage of a second, so the value returned is 10x the percentage value.)

Lua-supported (also as property) (0.68)

GetMidiData1()

int FCHyperClick::GetMidiData1 ( ) const

inline

Returns the data 1 (counting from 1) byte value of the Click On MIDI message.

When the Metronome Source is MIDI Note, this is the MIDI Note number.

Lua-supported (also as property) (0.68)

GetMidiData2()

int FCHyperClick::GetMidiData2 ( ) const

inline

Returns the data 2 (counting from 1) byte value of the Click On MIDI message.

When the Metronome Source is MIDI Note, use this value for the MIDI key velocity..

Lua-supported (also as property) (0.68)

GetMidiStatus()

int FCHyperClick::GetMidiStatus ( ) const

inline

Returns the status byte value of the Click On MIDI message.

This value is only meaningful for the MIDI Data metronome source.

Lua-supported (also as property) (0.68)

GetVirtualChannel()

int FCHyperClick::GetVirtualChannel ( ) const

inline

Returns the Finale virtual MIDI channel.

Lua-supported (also as property) (0.68)

Returns

Finale virtual channel number (0-127).

SetDuration()

void FCHyperClick::SetDuration ( int  value )

inline

Sets the hyper click duration in milliseconds. (The Finale UI shows a percentage. This is the percentage of a second, so the value to pass in is 10x the percentage value.)

Lua-supported (also as property) (0.68)

SetMidiData1()

void FCHyperClick::SetMidiData1 ( int  value )

inline

Sets the data 1 (counting from 1) byte value of the Click On MIDI message.

When the Metronome Source is MIDI Note, this is the MIDI Note number.

Lua-supported (also as property) (0.68)

SetMidiData2()

void FCHyperClick::SetMidiData2 ( int  value )

inline

Sets the data 2 (counting from 1) byte value of the Click On MIDI message.

When the Metronome Source is MIDI Note, use this value for the MIDI key velocity.

Lua-supported (also as property) (0.68)

SetMidiStatus()

void FCHyperClick::SetMidiStatus ( int  value )

inline

Sets the status byte value of the MIDI message.

This is used for MIDI Data metronome sources. MIDI Note and Finale Internal sources should leave it as 0x90. Even if you change it, the value is not updated in the document, and it reverts to 0x90 the next time you load the prefs.

Lua-supported (also as property) (0.68)

SetVirtualChannel()

void FCHyperClick::SetVirtualChannel ( int  value )

inline

Sets the Finale virtual MIDI channel.

Lua-supported (also as property) (0.68)

Parameters

value

Finale virtual channel number (0-127).