→ index of namespace default
 
→ index of project tkportaudio
 
→ index of module tkportaudio

Class tkportaudio.PaStream

Synopsis: 

  Base classes:
  Methods:
Method abort
Signature
abort()

 
→ top of page
Method close
Close stream and free resources.
Signature
close()

 
→ top of page
Method getCpuLoad
Signature
getCpuLoad():float
Returns
float–

 
→ top of page
Method getInputLatency
Signature
getInputLatency():float
Returns
float–

 
→ top of page
Method getNumInputChannels
Signature
getNumInputChannels():int
Returns
int–

 
→ top of page
Method getNumOutputChannels
Signature
getNumOutputChannels():int
Returns
int–

 
→ top of page
Method getOutputLatency
Signature
getOutputLatency():float
Returns
float–

 
→ top of page
Method getSampleRate
Signature
getSampleRate():float
Returns
float–

 
→ top of page
Method isActive
Signature
isActive():boolean
Returns
boolean–

 
→ top of page
Method isStopped
Signature
isStopped():boolean
Returns
boolean–

 
→ top of page
Method macOSAudioWorkgroupJoin
Called from worker thread (when entered)
Signature
macOSAudioWorkgroupJoin():PaStreamMacOSWorkgroupJoinToken
Returns
PaStreamMacOSWorkgroupJoinToken–
Description
Returns (deletable) joinToken that has to be passed to macOSAudioWorkgroupLeave() at end of worker thread

 
→ top of page
Method macOSAudioWorkgroupLeave
Called from worker thread (at exit)
Signature
macOSAudioWorkgroupLeave(PaStreamMacOSWorkgroupJoinTokenjoinToken)
Arguments
PaStreamMacOSWorkgroupJoinTokenjoinToken–

 
→ top of page
Method start
Start audio I/O
Signature
start()

 
→ top of page
Method stop
Stop audio I/O
Signature
stop()

 
→ top of page
 
Project Modules:tkportaudio 
Project Classes:PaDeviceInfo , PaHostApiInfo , PaStream , PaStream , PaStreamParameters , PortAudio 
Project Functions:
All Namespaces:default , graph , ui 
All Projects:core , eqxmms , ShaderVG , ShaderVG_Text , tkanalogrytm , tkchipmunk , tkclap , tkfileutils , tkfreeglut , tkfreetype2 , tkfreeverb , tkmath , tkmidi , tkmidipipe , tkminnie , tkoldmath , tkopengl , tkportaudio , tkradiastools , tksamplechain , tksampleedit , tksampler , tksdl , tksdl_net , tksidplay2 , tkspeexdsp , tksqlite , tktriangulate , tkui , tkvst2 , tkzip , ui , yingtest 

auto-generated by "DOG", the TkScript document generator. Thu, 11/Dec/2025 13:42:00