Skip to content

Commit

Permalink
VDiskIn.schelp: formatting & capitalization
Browse files Browse the repository at this point in the history
  • Loading branch information
mossheim committed Feb 11, 2017
1 parent 5ec4926 commit 5c564e0
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion HelpSource/Classes/VDiskIn.schelp
Expand Up @@ -29,7 +29,10 @@ argument:: loop
If loop is set to 1, the soundfile will loop.

argument:: sendID
If a sendID is given, the UGen sends an osc message with this id and the frame index emphasis::relative to the onset of the Synth:: each time it reloads the buffer: code::['/diskin', nodeID, sendID, frame]::. The true frame index into the file is determined by the code::startFrame:: given when reading the initial buffer's worth of data (using link::Classes/Buffer#-cueSoundFile:: or link::Classes/Buffer#-read::). VDiskIn does not have access to the frame index used to cue the buffer. So, the frame index sent by OSC begins with 0 at the start of the synth node. The user is responsible for adding the cue point: code::cueStartFrame + msg[3]::.
If a sendID is given, the UGen sends an OSC message with this ID and the frame index emphasis::relative to the onset of the Synth:: each time it reloads the buffer: code::['/diskin', nodeID, sendID, frame]::.
The true frame index into the file is determined by the code::startFrame:: given when reading the initial buffer's worth of data, using link::Classes/Buffer#-cueSoundFile:: or link::Classes/Buffer#-read::.
VDiskIn does not have access to the frame index used to cue the buffer. So, the frame index sent by OSC is always 0 at the start of the synth node.
The user is responsible for adding the cue point: code::cueStartFrame + msg[3]::.

discussion::
This UGen will set the link::Classes/Done##'done' flag:: when finished playing.
Expand Down

0 comments on commit 5c564e0

Please sign in to comment.