Squeak Class Documentation category index | class index  
 
SoundPlugin
  category: VMConstruction-Plugins
  superclass: TestInterpreterPlugin
  subclasses:

Implements the main sound related primiives.

NB: I really think it would be a good cleanup to mildly rewrite the sq{plat}Sound.c files to NOT refer directly back to the VM -- TPR.

instance methods
  initialize-release
  initialiseModule
shutdownModule

  primitives
  primitiveSoundAvailableSpace
primitiveSoundGetRecordingSampleRate
primitiveSoundGetVolume
primitiveSoundInsertSamples:from:leadTime:
primitiveSoundPlaySamples:from:startingAt:
primitiveSoundPlaySilence
primitiveSoundRecordSamplesInto:startingAt:
primitiveSoundSetLeftVolume:rightVolume:
primitiveSoundSetRecordLevel:
primitiveSoundStartBufferSize:rate:stereo:
primitiveSoundStartBufferSize:rate:stereo:semaIndex:
primitiveSoundStartRecordingDesiredSampleRate:stereo:semaIndex:
primitiveSoundStop
primitiveSoundStopRecording

class methods
  translation
  headerFile

instance methods
  initialize-release top  
 

initialiseModule


 

shutdownModule


  primitives top  
 

primitiveSoundAvailableSpace

Returns the number of sample frames of available sound output buffer space.


 

primitiveSoundGetRecordingSampleRate

Return a float representing the actual sampling rate during recording. Fail if not currently recording.


 

primitiveSoundGetVolume

Set the sound input recording level.


 

primitiveSoundInsertSamples:from:leadTime:

Insert a buffer's worth of sound samples into the currently playing
buffer. Used to make a sound start playing as quickly as possible. The
new sound is mixed with the previously buffered sampled.


 

primitiveSoundPlaySamples:from:startingAt:

Output a buffer's worth of sound samples.


 

primitiveSoundPlaySilence

Output a buffer's worth of silence. Returns the number of sample frames played.


 

primitiveSoundRecordSamplesInto:startingAt:

Record a buffer's worth of 16-bit sound samples.


 

primitiveSoundSetLeftVolume:rightVolume:

Set the sound input recording level.


 

primitiveSoundSetRecordLevel:

Set the sound input recording level.


 

primitiveSoundStartBufferSize:rate:stereo:

Start the double-buffered sound output with the given buffer size, sample rate, and stereo flag.


 

primitiveSoundStartBufferSize:rate:stereo:semaIndex:

Start the double-buffered sound output with the given buffer size, sample rate, stereo flag, and semaphore index.


 

primitiveSoundStartRecordingDesiredSampleRate:stereo:semaIndex:

Start recording sound with the given parameters.


 

primitiveSoundStop

Stop double-buffered sound output.


 

primitiveSoundStopRecording

Stop recording sound.


class methods
  translation top  
 

headerFile

If there is a single intrinsic header file to be associated with the plugin, here is where you want to put it. It will be generated and included automatically.