User Tools

Site Tools


hpl3:community:scripting:classes:csoundentry

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

hpl3:community:scripting:classes:csoundentry [2015/11/05 11:27] (current)
abion47 created
Line 1: Line 1:
 +=====cSoundEntry=====
 +
 +====Fields====
 +
 +cSoundEntry has no public fields.
 +
 +====Functions====
 +
 +^ Return Type ^ Function Name ^ Parameters ^ Description ^
 +| const [[tString]]&​ | GetName |     ​| ​  |
 +| [[eSoundEntryType]] | GetType |     ​| ​  |
 +| int | GetId |     ​| ​  |
 +| [[eSoundEntryDataType]] | GetDataType |     ​| ​  |
 +| bool | IsFirstTime |     ​| ​  |
 +| void | SetBlockable | bool abX |   |
 +| void | SetBlockVolumeMul | float afX |   |
 +| void | SetPosition | const [[cVector3f]] &in avPosition |   |
 +| void | SetVelocity | const [[cVector3f]] &in avVelocity |   |
 +| const [[cVector3f]]&​ | GetPosition |     ​| ​  |
 +| void | SetPostionIsHeadRelative | bool abX |   |
 +| bool | GetPostionIsHeadRelative |     ​| ​  |
 +| bool | IsPlaying |     ​| ​  |
 +| float | GetElapsedTime |     ​| ​  |
 +| void | SetElapsedTime | float afTime |   |
 +| float | GetTotalTime |     ​| ​  |
 +| float | GetAudibility |     ​| ​  |
 +| void | SetParam | const [[tString]]&​ asName, \\ float afValue |   |
 +| void | SetParam | int alIdx, \\ float afValue |   |
 +| int | GetParamNum |     ​| ​  |
 +| float | GetParamValue | int alIdx |   |
 +| float | GetParamMin | int alIdx |   |
 +| float | GetParamMax | int alIdx |   |
 +| const [[tString]]&​ | GetParamName | int alIdx |   |
 +| void | SetPaused | bool abX |   |
 +| void | SetVolume | float afX |   |
 +| void | SetSpeed | float afX |   |
 +| bool | GetPaused |     ​| ​  |
 +| float | GetVolume |     ​| ​  |
 +| float | GetSpeed |     ​| ​  |
 +| float | GetVolumeMul |     ​| ​  |
 +| float | GetSpeedMul |     ​| ​  |
 +| float | GetMinDistance |     ​| ​  |
 +| float | GetMaxDistance |     ​| ​  |
 +| void | SetReverbActive | bool abX |   |
 +| bool | GetReverbActive |     ​| ​  |
 +| void | SetReverbAmount | float afX |   |
 +| float | GetReverbAmount |     ​| ​  |
 +| void | SetSpeakerSpread | float afX |   |
 +| float | GetSpeakerSpread |     ​| ​  |
 +| bool | IsPriorityReleased |     ​| ​  |
 +| bool | Is3D |     ​| ​  |
 +| bool | IsOneShot |     ​| ​  |
 +| bool | IsVirtual |     ​| ​  |
 +| void | Stop | bool abPlayEnd |   |
 +| void | SetVolumeMul | float afMul |   |
 +| void | SetSpeedMul | float afMul |   |
 +| void | FadeVolumeMulTo | float afDestMul, \\ float afSpeed |   |
 +| void | FadeSpeedMulTo | float afDestMul, \\ float afSpeed |   |
 +| void | FadeOut | float afSpeed |   |
 +| void | FadeIn | float afVolumeMul,​ \\ float afSpeed |   |
 +| void | SetStopDisabled | bool abX |   |
 +| bool | GetStopDisabled |     ​| ​  |
 +
 +====Remarks====
 +
 +Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
  
hpl3/community/scripting/classes/csoundentry.txt ยท Last modified: 2015/11/05 11:27 by abion47