# Module `occSDLsound` - Interface to foreign library occSDLsound

Interface to foreign library `occSDLsound`. Generated automatically using SWIG 1.3.31.

## Index

- Constant `SOUND.VER.MAJOR` - Foreign constant SOUND_VER_MAJOR
- Constant `SOUND.VER.MINOR` - Foreign constant SOUND_VER_MINOR
- Constant `SOUND.VER.PATCH` - Foreign constant SOUND_VER_PATCH
- Data type `Sound.AudioInfo` - Foreign struct type Sound_AudioInfo
- Process `Sound.AudioInfo.channels.get` - Foreign function Sound_AudioInfo_channels_get
- Process `Sound.AudioInfo.channels.set` - Foreign function Sound_AudioInfo_channels_set
- Process `Sound.AudioInfo.format.get` - Foreign function Sound_AudioInfo_format_get
- Process `Sound.AudioInfo.format.set` - Foreign function Sound_AudioInfo_format_set
- Process `Sound.AudioInfo.rate.get` - Foreign function Sound_AudioInfo_rate_get
- Process `Sound.AudioInfo.rate.set` - Foreign function Sound_AudioInfo_rate_set
- Process `Sound.AvailableDecoders` - Foreign function Sound_AvailableDecoders
- Process `Sound.ClearError` - Foreign function Sound_ClearError
- Process `Sound.Decode` - Foreign function Sound_Decode
- Process `Sound.DecodeAll` - Foreign function Sound_DecodeAll
- Data type `Sound.DecoderInfo` - Foreign struct type Sound_DecoderInfo
- Process `Sound.DecoderInfo.author.get` - Foreign function Sound_DecoderInfo_author_get
- Process `Sound.DecoderInfo.author.set` - Foreign function Sound_DecoderInfo_author_set
- Process `Sound.DecoderInfo.description.get` - Foreign function Sound_DecoderInfo_description_get
- Process `Sound.DecoderInfo.description.set` - Foreign function Sound_DecoderInfo_description_set
- Process `Sound.DecoderInfo.extensions.get` - Foreign function Sound_DecoderInfo_extensions_get
- Process `Sound.DecoderInfo.extensions.set` - Foreign function Sound_DecoderInfo_extensions_set
- Process `Sound.DecoderInfo.url.get` - Foreign function Sound_DecoderInfo_url_get
- Process `Sound.DecoderInfo.url.set` - Foreign function Sound_DecoderInfo_url_set
- Process `Sound.FreeSample` - Foreign function Sound_FreeSample
- Process `Sound.GetError` - Foreign function Sound_GetError
- Process `Sound.GetLinkedVersion` - Foreign function Sound_GetLinkedVersion
- Process `Sound.Init` - Foreign function Sound_Init
- Process `Sound.NewSample` - Foreign function Sound_NewSample
- Process `Sound.NewSampleFromFile` - Foreign function Sound_NewSampleFromFile
- Process `Sound.Quit` - Foreign function Sound_Quit
- Process `Sound.Rewind` - Foreign function Sound_Rewind
- Data type `Sound.Sample` - Foreign struct type Sound_Sample
- Process `Sound.Sample.actual.get` - Foreign function Sound_Sample_actual_get
- Process `Sound.Sample.actual.set` - Foreign function Sound_Sample_actual_set
- Process `Sound.Sample.buffer.get` - Foreign function Sound_Sample_buffer_get
- Process `Sound.Sample.buffer.set` - Foreign function Sound_Sample_buffer_set
- Process `Sound.Sample.buffer.size.get` - Foreign function Sound_Sample_buffer_size_get
- Process `Sound.Sample.buffer.size.set` - Foreign function Sound_Sample_buffer_size_set
- Process `Sound.Sample.decoder.get` - Foreign function Sound_Sample_decoder_get
- Process `Sound.Sample.decoder.set` - Foreign function Sound_Sample_decoder_set
- Process `Sound.Sample.desired.get` - Foreign function Sound_Sample_desired_get
- Process `Sound.Sample.desired.set` - Foreign function Sound_Sample_desired_set
- Process `Sound.Sample.flags.get` - Foreign function Sound_Sample_flags_get
- Process `Sound.Sample.flags.set` - Foreign function Sound_Sample_flags_set
- Data type `Sound.SampleFlags` - Foreign enumeration type Sound_SampleFlags
- Group `Sound.SampleFlags` - Foreign enumeration Sound_SampleFlags
- Process `Sound.Seek` - Foreign function Sound_Seek
- Process `Sound.SetBufferSize` - Foreign function Sound_SetBufferSize
- Data type `Sound.Version` - Foreign struct type Sound_Version
- Process `Sound.Version.major.get` - Foreign function Sound_Version_major_get
- Process `Sound.Version.major.set` - Foreign function Sound_Version_major_set
- Process `Sound.Version.minor.get` - Foreign function Sound_Version_minor_get
- Process `Sound.Version.minor.set` - Foreign function Sound_Version_minor_set
- Process `Sound.Version.patch.get` - Foreign function Sound_Version_patch_get
- Process `Sound.Version.patch.set` - Foreign function Sound_Version_patch_set
- Process `check.if.done.playing` - Foreign function check_if_done_playing
- Process `delete.Sound.AudioInfo` - Foreign function delete_Sound_AudioInfo
- Process `delete.Sound.DecoderInfo` - Foreign function delete_Sound_DecoderInfo
- Process `delete.Sound.Sample` - Foreign function delete_Sound_Sample
- Process `delete.Sound.Version` - Foreign function delete_Sound_Version
- Process `get.audio.callback.ptr` - Foreign function get_audio_callback_ptr
- Process `new.Sound.AudioInfo` - Foreign function new_Sound_AudioInfo
- Process `new.Sound.DecoderInfo` - Foreign function new_Sound_DecoderInfo
- Process `new.Sound.Sample` - Foreign function new_Sound_Sample
- Process `new.Sound.Version` - Foreign function new_Sound_Version
- Process `occ.Sound.GetError` - Foreign function occ_Sound_GetError

## Declarations

### `occSDLsound.inc`:17Data type `Sound.SampleFlags`

`DATA TYPE Sound.SampleFlags`

Foreign enumeration type `Sound_SampleFlags`.

### `occSDLsound.inc`:19Data type `Sound.AudioInfo`

`DATA TYPE Sound.AudioInfo`

Foreign struct type `Sound_AudioInfo`.

### `occSDLsound.inc`:21Data type `Sound.Version`

`DATA TYPE Sound.Version`

Foreign struct type `Sound_Version`.

### `occSDLsound.inc`:23Data type `Sound.Sample`

`DATA TYPE Sound.Sample`

Foreign struct type `Sound_Sample`.

### `occSDLsound.inc`:25Data type `Sound.DecoderInfo`

`DATA TYPE Sound.DecoderInfo`

Foreign struct type `Sound_DecoderInfo`.

### `occSDLsound.inc`:35Constant `SOUND.VER.MAJOR`

`VAL INT SOUND.VER.MAJOR`

Foreign constant `SOUND_VER_MAJOR`.

### `occSDLsound.inc`:39Constant `SOUND.VER.MINOR`

`VAL INT SOUND.VER.MINOR`

Foreign constant `SOUND_VER_MINOR`.

### `occSDLsound.inc`:43Constant `SOUND.VER.PATCH`

`VAL INT SOUND.VER.PATCH`

Foreign constant `SOUND_VER_PATCH`.

### `occSDLsound.inc`:46Group `Sound.SampleFlags`

``

Foreign enumeration `Sound_SampleFlags`.

### `occSDLsound.inc`:58Process `Sound.AudioInfo.format.set`

`INLINE PROC Sound.AudioInfo.format.set (VAL Sound.AudioInfo self, VAL INT16 format)`

Foreign function `Sound_AudioInfo_format_set`.

### `occSDLsound.inc`:65Process `Sound.AudioInfo.format.get`

`INLINE PROC Sound.AudioInfo.format.get (VAL Sound.AudioInfo self, RESULT INT16 return.value)`

Foreign function `Sound_AudioInfo_format_get`.

### `occSDLsound.inc`:72Process `Sound.AudioInfo.channels.set`

`INLINE PROC Sound.AudioInfo.channels.set (VAL Sound.AudioInfo self, VAL BYTE channels)`

Foreign function `Sound_AudioInfo_channels_set`.

### `occSDLsound.inc`:79Process `Sound.AudioInfo.channels.get`

`INLINE PROC Sound.AudioInfo.channels.get (VAL Sound.AudioInfo self, RESULT BYTE return.value)`

Foreign function `Sound_AudioInfo_channels_get`.

### `occSDLsound.inc`:86Process `Sound.AudioInfo.rate.set`

`INLINE PROC Sound.AudioInfo.rate.set (VAL Sound.AudioInfo self, VAL INT rate)`

Foreign function `Sound_AudioInfo_rate_set`.

### `occSDLsound.inc`:93Process `Sound.AudioInfo.rate.get`

`INLINE PROC Sound.AudioInfo.rate.get (VAL Sound.AudioInfo self, RESULT INT return.value)`

Foreign function `Sound_AudioInfo_rate_get`.

### `occSDLsound.inc`:100Process `new.Sound.AudioInfo`

`INLINE PROC new.Sound.AudioInfo (RESULT Sound.AudioInfo return.value)`

Foreign function `new_Sound_AudioInfo`.

### `occSDLsound.inc`:107Process `delete.Sound.AudioInfo`

`INLINE PROC delete.Sound.AudioInfo (VAL Sound.AudioInfo self)`

Foreign function `delete_Sound_AudioInfo`.

### `occSDLsound.inc`:116Process `Sound.DecoderInfo.extensions.set`

`INLINE PROC Sound.DecoderInfo.extensions.set (VAL Sound.DecoderInfo self, VAL INT extensions)`

Foreign function `Sound_DecoderInfo_extensions_set`.

### `occSDLsound.inc`:123Process `Sound.DecoderInfo.extensions.get`

`INLINE PROC Sound.DecoderInfo.extensions.get (VAL Sound.DecoderInfo self, RESULT INT return.value)`

Foreign function `Sound_DecoderInfo_extensions_get`.

### `occSDLsound.inc`:130Process `Sound.DecoderInfo.description.set`

`INLINE PROC Sound.DecoderInfo.description.set (VAL Sound.DecoderInfo self, VAL []BYTE description)`

Foreign function `Sound_DecoderInfo_description_set`.

### `occSDLsound.inc`:137Process `Sound.DecoderInfo.description.get`

`INLINE PROC Sound.DecoderInfo.description.get (VAL Sound.DecoderInfo self, RESULT INT return.value)`

Foreign function `Sound_DecoderInfo_description_get`.

### `occSDLsound.inc`:144Process `Sound.DecoderInfo.author.set`

`INLINE PROC Sound.DecoderInfo.author.set (VAL Sound.DecoderInfo self, VAL []BYTE author)`

Foreign function `Sound_DecoderInfo_author_set`.

### `occSDLsound.inc`:151Process `Sound.DecoderInfo.author.get`

`INLINE PROC Sound.DecoderInfo.author.get (VAL Sound.DecoderInfo self, RESULT INT return.value)`

Foreign function `Sound_DecoderInfo_author_get`.

### `occSDLsound.inc`:158Process `Sound.DecoderInfo.url.set`

`INLINE PROC Sound.DecoderInfo.url.set (VAL Sound.DecoderInfo self, VAL []BYTE url)`

Foreign function `Sound_DecoderInfo_url_set`.

### `occSDLsound.inc`:165Process `Sound.DecoderInfo.url.get`

`INLINE PROC Sound.DecoderInfo.url.get (VAL Sound.DecoderInfo self, RESULT INT return.value)`

Foreign function `Sound_DecoderInfo_url_get`.

### `occSDLsound.inc`:172Process `new.Sound.DecoderInfo`

`INLINE PROC new.Sound.DecoderInfo (RESULT Sound.DecoderInfo return.value)`

Foreign function `new_Sound_DecoderInfo`.

### `occSDLsound.inc`:179Process `delete.Sound.DecoderInfo`

`INLINE PROC delete.Sound.DecoderInfo (VAL Sound.DecoderInfo self)`

Foreign function `delete_Sound_DecoderInfo`.

### `occSDLsound.inc`:188Process `Sound.Sample.decoder.set`

`INLINE PROC Sound.Sample.decoder.set (VAL Sound.Sample self, VAL Sound.DecoderInfo decoder)`

Foreign function `Sound_Sample_decoder_set`.

### `occSDLsound.inc`:195Process `Sound.Sample.decoder.get`

`INLINE PROC Sound.Sample.decoder.get (VAL Sound.Sample self, RESULT Sound.DecoderInfo return.value)`

Foreign function `Sound_Sample_decoder_get`.

### `occSDLsound.inc`:202Process `Sound.Sample.desired.set`

`INLINE PROC Sound.Sample.desired.set (VAL Sound.Sample self, VAL Sound.AudioInfo desired)`

Foreign function `Sound_Sample_desired_set`.

### `occSDLsound.inc`:209Process `Sound.Sample.desired.get`

`INLINE PROC Sound.Sample.desired.get (VAL Sound.Sample self, RESULT Sound.AudioInfo return.value)`

Foreign function `Sound_Sample_desired_get`.

### `occSDLsound.inc`:216Process `Sound.Sample.actual.set`

`INLINE PROC Sound.Sample.actual.set (VAL Sound.Sample self, VAL Sound.AudioInfo actual)`

Foreign function `Sound_Sample_actual_set`.

### `occSDLsound.inc`:223Process `Sound.Sample.actual.get`

`INLINE PROC Sound.Sample.actual.get (VAL Sound.Sample self, RESULT Sound.AudioInfo return.value)`

Foreign function `Sound_Sample_actual_get`.

### `occSDLsound.inc`:230Process `Sound.Sample.buffer.set`

`INLINE PROC Sound.Sample.buffer.set (VAL Sound.Sample self, VAL INT buffer)`

Foreign function `Sound_Sample_buffer_set`.

### `occSDLsound.inc`:237Process `Sound.Sample.buffer.get`

`INLINE PROC Sound.Sample.buffer.get (VAL Sound.Sample self, RESULT INT return.value)`

Foreign function `Sound_Sample_buffer_get`.

### `occSDLsound.inc`:244Process `Sound.Sample.buffer.size.set`

`INLINE PROC Sound.Sample.buffer.size.set (VAL Sound.Sample self, VAL INT buffer.size)`

Foreign function `Sound_Sample_buffer_size_set`.

### `occSDLsound.inc`:251Process `Sound.Sample.buffer.size.get`

`INLINE PROC Sound.Sample.buffer.size.get (VAL Sound.Sample self, RESULT INT return.value)`

Foreign function `Sound_Sample_buffer_size_get`.

### `occSDLsound.inc`:258Process `Sound.Sample.flags.set`

`INLINE PROC Sound.Sample.flags.set (VAL Sound.Sample self, VAL Sound.SampleFlags flags)`

Foreign function `Sound_Sample_flags_set`.

### `occSDLsound.inc`:265Process `Sound.Sample.flags.get`

`INLINE PROC Sound.Sample.flags.get (VAL Sound.Sample self, RESULT Sound.SampleFlags return.value)`

Foreign function `Sound_Sample_flags_get`.

### `occSDLsound.inc`:272Process `new.Sound.Sample`

`INLINE PROC new.Sound.Sample (RESULT Sound.Sample return.value)`

Foreign function `new_Sound_Sample`.

### `occSDLsound.inc`:279Process `delete.Sound.Sample`

`INLINE PROC delete.Sound.Sample (VAL Sound.Sample self)`

Foreign function `delete_Sound_Sample`.

### `occSDLsound.inc`:288Process `Sound.Version.major.set`

`INLINE PROC Sound.Version.major.set (VAL Sound.Version self, VAL INT major)`

Foreign function `Sound_Version_major_set`.

### `occSDLsound.inc`:295Process `Sound.Version.major.get`

`INLINE PROC Sound.Version.major.get (VAL Sound.Version self, RESULT INT return.value)`

Foreign function `Sound_Version_major_get`.

### `occSDLsound.inc`:302Process `Sound.Version.minor.set`

`INLINE PROC Sound.Version.minor.set (VAL Sound.Version self, VAL INT minor)`

Foreign function `Sound_Version_minor_set`.

### `occSDLsound.inc`:309Process `Sound.Version.minor.get`

`INLINE PROC Sound.Version.minor.get (VAL Sound.Version self, RESULT INT return.value)`

Foreign function `Sound_Version_minor_get`.

### `occSDLsound.inc`:316Process `Sound.Version.patch.set`

`INLINE PROC Sound.Version.patch.set (VAL Sound.Version self, VAL INT patch)`

Foreign function `Sound_Version_patch_set`.

### `occSDLsound.inc`:323Process `Sound.Version.patch.get`

`INLINE PROC Sound.Version.patch.get (VAL Sound.Version self, RESULT INT return.value)`

Foreign function `Sound_Version_patch_get`.

### `occSDLsound.inc`:330Process `new.Sound.Version`

`INLINE PROC new.Sound.Version (RESULT Sound.Version return.value)`

Foreign function `new_Sound_Version`.

### `occSDLsound.inc`:337Process `delete.Sound.Version`

`INLINE PROC delete.Sound.Version (VAL Sound.Version self)`

Foreign function `delete_Sound_Version`.

### `occSDLsound.inc`:345Process `Sound.GetLinkedVersion`

`INLINE PROC Sound.GetLinkedVersion (VAL Sound.Version ver)`

Foreign function `Sound_GetLinkedVersion`.

### `occSDLsound.inc`:352Process `Sound.Init`

`INLINE PROC Sound.Init (RESULT INT return.value)`

Foreign function `Sound_Init`.

### `occSDLsound.inc`:359Process `Sound.Quit`

`INLINE PROC Sound.Quit (RESULT INT return.value)`

Foreign function `Sound_Quit`.

### `occSDLsound.inc`:366Process `Sound.AvailableDecoders`

`INLINE PROC Sound.AvailableDecoders (RESULT Sound.DecoderInfo return.value)`

Foreign function `Sound_AvailableDecoders`.

### `occSDLsound.inc`:373Process `Sound.GetError`

`INLINE PROC Sound.GetError (RESULT INT return.value)`

Foreign function `Sound_GetError`.

### `occSDLsound.inc`:380Process `occ.Sound.GetError`

`INLINE PROC occ.Sound.GetError ([]BYTE err.str, VAL INT err.str.len, RESULT INT return.value)`

Foreign function `occ_Sound_GetError`.

### `occSDLsound.inc`:387Process `Sound.ClearError`

`INLINE PROC Sound.ClearError ()`

Foreign function `Sound_ClearError`.

### `occSDLsound.inc`:394Process `Sound.NewSample`

`INLINE PROC Sound.NewSample (VAL INT rw, VAL []BYTE ext, VAL Sound.AudioInfo desired, VAL INT bufferSize, RESULT Sound.Sample return.value)`

Foreign function `Sound_NewSample`.

### `occSDLsound.inc`:401Process `Sound.NewSampleFromFile`

`INLINE PROC Sound.NewSampleFromFile (VAL []BYTE fname, VAL Sound.AudioInfo desired, VAL INT bufferSize, RESULT Sound.Sample return.value)`

Foreign function `Sound_NewSampleFromFile`.

### `occSDLsound.inc`:408Process `Sound.FreeSample`

`INLINE PROC Sound.FreeSample (VAL Sound.Sample sample)`

Foreign function `Sound_FreeSample`.

### `occSDLsound.inc`:415Process `Sound.SetBufferSize`

`INLINE PROC Sound.SetBufferSize (VAL Sound.Sample sample, VAL INT new.size, RESULT INT return.value)`

Foreign function `Sound_SetBufferSize`.

### `occSDLsound.inc`:422Process `Sound.Decode`

`INLINE PROC Sound.Decode (VAL Sound.Sample sample, RESULT INT return.value)`

Foreign function `Sound_Decode`.

### `occSDLsound.inc`:429Process `Sound.DecodeAll`

`INLINE PROC Sound.DecodeAll (VAL Sound.Sample sample, RESULT INT return.value)`

Foreign function `Sound_DecodeAll`.

### `occSDLsound.inc`:436Process `Sound.Rewind`

`INLINE PROC Sound.Rewind (VAL Sound.Sample sample, RESULT INT return.value)`

Foreign function `Sound_Rewind`.

### `occSDLsound.inc`:443Process `Sound.Seek`

`INLINE PROC Sound.Seek (VAL Sound.Sample sample, VAL INT ms, RESULT INT return.value)`

Foreign function `Sound_Seek`.

### `occSDLsound.inc`:450Process `get.audio.callback.ptr`

`INLINE PROC get.audio.callback.ptr (RESULT INT return.value)`

Foreign function `get_audio_callback_ptr`.

### `occSDLsound.inc`:457Process `check.if.done.playing`

`INLINE PROC check.if.done.playing (RESULT INT return.value)`

Foreign function `check_if_done_playing`.