home
 
 index of namespace default
 
 index of project tksdl
 
 index of module tksdl

Class tksdl.AudioSample


Synopsis

  Base classes:
  Methods:
Method allocBuffer
Allocate new audio buffer
Signature
allocBuffer(intl,
  floatf,
  intch,
  intsw 
  )  
 :boolean
Arguments
intlNumber of samples
floatfFrequency (Hz). Does not affect the buffer size.
intchNumber of interleaved channels
intswNumber of waves (usually 1..)
Returns
booleanTrue if buffer was allocated. False if not

 
 top of page
Method convertChannels
Convert sample to given number of channels
Signature
convertChannels(intch)
Arguments
intch

 
 top of page
Method copyBufferFrom
Copy audio sample data from other sample
Signature
copyBufferFrom(AudioSampleo)
Arguments

 
 top of page
Method freeBuffer
Free memory occupied by sample data
Signature
freeBuffer()

 
 top of page
Method getBaseFrequency
Query sample base frequency
Signature
getBaseFrequency():float
Returns
float

 
 top of page
Method getChannels
Query number of channels
Signature
getChannels():int
Returns
int

 
 top of page
Method getFrequency
Query sample frequency
Signature
getFrequency():float
Returns
float

 
 top of page
Method getLength
Query sample length
Signature
getLength():int
Returns
int

 
 top of page
Method getOffset
Query sample offset
Signature
getOffset():int
Returns
int

 
 top of page
Method getRepeatLength
Query sample repeat length
Signature
getRepeatLength():int
Returns
int

 
 top of page
Method getRepeatOffset
Get sample repeat offset
Signature
getRepeatOffset():int
Returns
int

 
 top of page
Method loadAIFF
Load AIFF sample from pak file
Signature
loadAIFF(Stringname)
 :boolean
Arguments
Stringname
Returns
boolean

 
 top of page
Method loadLocalAIFF
Load AIFF sample from local file
Signature
loadLocalAIFF(Stringname)
 :boolean
Arguments
Stringname
Returns
boolean

 
 top of page
Method normalize
Normalize sample data
Signature
normalize()

 
 top of page
Method setBaseFrequency
Set sample base frequency
Signature
setBaseFrequency(floatf)
Arguments
floatf

 
 top of page
Method setFrequency
Set sample frequency
Signature
setFrequency(floatf)
Arguments
floatf

 
 top of page
Method setLength
Set sample length
Signature
setLength(intlen)
Arguments
intlen

 
 top of page
Method setOffset
Set sample offset
Signature
setOffset(intoff)
Arguments
intoff

 
 top of page
Method setRepeatLength
Set sample repeat length
Signature
setRepeatLength(intlen)
Arguments
intlen

 
 top of page
Method setRepeatOffset
Query sample repeat offset
Signature
setRepeatOffset(intoff)
Arguments
intoff

 
 top of page
Method visitBuffer
Share sample data with other sample
Signature
visitBuffer(AudioSampleo)
Arguments

 
 top of page
 

Project Modules:tksdl 
Project Classes:AudioDevice , AudioSample , Cursor , FPS , Joystick , Key , Mouse , SamplePlayer , SDL , Viewport 
Project Functions:MIDINoteToFrequency 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 


auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54