FCPlaybackPrefs Class Reference

Class for the document's playback preferences values. More...

#include <ff_prefs.h>

Inheritance diagram for FCPlaybackPrefs:

Public Types
enum	PLAYBACKSTARTMODE { PLAYBACKSTART_MEASURE = PLAYBACK_START_MODE_ALWAYS_AT , PLAYBACKSTART_LEFTMOST = PLAYBACK_START_MODE_LEFTMOST , PLAYBACKSTART_CURRENTCOUNTER = PLAYBACK_START_MODE_USE_COUNTER }
	The playback start modes. More...
enum	PLAYBACKEXPSMODE { PLAYBACKEXPS_CHASE_FROM_ONE = 0 , PLAYBACKEXPS_RESET = 1 , PLAYBACKEXPS_USECURRENT = 2 }
	The Dynamics and Markings playback modes. More...
enum	SMPTEFRAMERATE {   SMPTETIMETYPE_24 = SMPTE_TIME_TYPE_24 , SMPTETIMETYPE_25 = SMPTE_TIME_TYPE_25 , SMPTETIMETYPE_2997_DROP = SMPTE_TIME_TYPE_30_DROP , SMPTETIMETYPE_30 = SMPTE_TIME_TYPE_30 ,   SMPTETIMETYPE_2997_NONDROP = SMPTE_TIME_TYPE_2997 }
	The SMPTE Frame Rate types. More...
enum	METSOUNDSOURCE { METSOURCE_FINALECLICK = 0 , METSOURCE_MIDINOTE = 1 , METSOURCE_MIDIDATA = 2 }
	The Metronome Sound Source values. More...
Public Types inherited from __FCBase
enum	PDKFRAMEWORK_CLASSID {   FCID_UNKNOWN = 0 , FCID_ACCIDENTALMOD , FCID_ACTIVELYRIC , FCID_ALLOTMENT ,   FCID_ARTICULATION , FCID_ARTICULATIONDEF , FCID_BACKWARDREPEAT , FCID_BASELINE ,   FCID_BEAMMOD , FCID_BEATCHARTELEMENT , FCID_BOOKMARK , FCID_BROKENBEAMMOD ,   FCID_CATEGORYDEF , FCID_CELLCLEFCHANGE , FCID_CELLFRAMEHOLD , FCID_CELLGRAPHIC ,   FCID_CELLTEXT , FCID_CENTERSMARTSHAPE , FCID_CHORD , FCID_CHORDPREFS ,   FCID_CHORDSUFFIXELEMENT , FCID_CHORUSSYLLABLE , FCID_CLEFDEF , FCID_COMPOSITETIMESIGBOTTOMELEMENT ,   FCID_COMPOSITETIMESIGTOPELEMENT , FCID_CROSSSTAFFMOD , FCID_CUSTOMSMARTLINEDEF , FCID_CUSTOMSTEMMOD ,   FCID_DISTANCEPREFS , FCID_DOTMOD , FCID_ENCLOSURE , FCID_ENDINGREPEAT ,   FCID_ENIGMATEXTSTYLE , FCID_ENTRYALTERMOD , FCID_EXECUTABLESHAPEDEF , FCID_EXPRESSION ,   FCID_FONTINFO , FCID_FONTPREFS , FCID_FREEZESYSTEM , FCID_FRETBOARDSTYLEDEF ,   FCID_FRETBOARDSTYLEDEFS , FCID_FRETBOARDGROUPDEF , FCID_FRETBOARDGROUPDEFS , FCID_FRETINSTRUMENTDEF ,   FCID_GENERALPREFS , FCID_GRIDSGUIDESPREFS , FCID_GROUP , FCID_GROUPNAMEPOSITIONPREFS ,   FCID_HUMANPLAYBACKPREFS , FCID_INDEPENDENTCELLDETAIL , FCID_INSTRUMENTDEF , FCID_INSTRUMENTPLAYBACKDATA ,   FCID_KEYMODEDEF , FCID_KEYSIGNATURE , FCID_LAYERPREFS , FCID_LYRICSBASELINE ,   FCID_LYRICSPREFS , FCID_MEASURE , FCID_MEASURENUMBERREGION , FCID_METATOOLASSIGNMENT ,   FCID_MIDIEXPRESSION , FCID_MISCDOCPREFS , FCID_MULTIMEASUREREST , FCID_MULTIMEASURERESTPREFS ,   FCID_MULTISTAFFINSTRUMENT , FCID_MULTISTAFFINSTRUMENTS , FCID_MUSICCHARACTERPREFS , FCID_MUSICSPACINGPREFS ,   FCID_NUMBER , FCID_NOTEHEADMOD , FCID_OTHERINCI , FCID_PERCUSSIONLAYOUTNOTE ,   FCID_PERCUSSIONSTAFF , FCID_PERFORMANCEMOD , FCID_PAGE , FCID_PAGEFORMATPREFS ,   FCID_PAGEGRAPHIC , FCID_PAGETEXT , FCID_PART , FCID_PARTEXTRACTPREFS ,   FCID_PARTSCOPEPREFS , FCID_PARTSTAFFVOICING , FCID_PERCUSSIONNOTEMOD , FCID_PIANOBRACEPREFS ,   FCID_PLAYBACKPREFS , FCID_RAWTEXT , FCID_REPEATPREFS , FCID_SECONDARYBEAMBREAKMOD ,   FCID_BEAMEXTENSIONMOD , FCID_SECTIONSYLLABLE , FCID_SEPARATEMEASURENUMBER , FCID_SEPARATEPLACEMENT ,   FCID_SHAPEDEF , FCID_SHAPEEXPRESSIONDEF , FCID_SLURCONTOURPREFS , FCID_SIZEPREFS ,   FCID_SMARTSHAPE , FCID_SMARTSHAPEENTRYMARK , FCID_SMARTSHAPEMEASUREMARK , FCID_SMARTSHAPEPREFS ,   FCID_STAFF , FCID_STAFFLIST , FCID_STAFFNAMEPOSITION , FCID_STAFFNAMEPOSITIONPREFS ,   FCID_STAFFSTYLEASSIGN , FCID_STAFFSTYLEDEF , FCID_STAFFSYSTEM , FCID_STEMCONNECTIONTABLE ,   FCID_STEMMOD , FCID_STRING , FCID_SYLLABLEENTRYMOD , FCID_SYSTEMSTAFF ,   FCID_TABLATURENOTEMOD , FCID_TEMPOELEMENT , FCID_TEXTBLOCK , FCID_TEXTEXPRESSIONDEF ,   FCID_TEXTREPEAT , FCID_TEXTREPEATDEF , FCID_TIEMOD , FCID_TIEPREFS ,   FCID_TIECONTOURPREFS , FCID_TIEPLACEMENTPREFS , FCID_TIMESIGNATURE , FCID_TUPLET ,   FCID_TUPLETPREFS , FCID_VERSESYLLABLE }
	Constants for the GetClassID method. More...
enum	MEASUREMENTUNITS {   MEASUREMENTUNIT_DEFAULT = UNIT_DEFAULT , MEASUREMENTUNIT_EVPUS = UNIT_EVPUS , MEASUREMENTUNIT_INCHES = UNIT_INCHES , MEASUREMENTUNIT_CENTIMETERS = UNIT_CENTS ,   MEASUREMENTUNIT_POINTS = UNIT_POINTS , MEASUREMENTUNIT_PICAS = UNIT_PICAS , MEASUREMENTUNIT_SPACES = UNIT_SPACES , MEASUREMENTUNIT_MILLIMETERS = 100 }
	Constants for Finale's standard measurement units. More...

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.
const PDKFRAMEWORK_CLASSID	GetClassID () const override
	Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.
	FCPlaybackPrefs ()
	The constructor.
twobyte	GetBaseKeyVelocity () const
	Returns the base key velocity value.
TimeEdu32	GetMetronomeBeat () const
	Returns the metronome beat (in EDUs).
twobyte	GetMetronomeSpeed () const
	Returns the metronome speed number.
twobyte	GetSwing () const
	Returns the playback swing value.
eMeas	GetStartMeasure () const
	Returns the playback start measure, which is used if the start mode allows it.
TimeEdu32	GetStartMeasurePos () const
	Returns the playback start measure position, which is used if the start mode allows it.
int	GetStartRepeatPass () const
	Returns the playback start repeat pass number.
eMeas	GetStopMeasure () const
	Returns the playback stop measure.
TimeEdu32	GetStopMeasurePos () const
	Returns the playback stop measure position.
int	GetStopRepeatPass () const
	Returns the playback stop repeat pass number.
PLAYBACKSTARTMODE	GetStartMode () const
	Returns the start playback mode.
PLAYBACKEXPSMODE	GetExpressionsMode () const
	Returns the "Dynamics and Markings" setting in the "Playback/Record Options" dialog box.
bool	GetPlayNoteDurations () const
	Returns the state of the "Play Recorded: Note Durations" setting in the "Playback/Record Options" dialog box.
bool	GetPlayKeyVelocities () const
	Returns the state of the "Play Recorded: Key Velocities" setting in the "Playback/Record Options" dialog box.
bool	GetPlayContinuousData () const
	Returns the state of the "Play Recorded: Continuous Data" setting in the "Playback/Record Options" dialog box.
bool	GetPlayTempoChanges () const
	Returns the state of the "Play Recorded: Tempo Changes" setting in the "Playback/Record Options" dialog box.
bool	GetRepeatsIgnore () const
	Returns the state of the "Repeats: Ignore Repeats" setting in the "Playback/Record Options" dialog box.
bool	GetRepeatsReset () const
	Returns the state of the "Repeats: Reset Repeats" setting in the "Playback/Record Options" dialog box.
bool	GetSendPatchesToMidi () const
	Returns the state of the "Send patches to MIDI device on playback" setting in the "Playback/Record Options" dialog box.
bool	GetSyncReceiveMidi () const
	Returns the "Receive Sync" choice in the "Sync and Video Options" dialog box.
bool	GetSyncChasePatches () const
	Returns the "Chase Patch Changes During MIDI Sync" option in the "Sync and Video Options" dialog box.
bool	GetSyncChaseContinuousData () const
	Returns the "Chase Continuous Data During MIDI Sync" option in the "Sync and Video Options" dialog box.
SMPTEFRAMERATE	GetSMPTEFrameRate () const
	Returns the SMPTE Frame Rate option in the "Sync and Video Options" dialog box.
TimeRtu32	GetSMPTEStartTime () const
	Returns the SMPTE start time in the in the "Sync and Video Options" dialog box.
int	GetCountOffMeasures () const
	Returns the Countoff Measures in the "Click and Countoff" dialog box.
bool	GetCountOffWhenRecording () const
	Returns the Countoff status in the "Click and Countoff" dialog box.
bool	GetCountOffWhenPlaying () const
	Returns the Countoff status in the "Click and Countoff" dialog box.
bool	GetClickWhenRecording () const
	Returns the Click status in the "Click and Countoff" dialog box.
bool	GetClickWhenPlaying () const
	Returns the Click status in the "Click and Countoff" dialog box.
METSOUNDSOURCE	GetMetronomeSoundSource () const
	Returns the Metronome Sound Source in the "Click and Countoff" dialog box.
bool	GetScrollingPlayback () const
	Returns the state of the "Scrolling Playback" setting in the Playback Controls.
FCHyperClick *	GetClickInfoForMidiNotesOnDownBeats () const
	Returns the click info for MIDI Notes on Down Beats. ("Click and Countoff" dialog box.) Use the FCHyperClick::GetMidiData2 to get the velocity value for the Finale Internal sound source.
FCHyperClick *	GetClickInfoForMidiNotesOnOtherBeats () const
	Returns the click info for MIDI Notes on Other Beats. ("Click and Countoff" dialog box.) Use the FCHyperClick::GetMidiData2 to get the velocity value for the Finale Internal sound source.
FCHyperClick *	GetClickInfoForMidiDataOnDownBeats () const
	Returns the click info for MIDI Data on Down Beats. ("Click and Countoff" dialog box.)
FCHyperClick *	GetClickInfoForMidiDataOnOtherBeats () const
	Returns the click info for MIDI Data on Other Beats. ("Click and Countoff" dialog box.)
void	SetBaseKeyVelocity (twobyte value)
	Sets the base key velocity value.
void	SetMetronomeBeat (TimeEdu32 value)
	Sets the metronome beat (in EDUs, quarter note = 1024 EDUs).
void	SetMetronomeSpeed (twobyte value)
	Sets the metronome speed number.
void	SetSwing (twobyte value)
	Returns the playback swing value.
void	SetStartMeasure (eMeas measure)
	Sets the playback start measure, which is used if the start mode allows it.
void	SetStartMeasurePos (TimeEdu32 value)
	Sets the playback start measure position, which is used if the start mode allows it.
void	SetStopMeasure (eMeas measure)
	Sets the playback stop measure.
void	SetStopMeasurePos (TimeEdu32 value)
	Sets the playback stop measure position.
void	ConfigurePlaybackToEnd ()
	Configures playback to end of piece.
void	ConfigurePlaybackDocument ()
	Configures playback to all measures in the document.
void	ConfigurePlaybackRegion (const FCMusicRegion *pRegion, bool startOnly=false)
	Configures playback to the specified FCMusicRegion.
void	SetStartMode (PLAYBACKSTARTMODE mode)
	Sets the start playback mode.
void	SetExpressionsMode (PLAYBACKEXPSMODE mode)
	Sets the "Dynamics and Markings" setting in the "Playback/Record Options" dialog box.
void	SetPlayNoteDurations (bool state)
	Sets the state of the "Play Recorded: Note Durations" setting in the "Playback/Record Options" dialog box.
void	SetPlayKeyVelocities (bool state)
	Sets the state of the "Play Recorded: Key Velocities" setting in the "Playback/Record Options" dialog box.
void	SetPlayContinuousData (bool state)
	Sets the state of the "Play Recorded: Continuous Data" setting in the "Playback/Record Options" dialog box.
void	SetPlayTempoChanges (bool state)
	Sets the state of the "Play Recorded: Tempo Changes" setting in the "Playback/Record Options" dialog box.
void	SetRepeatsIgnore (bool state)
	Returns the state of the "Repeats: Ignore Repeats" setting in the "Playback/Record Options" dialog box.
void	SetRepeatsReset (bool state)
	Sets the state of the "Repeats: Reset Repeats" setting in the "Playback/Record Options" dialog box.
void	SetSendPatchesToMidi (bool state)
	Sets the state of the "Send patches to MIDI device on playback" setting in the "Playback/Record Options" dialog box.
void	SetSyncReceiveMidi (bool state)
	Sets the "Receive Sync" choice in the "Sync and Video Options" dialog box.
void	SetSyncChasePatches (bool state)
	Sets the "Chase Patch Changes During MIDI Sync" option in the "Sync and Video Options" dialog box.
void	SetSyncChaseContinuousData (bool state)
	Sets the "Chase Continuous Data During MIDI Sync" option in the "Sync and Video Options" dialog box.
void	SetSMPTEFrameRate (SMPTEFRAMERATE mode)
	Sets the SMPTE Frame Rate option in the "Sync and Video Options" dialog box.
void	SetSMPTEStartTime (TimeRtu32 value)
	Sets the SMPTE start time in the in the "Sync and Video Options" dialog box.
void	SetCountOffMeasures (int value)
	Sets the Countoff Measures in the "Click and Countoff" dialog box.
void	SetCountOffWhenRecording (bool state)
	Sets the Countoff status in the "Click and Countoff" dialog box.
void	SetCountOffWhenPlaying (bool state)
	Sets the Countoff status in the "Click and Countoff" dialog box.
void	SetClickWhenRecording (bool state)
	Sets the Click status in the "Click and Countoff" dialog box.
void	SetClickWhenPlaying (bool state)
	Sets the Click status in the "Click and Countoff" dialog box.
void	SetMetronomeSoundSource (METSOUNDSOURCE value)
	Sets the Metronome Sound Source in the "Click and Countoff" dialog box.
void	SetScrollingPlayback (bool state)
	Sets the state of the "Scrolling Playback" setting in the Playback Controls.
Public Member Functions inherited from __FCPrefsBase
bool	Reload () override
	Overridden version of Reload(), that handles prefs from multiple sources.
virtual bool	Load (twobyte prefsno=1)
	The default Load method for preference data. All preference data loading must go through here at some point.
bool	Save () override
	Saves the currently loaded to its current location.
bool	LoadFirst () override
	Loads the very first element in the database, if any.
int	GetItemNo () const
	Returns the prefs number for the loaded data.
Public Member Functions inherited from __FCBaseData
EDOCID	GetConnectedDocID () const
	Returns the document ID that was connected to the last load/save of the data.
bool	VerifyConnectedDocID ()
	Checks that the stored document ID for the data object matches the current document's ID.
virtual EVERSION	EnigmaVersion () const
	The Enigma version for save/load/create/delete operations.
virtual int	DataSizeSave () const
	Returns the data size for the data structure that should be saved or created.
void	_CloneFrom (__FCBaseData *pSource)
	For internal use only. Copies object data (except data block) from another object.
const EDataID *	_GetDataID ()
	Intended ONLY for the _CloneFrom implementation.
int	_GetLoadedSize () const
	Intended ONLY for the _CloneFrom implementation.
const void *	GetDataBlock ()
	Intended ONLY for the _CloneFrom implementation.
EXTAG	GetCustomTag () const
	Returns the custom Enigma tag, if any.
void	SetCustomTag (EXTAG tag)
	Sets the custom Enigma tag, for classes that support multiple Enigma tags.
	__FCBaseData ()
	The constructor.
virtual	~__FCBaseData ()
	Virtual destructor.
virtual bool	DeleteData ()
	Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
virtual bool	DeepDeleteData ()
	Deletes data and all data that's connected to the object.
virtual bool	LoadLast ()
	Loads the very last element in the database, if any.
virtual bool	LoadNext ()
	Loads the next element from the database, if any.
virtual bool	LoadPrevious ()
	Loads the previous element in the database, if any.
bool	RelinkToCurrentView ()
	Relinks the contents in the current view so that the score and part(s) match.
bool	RelinkToScore ()
	Relinks all parts to the contents of the score.
__FCBaseData *	CreateClone ()
	Creates an identical copy of an object.
void	DebugDump () override
	Outputs the class data/information for debugging purposes.
void	DebugDataDump () override
	Outputs a memory dump of the data block in the object for debugging purposes.
void	DebugDataByteArrayDump () override
	Outputs a memory dump of the data block in the object for debugging purposes, as a C++ byte array.
void	DebugDataOffsetDump (int offset, int size)
	For debug mode only. Dumps a data memory block at a specific offset and with a specific size.
FCNumbers *	CreateRawDataDump ()
	Creates a byte collection with the raw loaded data block for the object (if the object type supports single data blocks). This method is only intended for debug purposes.
Public Member Functions inherited from __FCBase
virtual	~__FCBase ()
	Virtual destructor, so all inherited classes get the virtual destructor.
void	DebugMsgInt (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
void	DebugMsgHex (const char *pszPrefixText, int i)
	Creates a simple Message Box for debug purposes. The text appears with the extra digit (as a hexadecimal number) appearing afterwards.
void	DebugMsgString (const char *pszPrefixText, const char *thestring)
	Creates a simple Message Box for debug purposes. The text appears with the extra string appearing afterwards.
void	DebugMsg (const char *pszMsg)
	Creates a simple Message Box for debug purposes with just one text string.
void	DebugOutMenuInfo (FCUI *pUI, int menuixd_horiz, int menuixd_vert) const
	Outputs the menu command info for debugging purposes.
int	DebugOutFormat (const char *fmt,...)
	Outputs debug text using C style "printf" syntax.
void	Set16BitFlag (FLAG_16 *flag, FLAG_16 flagbits, bool state)
	Sets a 16 bit flag.
void	Set32BitFlag (FLAG_32 *flag, FLAG_32 flagbits, bool state)
	Sets/resets a 32 bit flag, by using a bit mask.
bool	GetBitFlag (FLAG_32 flag, FLAG_32 flagbits) const
	Gets a state from flag bits. Returns true if any bit in the mask is set.
int	GetBitCount (FLAG_32 flag)
	Returns the total number of set bits in a 32-bit unsigned int.
void	SetSpecific32Bit (FLAG_32 *flag, int bitnumber, bool state)
	Sets/resets a single bit in a 32 bit flag, by specifying one specific bit.
void	SetUserData (void *pData)
	Sets the user data attached to the instance of an object.
void	SetUserData2 (void *pData)
	Sets the additional user data attached to the instance of an object.
void *	GetUserData () const
	Gets the user data attached to the instance of an object.
void *	GetUserData2 () const
	Gets the additional user data attached to the instance of an object.
virtual bool	IsIdentical (const __FCBase *pCompareObject) const
	Returns true if the data in the passed object is considered to be identical to the current object, otherwise false.
void	StoreXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file.
void	StoreXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int value)
	Helper function to store integer objects in the XML file.
void	StoreXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool value)
	Helper function to store boolean objects in the XML file.
void	StoreXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper function to store FCString objects in the XML file, as an attribute to a node.
void	StoreXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int value)
	Helper function to store integer objects in the XML file, as an attribute to a node.
void	StoreXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool value)
	Helper function to store boolean objects in the XML file, as an attribute to a node.
void	StoreXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float value)
	Helper function to store floating point objects in the XML file, as an attribute to a node.
virtual void	StoreToXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to store an object's data.
bool	ReadXML_String (tinyxml2::XMLElement *pParentNode, const char *pszElementName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file.
bool	ReadXML_Integer (tinyxml2::XMLElement *pParentNode, const char *pszElementName, int *pValue)
	Helper method to read integer objects from the XML file.
bool	ReadXML_Bool (tinyxml2::XMLElement *pParentNode, const char *pszElementName, bool *pValue)
	Helper method to read boolean objects from the XML file.
bool	ReadXML_StringAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, FCString *pStringValue)
	Helper method to read FCString objects from the XML file, as an attribute to a node.
bool	ReadXML_IntegerAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, int *pValue)
	Helper method to read integer objects from the XML file, as an attribute to a node.
bool	ReadXML_BoolAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, bool *pValue)
	Helper method to read boolean objects from the XML file, as an attribute to a node.
bool	ReadXML_FloatAttribute (tinyxml2::XMLElement *pNode, const char *pszAttributeName, float *pValue)
	Helper method to read floating point objects from the XML file, as an attribute to a node.
virtual bool	ReadFromXML (tinyxml2::XMLElement *pParentNode)
	Virtual method that is used to read object data.

Additional Inherited Members
Static Public Member Functions inherited from __FCBase
static void	DebugOutPtr (const char *pszPrefixText, void *ptr)
	Static method that outputs a line for debugging purposes. The prefix text appears with the extra ptr (in hexadeximal representation) appearing afterwards.
static void	DebugOutInt (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in decimal presentation) appearing afterwards.
static void	DebugOutFloat (const char *pszPrefixText, double f)
	Static method that outputs a line for debugging purposes. The text appears with the extra float value appearing afterwards.
static void	DebugOutTag (const char *pszPrefixText, EXTAG extag)
	Static method that outputs a line for debugging purposes. The text appears with the EXTAG (in text) appearing afterwards.
static void	DebugOutHex (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in hexadecimal presentation) appearing afterwards.
static void	DebugOutBin (const char *pszPrefixText, int i)
	Static method that outputs a line for debugging purposes. The text appears with the extra digit (in binary presentation) appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, const char *thestring)
	Static method that outputs a line for debugging purposes (C string version). The text appears with the extra string appearing afterwards.
static void	DebugOutString (const char *pszPrefixText, FCString *pString)
	Static method that outputs a line for debugging purposes (FCString version). The text appears with the extra string appearing afterwards.
static void	DebugOutBool (const char *pszPrefixText, bool state)
	Static method that outputs a line for debugging purposes. The boolean state appears afterwards as either "TRUE" or "FALSE".
static void	DebugOutBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) until the whole memory block is dumped.
static void	DebugOutByteArrayBlock (const void *pBuffer, int startoffset, int size)
	Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (as hex digits) as a C++ onebyte array, until the whole memory block is dumped.
static void	DebugOut (const char *pszLine)
	Static method to output a line of text for debugging purposes.
Protected Member Functions inherited from __FCPrefsBase
	__FCPrefsBase ()
	standard constructor
Protected Member Functions inherited from __FCBaseData
virtual void	Deallocate ()
virtual bool	IsDynamicSize ()
bool	LoadDataBlock ()
	Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocated.
void	ClearData ()
virtual twobyte	CalcLastInci ()
	For internal use only!
bool	DataIsLoaded () const
	Returns true is any data has been loaded into the object.
void	_TagDocumentID ()
	For internal use only.
Protected Member Functions inherited from __FCBase
	__FCBase ()
	The constructor.
Protected Attributes inherited from __FCBaseData
EDOCID	_connecteddocID
	The "connected" document ID., which is the document the where the document was loaded (or last saved). This is for a mechanism to prevent resaving of certain data in other documents.
void *	_datablock
	Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
bool	_heapdatablock
	Variable that tells if _datablock is dynamically created on the heap (and should be deleted at object destruction).
int	_loadedsize
	Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-specific, the _loadedsize should be updated by child classes that create new data.
EDataID	_dataid
	The EdataID for the last loaded/saved object.

Detailed Description

Class for the document's playback preferences values.

Member Enumeration Documentation

METSOUNDSOURCE

enum FCPlaybackPrefs::METSOUNDSOURCE

The Metronome Sound Source values.

Enumerator
METSOURCE_FINALECLICK	Finale Click
METSOURCE_MIDINOTE	MIDI Note
METSOURCE_MIDIDATA	MIDI Data

PLAYBACKEXPSMODE

enum FCPlaybackPrefs::PLAYBACKEXPSMODE

The Dynamics and Markings playback modes.

Enumerator
PLAYBACKEXPS_CHASE_FROM_ONE	Chase from Measure 1.
PLAYBACKEXPS_RESET	Rest.
PLAYBACKEXPS_USECURRENT	Use Current Settings.

PLAYBACKSTARTMODE

enum FCPlaybackPrefs::PLAYBACKSTARTMODE

The playback start modes.

Enumerator
PLAYBACKSTART_MEASURE	Use the start measure setting.
PLAYBACKSTART_LEFTMOST	Use leftmost measure.
PLAYBACKSTART_CURRENTCOUNTER	Use current counter. (WIndows only.)

SMPTEFRAMERATE

enum FCPlaybackPrefs::SMPTEFRAMERATE

The SMPTE Frame Rate types.

Enumerator
SMPTETIMETYPE_24	24
SMPTETIMETYPE_25	25
SMPTETIMETYPE_2997_DROP	29.97 Drop
SMPTETIMETYPE_30	30
SMPTETIMETYPE_2997_NONDROP	29.97 Non-Drop

Constructor & Destructor Documentation

FCPlaybackPrefs()

FCPlaybackPrefs::FCPlaybackPrefs ( )

inline

The constructor.

Lua-supported.

Member Function Documentation

ClassName()

const char * FCPlaybackPrefs::ClassName ( ) const

inlineoverridevirtual

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

Lua-supported.

Reimplemented from __FCPrefsBase.

ConfigurePlaybackDocument()

void FCPlaybackPrefs::ConfigurePlaybackDocument ( )

inline

Configures playback to all measures in the document.

This is a utility function that makes the necessary changes so that the entire document plays back. However, see the warning at SetStartMeasure for versions of Finale before 26.2.

Lua-supported (0.68).

ConfigurePlaybackRegion()

void FCPlaybackPrefs::ConfigurePlaybackRegion ( const FCMusicRegion * pRegion, bool startOnly = false )

inline

Configures playback to the specified FCMusicRegion.

This is a utility function that makes the necessary changes so that playback matches the measure span of the input region. If the region is empty, playback is set to the whole document. This allows for finenv.Region() to be passed in without any checks, and if it is empty, playback is reset.

See the warning at SetStartMeasure for versions of Finale before 26.2.

Lua-supported (0.68).

Parameters

pRegion	the region to play back
startOnly	(optional) if true, only set up playback start and leave the playback end configuration alone

ConfigurePlaybackToEnd()

void FCPlaybackPrefs::ConfigurePlaybackToEnd ( )

inline

Configures playback to end of piece.

This is a utility function that makes the necessary changes so that playback always plays to the end of the piece, regardles of how many measures there are. It also modifies the Playback Controls to select the "End of Piece" radio button. However, see the warning at SetStartMeasure for versions of Finale before 26.2.

Lua-supported (0.68).

GetBaseKeyVelocity()

twobyte FCPlaybackPrefs::GetBaseKeyVelocity ( ) const

inline

Returns the base key velocity value.

Lua-supported (also as property).

GetClassID()

const PDKFRAMEWORK_CLASSID FCPlaybackPrefs::GetClassID ( ) const

inlineoverridevirtual

Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has problems to resolve the true classes of inherited objects.

This method must be overwritten by all child classes.

Lua-supported (also read-only property) (0.55).

Implements __FCBaseData.

GetClickInfoForMidiDataOnDownBeats()

FCHyperClick * FCPlaybackPrefs::GetClickInfoForMidiDataOnDownBeats ( ) const

inline

Returns the click info for MIDI Data on Down Beats. ("Click and Countoff" dialog box.)

To save changes to this value, save the parent instance of FCPlaybackPrefs. Do not reference this value after the parent instance goes out of scope. It could cause Finale to crash.

Lua-supported (also as read-only property) (0.68)

GetClickInfoForMidiDataOnOtherBeats()

FCHyperClick * FCPlaybackPrefs::GetClickInfoForMidiDataOnOtherBeats ( ) const

inline

Returns the click info for MIDI Data on Other Beats. ("Click and Countoff" dialog box.)

To save changes to this value, save the parent instance of FCPlaybackPrefs. Do not reference this value after the parent instance goes out of scope. It could cause Finale to crash.

Lua-supported (also as read-only property) (0.68)

GetClickInfoForMidiNotesOnDownBeats()

FCHyperClick * FCPlaybackPrefs::GetClickInfoForMidiNotesOnDownBeats ( ) const

inline

Returns the click info for MIDI Notes on Down Beats. ("Click and Countoff" dialog box.) Use the FCHyperClick::GetMidiData2 to get the velocity value for the Finale Internal sound source.

To save changes to this value, save the parent instance of FCPlaybackPrefs. Do not reference this value after the parent instance goes out of scope. It could cause Finale to crash.

Lua-supported (also as read-only property) (0.68)

GetClickInfoForMidiNotesOnOtherBeats()

FCHyperClick * FCPlaybackPrefs::GetClickInfoForMidiNotesOnOtherBeats ( ) const

inline

Returns the click info for MIDI Notes on Other Beats. ("Click and Countoff" dialog box.) Use the FCHyperClick::GetMidiData2 to get the velocity value for the Finale Internal sound source.

To save changes to this value, save the parent instance of FCPlaybackPrefs. Do not reference this value after the parent instance goes out of scope. It could cause Finale to crash.

Lua-supported (also as read-only property) (0.68)

GetClickWhenPlaying()

bool FCPlaybackPrefs::GetClickWhenPlaying ( ) const

inline

Returns the Click status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Returns

true for the pulldown options "While Playing" and "Always"; otherwise false.

GetClickWhenRecording()

bool FCPlaybackPrefs::GetClickWhenRecording ( ) const

inline

Returns the Click status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Returns

true for the pulldown options "While Recording" and "Always"; otherwise false.

GetCountOffMeasures()

int FCPlaybackPrefs::GetCountOffMeasures ( ) const

inline

Returns the Countoff Measures in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

GetCountOffWhenPlaying()

bool FCPlaybackPrefs::GetCountOffWhenPlaying ( ) const

inline

Returns the Countoff status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Returns

true for the pulldown options "While Playing" and "Always"; otherwise false.

GetCountOffWhenRecording()

bool FCPlaybackPrefs::GetCountOffWhenRecording ( ) const

inline

Returns the Countoff status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Returns

true for the pulldown options "While Recording" and "Always"; otherwise false.

GetExpressionsMode()

PLAYBACKEXPSMODE FCPlaybackPrefs::GetExpressionsMode ( ) const

inline

Returns the "Dynamics and Markings" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68).

Returns

Any of the PLAYBACKEXPS_ constants.

GetMetronomeBeat()

TimeEdu32 FCPlaybackPrefs::GetMetronomeBeat ( ) const

inline

Returns the metronome beat (in EDUs).

Lua-supported (also as property).

GetMetronomeSoundSource()

METSOUNDSOURCE FCPlaybackPrefs::GetMetronomeSoundSource ( ) const

inline

Returns the Metronome Sound Source in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68).

Returns

Any of the METSOURCE_ constants.

GetMetronomeSpeed()

twobyte FCPlaybackPrefs::GetMetronomeSpeed ( ) const

inline

Returns the metronome speed number.

Lua-supported (also as property).

GetPlayContinuousData()

bool FCPlaybackPrefs::GetPlayContinuousData ( ) const

inline

Returns the state of the "Play Recorded: Continuous Data" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

GetPlayKeyVelocities()

bool FCPlaybackPrefs::GetPlayKeyVelocities ( ) const

inline

Returns the state of the "Play Recorded: Key Velocities" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

GetPlayNoteDurations()

bool FCPlaybackPrefs::GetPlayNoteDurations ( ) const

inline

Returns the state of the "Play Recorded: Note Durations" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

GetPlayTempoChanges()

bool FCPlaybackPrefs::GetPlayTempoChanges ( ) const

inline

Returns the state of the "Play Recorded: Tempo Changes" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

GetRepeatsIgnore()

bool FCPlaybackPrefs::GetRepeatsIgnore ( ) const

inline

Returns the state of the "Repeats: Ignore Repeats" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

GetRepeatsReset()

bool FCPlaybackPrefs::GetRepeatsReset ( ) const

inline

Returns the state of the "Repeats: Reset Repeats" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

GetScrollingPlayback()

bool FCPlaybackPrefs::GetScrollingPlayback ( ) const

inline

Returns the state of the "Scrolling Playback" setting in the Playback Controls.

Lua-supported (also as property) (0.68)

GetSendPatchesToMidi()

bool FCPlaybackPrefs::GetSendPatchesToMidi ( ) const

inline

Returns the state of the "Send patches to MIDI device on playback" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

GetSMPTEFrameRate()

SMPTEFRAMERATE FCPlaybackPrefs::GetSMPTEFrameRate ( ) const

inline

Returns the SMPTE Frame Rate option in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68).

Returns

Any of the SMPTETIMETYPE_ constants.

GetSMPTEStartTime()

TimeRtu32 FCPlaybackPrefs::GetSMPTEStartTime ( ) const

inline

Returns the SMPTE start time in the in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

Returns

start time in milliseconds.

GetStartMeasure()

eMeas FCPlaybackPrefs::GetStartMeasure ( ) const

inline

Returns the playback start measure, which is used if the start mode allows it.

Lua-supported (also as property).

GetStartMeasurePos()

TimeEdu32 FCPlaybackPrefs::GetStartMeasurePos ( ) const

inline

Returns the playback start measure position, which is used if the start mode allows it.

Lua-supported (also as property) (0.68).

GetStartMode()

PLAYBACKSTARTMODE FCPlaybackPrefs::GetStartMode ( ) const

inline

Returns the start playback mode.

Lua-supported (also as property).

Returns

Any of the PLAYBACKSTART_ constants.

GetStartRepeatPass()

int FCPlaybackPrefs::GetStartRepeatPass ( ) const

inline

Returns the playback start repeat pass number.

Finale does not allow plugins to modify this value.

Lua-supported (also as read-only property) (0.68).

GetStopMeasure()

eMeas FCPlaybackPrefs::GetStopMeasure ( ) const

inline

Returns the playback stop measure.

If GetStopMeasurePos is zero, playback stops at the end of this measure. Otherwise, it stops when GetStopMeasurePos is reached.

Lua-supported (also as property).

GetStopMeasurePos()

TimeEdu32 FCPlaybackPrefs::GetStopMeasurePos ( ) const

inline

Returns the playback stop measure position.

Lua-supported (also as property) (0.68).

GetStopRepeatPass()

int FCPlaybackPrefs::GetStopRepeatPass ( ) const

inline

Returns the playback stop repeat pass number.

Finale does not allow plugins to modify this value.

Lua-supported (also as read-only property) (0.68).

GetSwing()

twobyte FCPlaybackPrefs::GetSwing ( ) const

inline

Returns the playback swing value.

Lua-supported (also as property).

Returns

return_value = swing_value_for_display * 1024 / 100

GetSyncChaseContinuousData()

bool FCPlaybackPrefs::GetSyncChaseContinuousData ( ) const

inline

Returns the "Chase Continuous Data During MIDI Sync" option in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

GetSyncChasePatches()

bool FCPlaybackPrefs::GetSyncChasePatches ( ) const

inline

Returns the "Chase Patch Changes During MIDI Sync" option in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

GetSyncReceiveMidi()

bool FCPlaybackPrefs::GetSyncReceiveMidi ( ) const

inline

Returns the "Receive Sync" choice in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

Returns

true = receive MIDI sync; false = receive internal sync

SetBaseKeyVelocity()

void FCPlaybackPrefs::SetBaseKeyVelocity ( twobyte value )

inline

Sets the base key velocity value.

Lua-supported (also as property).

SetClickWhenPlaying()

void FCPlaybackPrefs::SetClickWhenPlaying ( bool state )

inline

Sets the Click status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Parameters

state

true for the pulldown options "While Playing" and "Always"; otherwise false.

SetClickWhenRecording()

void FCPlaybackPrefs::SetClickWhenRecording ( bool state )

inline

Sets the Click status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Parameters

state

true for the pulldown options "While Recording" and "Always"; otherwise false.

SetCountOffMeasures()

void FCPlaybackPrefs::SetCountOffMeasures ( int value )

inline

Sets the Countoff Measures in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

SetCountOffWhenPlaying()

void FCPlaybackPrefs::SetCountOffWhenPlaying ( bool state )

inline

Sets the Countoff status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Parameters

state

true for the pulldown options "While Playing" and "Always"; otherwise false.

SetCountOffWhenRecording()

void FCPlaybackPrefs::SetCountOffWhenRecording ( bool state )

inline

Sets the Countoff status in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68)

Parameters

state

true for the pulldown options "While Recording" and "Always"; otherwise false.

SetExpressionsMode()

void FCPlaybackPrefs::SetExpressionsMode ( PLAYBACKEXPSMODE mode )

inline

Sets the "Dynamics and Markings" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68).

Parameters

mode	Any of the PLAYBACKEXPS_ constants.

SetMetronomeBeat()

void FCPlaybackPrefs::SetMetronomeBeat ( TimeEdu32 value )

inline

Sets the metronome beat (in EDUs, quarter note = 1024 EDUs).

Setting this value does NOT update the value visually in the playback control.

Lua-supported (also as property).

SetMetronomeSoundSource()

void FCPlaybackPrefs::SetMetronomeSoundSource ( METSOUNDSOURCE value )

inline

Sets the Metronome Sound Source in the "Click and Countoff" dialog box.

Lua-supported (also as property) (0.68).

Parameters

value

Any of the METSOURCE_ constants.

SetMetronomeSpeed()

void FCPlaybackPrefs::SetMetronomeSpeed ( twobyte value )

inline

Sets the metronome speed number.

Setting this value does NOT update the value visually in the playback control.

Lua-supported (also as property).

SetPlayContinuousData()

void FCPlaybackPrefs::SetPlayContinuousData ( bool state )

inline

Sets the state of the "Play Recorded: Continuous Data" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

SetPlayKeyVelocities()

void FCPlaybackPrefs::SetPlayKeyVelocities ( bool state )

inline

Sets the state of the "Play Recorded: Key Velocities" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

SetPlayNoteDurations()

void FCPlaybackPrefs::SetPlayNoteDurations ( bool state )

inline

Sets the state of the "Play Recorded: Note Durations" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

SetPlayTempoChanges()

void FCPlaybackPrefs::SetPlayTempoChanges ( bool state )

inline

Sets the state of the "Play Recorded: Tempo Changes" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

SetRepeatsIgnore()

void FCPlaybackPrefs::SetRepeatsIgnore ( bool state )

inline

Returns the state of the "Repeats: Ignore Repeats" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

SetRepeatsReset()

void FCPlaybackPrefs::SetRepeatsReset ( bool state )

inline

Sets the state of the "Repeats: Reset Repeats" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

SetScrollingPlayback()

void FCPlaybackPrefs::SetScrollingPlayback ( bool state )

inline

Sets the state of the "Scrolling Playback" setting in the Playback Controls.

When the Playback Controls are open, Finale 26.3 and higher update the "Scrolling Playback" option immediately after the plugin runs. However, some earlier versions (especially Finale 25 and earlier) may not update the window. The change has been made, but you do not see the change reflected on screen until you close and reopen the Playback Controls or until you start and then stop playback.

Lua-supported (also as property) (0.68)

SetSendPatchesToMidi()

void FCPlaybackPrefs::SetSendPatchesToMidi ( bool state )

inline

Sets the state of the "Send patches to MIDI device on playback" setting in the "Playback/Record Options" dialog box.

Lua-supported (also as property) (0.68)

SetSMPTEFrameRate()

void FCPlaybackPrefs::SetSMPTEFrameRate ( SMPTEFRAMERATE mode )

inline

Sets the SMPTE Frame Rate option in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68).

Parameters

mode	Any of the SMPTETIMETYPE_ constants.

SetSMPTEStartTime()

void FCPlaybackPrefs::SetSMPTEStartTime ( TimeRtu32 value )

inline

Sets the SMPTE start time in the in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

Parameters

value

start time in milliseconds.

SetStartMeasure()

void FCPlaybackPrefs::SetStartMeasure ( eMeas measure )

inline

Sets the playback start measure, which is used if the start mode allows it.

Warning

The Playback Controls window in versions of Finale before Finale 26.2 overwrite this value with whatever value is currently in the window. If you want the new value to stick, the Playback Controls window must be closed when the plugin runs. Starting with Finale 26.2, the Playback Controls window automatically updates after the plugin runs, so the problem is fixed for 26.2+.

Lua-supported (also as property).

SetStartMeasurePos()

void FCPlaybackPrefs::SetStartMeasurePos ( TimeEdu32 value )

inline

Sets the playback start measure position, which is used if the start mode allows it.

Warning

See warning at SetStartMeasure.

Lua-supported (also as property) (0.68).

SetStartMode()

void FCPlaybackPrefs::SetStartMode ( PLAYBACKSTARTMODE mode )

inline

Sets the start playback mode.

Lua-supported (also as property).

Parameters

mode	Any of the PLAYBACKSTART_ constants.

SetStopMeasure()

void FCPlaybackPrefs::SetStopMeasure ( eMeas measure )

inline

Sets the playback stop measure.

If GetStopMeasurePos is zero, playback stops at the end of this measure. Otherwise, it stops when GetStopMeasurePos is reached.

Warning

See warning at SetStartMeasure.

Lua-supported (also as property).

SetStopMeasurePos()

void FCPlaybackPrefs::SetStopMeasurePos ( TimeEdu32 value )

inline

Sets the playback stop measure position.

Warning

See warning at SetStartMeasure.

Lua-supported (also as property) (0.68).

SetSwing()

void FCPlaybackPrefs::SetSwing ( twobyte value )

inline

Returns the playback swing value.

Lua-supported (also as property).

Parameters

value

(value = swing_value_for_display * 1024 / 100)

SetSyncChaseContinuousData()

void FCPlaybackPrefs::SetSyncChaseContinuousData ( bool state )

inline

Sets the "Chase Continuous Data During MIDI Sync" option in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

SetSyncChasePatches()

void FCPlaybackPrefs::SetSyncChasePatches ( bool state )

inline

Sets the "Chase Patch Changes During MIDI Sync" option in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

SetSyncReceiveMidi()

void FCPlaybackPrefs::SetSyncReceiveMidi ( bool state )

inline

Sets the "Receive Sync" choice in the "Sync and Video Options" dialog box.

Lua-supported (also as property) (0.68)

Parameters

state

true = receive MIDI sync; false = receive internal sync