SSSyControls

Extends Protocol:
NSObject
Declared In:

Introduction

interface to UI synthesizer controls



Methods

-loopEndIndex

play loop support

-loopRepeats

play loop support

-loopRepeats (optional method)

play loop support

-loopStartIndex

play loop support

-metronomeEnabled

is the metronome enabled?

-metronomeInstrument

get the metronome instrument id

-metronomeVolume

get the metronome volume

-partEnabled:

is the part enabled for play?

-partInstrument:

get the instrument id

-partStaffEnabled:staff:

is the staff enabled for play in the part?

-partVolume:

get the part volume


loopEndIndex


play loop support

@optional

-(int)loopEndIndex;
Return Value

the bar index of the last bar in the play loop

Discussion

optional method


loopRepeats


play loop support

@optional

-(int)loopRepeats;

See Also


loopRepeats (optional method)


play loop support

@optional

-(int)loopRepeats;
Return Value

the number of repeats of the play loop. 0 to disable looping

See Also


loopStartIndex


play loop support

@optional

-(int)loopStartIndex;
Return Value

the bar index of the first bar in the play loop

Discussion

optional method


metronomeEnabled


is the metronome enabled?

-(bool)metronomeEnabled; 
Return Value

true if the metronome (virtual) part should be played


metronomeInstrument


get the metronome instrument id

-(unsigned)metronomeInstrument; 
Return Value

the id of the metronome instrument


metronomeVolume


get the metronome volume

-(float)metronomeVolume; 
Return Value

the relative volume of the metrnonome part [0.0 .. 1.0]


partEnabled:


is the part enabled for play?

-(bool)partEnabled:(int)partIndex; 
Return Value

true if the part is enabled for playing


partInstrument:


get the instrument id

-(unsigned)partInstrument:(int)partIndex; 
Return Value

the instrument id


partStaffEnabled:staff:


is the staff enabled for play in the part?

@optional

-(bool)partStaffEnabled:(int)partIndex staff:(int)staffIndex;
Return Value

true if the staff is enabled for playing in the part

Discussion

optional method


partVolume:


get the part volume

-(float)partVolume:(int)partIndex; 
Return Value

the relative volume of the part [0.0 .. 1.0]