SetSoundPosition
Jump to navigation
Jump to search
This function is used to change the seek position of the specified sound element. Use a player element to control a players voice with this function.
Syntax
bool setSoundPosition ( element theSound, int pos )
Required Arguments
- theSound: The sound element which seek position you want to modify.
- pos: An integer value representing the new seek position of the sound in milliseconds.
Returns
Returns true if the sound element's seek position was successfully changed, false otherwise.
Example
This example allows the player to set how many milliseconds into the song he wants it to play from
Click to collapse [-]
ClienttheSound = playSound("music/song.mp3") function setSongPos(cmd, ms) local ssp = setSoundPosition(theSound, ms) if ssp then local seconds = ms / 1000 --this will get the amount of seconds from milliseconds outputChatBox("Sound is now playing from: "..seconds.." Seconds!") else outputChatBox("An error has occured. Please make sure there are at least") local seconds = ms / 1000 --this will get the amount of seconds from milliseconds outputChatBox(seconds.." Seconds in this song!") end end addCommandHandler("skipsong", setSongPos)
Changelog
Version | Description |
---|
1.3.2 | Added player element for voice control |
See Also
- getRadioChannel
- getRadioChannelName
- getSFXStatus
- getSoundBPM
- getSoundBufferLength
- getSoundEffectParameters
- getSoundEffects
- getSoundFFTData
- getSoundLength
- getSoundLevelData
- getSoundMaxDistance
- getSoundMetaTags
- getSoundMinDistance
- getSoundPan
- getSoundPosition
- getSoundProperties
- getSoundSpeed
- getSoundVolume
- getSoundWaveData
- isSoundLooped
- isSoundPanningEnabled
- isSoundPaused
- playSFX3D
- playSFX
- playSound3D
- playSound
- setRadioChannel
- setSoundEffectEnabled
- setSoundEffectParameter
- setSoundLooped
- setSoundMaxDistance
- setSoundMinDistance
- setSoundPan
- setSoundPanningEnabled
- setSoundPaused
- setSoundPosition
- setSoundProperties
- setSoundSpeed
- setSoundVolume
- stopSound
- Shared
- playSoundFrontEnd