|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--quicktime.QTObject
|
+--quicktime.std.comp.ComponentIdentifier
|
+--quicktime.std.comp.Component
|
+--quicktime.std.music.TunePlayer
Corresponds to the TunePlayer component type.
| Fields inherited from interface quicktime.jdirect.QuickTimeLib |
JDirect_MacOSX, libraryInstance, name |
| Constructor Summary | |
TunePlayer()
Opens the TunePlayer component. |
|
| Method Summary | |
static TunePlayer |
fromMusicMediaHandler(MusicMediaHandler mh,
int index)
Returns the TunePlayer that is responsible for rendering the music data that is contained within a particular music track. |
NoteChannel |
getIndexedNoteChannel(int index)
Returns the note channel at the specified index. |
NoteAllocator |
getNoteAllocator()
Returns the NoteAllocator that the tune player is using. |
int |
getNumberOfNoteChannels()
Returns the number of note channels that the tune player is using. |
MixStateInfo |
getPartMix(int partNumber)
Returns the current state of a part in a mix, its volume, balance, and mute/solo state. |
TuneStatus |
getStatus()
Returns an initialised structure describing the state of the tune player. |
TimeBase |
getTimeBase()
Returns the TunePlayer's current time Base. |
int |
getTimeScale()
Returns the current time scale of the tune player, in units-per-second. |
float |
getVolume()
Returns the volume of the sequence. |
void |
instant(TuneStatus tune,
int tunePosition)
Play the sequence of music events at a specified position. |
void |
preroll()
Prepares the tune player by attempting to reserve note channels for each part in the sequence. |
void |
queue(MusicData tune,
float tuneRate,
int tuneStartPosition,
int tuneStopPosition,
int queueFlags)
Places a sequence of music events into a queue to be played. |
void |
setBalance(int balance)
Modifies the pan controller setting for a tune player. |
void |
setHeader(MusicData header)
Prepares the tune player to accept subsequent music event sequences by defining one or more parts to be used by sequence Note events. |
void |
setHeaderWithSize(MusicData header,
int size)
Prepares the tune player to accept subsequence music events by defining one or more parts to be used. |
void |
setNoteChannels(NoteChannel[] noteChannelList)
Prepares the tune player to accept music event sequences by allocating specified note channels for them. |
void |
setPartMix(int partNumber,
float volume,
float balance,
int mixFlags)
Alters the volume and the balance of the specified part, with the flags specifying special conditions. |
void |
setPartTranspose(int part,
float transpose,
int velocityShift)
Modifies the pitch and velocity of every note of the specified part of a tune. |
void |
setSofter(boolean softer)
Adjusts the volume to play at a generally softer value that was the normal value for QT 2_1, otherwise sets the volume to a normal level. |
void |
setSoundLocalization(SoundLocalization data)
Passes sound localisation data to the tune player. |
void |
setTimeScale(int scale)
Sets the time scale used by the tune player. |
void |
setVolume(float volume)
Sets the volume for the entire sequence. |
void |
stop()
Stops a currently playing sequence. |
void |
task()
Call this method periodically to allow the tune player to perform tasks it must perform at foreground task time. |
void |
unroll()
Releases any note channels that may have been allocated by previous calls to preroll. |
| Methods inherited from class quicktime.std.comp.Component |
count |
| Methods inherited from class quicktime.std.comp.ComponentIdentifier |
find, find, getInfo, toString |
| Methods inherited from class quicktime.QTObject |
disposeQTObject, equals, ID |
| Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public TunePlayer()
throws QTException
| Method Detail |
public static TunePlayer fromMusicMediaHandler(MusicMediaHandler mh,
int index)
throws StdQTException
index - the index within the media.MusicMediaHandler.getIndexedTunePlayer(int)
public void setHeader(MusicData header)
throws StdQTException
header - the tune header data
public TimeBase getTimeBase()
throws StdQTException
public void setTimeScale(int scale)
throws StdQTException
scale - the new scale
public int getTimeScale()
throws StdQTException
public int getNumberOfNoteChannels()
throws StdQTException
public NoteChannel getIndexedNoteChannel(int index)
throws StdQTException
index - the part for which you want the note channel
public void queue(MusicData tune,
float tuneRate,
int tuneStartPosition,
int tuneStopPosition,
int queueFlags)
throws StdQTException
tune - the events to be playedtuneRate - the playback rate at which to play the eventstuneStartPosition - sequence starting timetuneStopPosition - sequence ending timequeue - flags with details about how to play the queued tune events.
public void instant(TuneStatus tune,
int tunePosition)
throws StdQTException
tune - the tune data is contained within the TuneStatus objecttunePosition - the position within tune sequence data in time units
public TuneStatus getStatus()
throws StdQTException
public void stop()
throws StdQTException
public void setVolume(float volume)
throws StdQTException
volume - the new volume
public float getVolume()
throws StdQTException
public void preroll()
throws StdQTException
public void unroll()
throws StdQTException
public void setNoteChannels(NoteChannel[] noteChannelList)
throws StdQTException
noteChannelList - the note channels to be set for the tune player
public void setPartTranspose(int part,
float transpose,
int velocityShift)
throws StdQTException
part - the part number for which you want the pitch and velocity changedtranspose - the value by which to modify the pitch of the note - can specify fractional tuningvelocityShift - a value to add to the velocity of each note playedpublic NoteAllocator getNoteAllocator()
public void setSofter(boolean softer)
throws StdQTException
softer - if true it sets the overall volume to a softer level, if false sets it to normal
public void task()
throws StdQTException
public void setBalance(int balance)
throws StdQTException
balance - the new balance setting: range is -128 (left) to 127 (right)
public void setSoundLocalization(SoundLocalization data)
throws StdQTException
data - the sound localisation data
public void setHeaderWithSize(MusicData header,
int size)
throws StdQTException
header - a list of general eventssize - the size of the header in bytes
public void setPartMix(int partNumber,
float volume,
float balance,
int mixFlags)
throws StdQTException
partNumber - the part to effectvolume - the new volume of the specified partbalance - the new balance of the specified partmixFlags - the mix flags that will apply to that part - mute or solo part.
public MixStateInfo getPartMix(int partNumber)
throws StdQTException
partNumber - the part number you require information about
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||