vrdSoundNode

class vrdSoundNode

(Inherits vrdNode)

This class provides access to access a sound node.

class SpatializeSourceMode

Modes for spatialized source.

SpatializeSourceOff
SpatializeSourceOn
SpatializeSourceAuto
class ReverbEffect

Reverb effects.

NoReverb
GenericReverb
PaddedCellReverb
RoomReverb
BathRoomReverb
LivingRoomReverb
StoneRoomReverb
AuditoriumReverb
ConcertHallReverb
CaveReverb
ArenaReverb
HangarReverb
CarpetedHallwayReverb
HallwayReverb
StoneCorridorReverb
AlleyReverb
ForestReverb
CityReverb
MountainsReverb
QuarryReverb
PlainReverb

Functions

vrdSoundNode.getConeInnerAngle()
Returns:Get the inner angle of the sound cone
Return type:float
vrdSoundNode.getConeOuterAngle()
Returns:Get the outer angle of the sound cone
Return type:float
vrdSoundNode.getConeOuterGain()
Returns:Get the cone outer gain
Return type:float
vrdSoundNode.getGain()
Returns:Get the scalar amplitude multiplier
Return type:float
vrdSoundNode.getLoop()
Returns:True, if the sound is looped
Return type:bool
vrdSoundNode.getMaxDistance()
Returns:Get the maximum distance for gain calculation
Return type:float
vrdSoundNode.getMaxGain()
Returns:Get the maximum gain
Return type:float
vrdSoundNode.getMinGain()
Returns:Get the minimum gain
Return type:float
vrdSoundNode.getPitch()
Returns:Get the frequence shift value
Return type:float
vrdSoundNode.getPlay()
Returns:True, if sound is playing
Return type:bool
vrdSoundNode.getReferenceDistance()
Returns:Get the distance at which the listener will experience the volume defined by the gain parameter
Return type:float
vrdSoundNode.getReverbEffect()
Returns:The current reverb effect
Return type:vrdSoundNode.ReverbEffect
vrdSoundNode.getRolloffFactor()
Returns:Get the roll off factor
Return type:float
vrdSoundNode.getSoundData()
Returns:Get the sound data
Return type:QByteArray
vrdSoundNode.getSoundFile()
Returns:Get the path to the sound file
Return type:string
vrdSoundNode.getSourceRadius()
Returns:The radius of the sound source
Return type:float
vrdSoundNode.getSpatializeSource()
Returns:The spatialize sound mode
Return type:vrdSoundNode.SpatializeSourceMode
vrdSoundNode.setConeInnerAngle(value)

Sets the inner angle of the sound cone.

Parameters:value (float) – The new value
vrdSoundNode.setConeOuterAngle(value)

Sets the outer angle of the sound cone.

Parameters:value (float) – The new value
vrdSoundNode.setConeOuterGain(value)

Sets the cone outer gain that defines the attenuation depending on the angle to a listener.

Parameters:value (float) – The new value
vrdSoundNode.setGain(value)

Sets the scalar amplitude multiplier.

Parameters:value (float) – The new value
vrdSoundNode.setLoop(value)

Enables or disables playing the sound in a loop.

Parameters:value (bool) – If True, play sound in a loop
vrdSoundNode.setMaxDistance(value)

Sets the maximum distance for gain calculation.

Parameters:value (float) – The new value
vrdSoundNode.setMaxGain(value)

Sets the maximum gain.

Parameters:value (float) – The new value
vrdSoundNode.setMinGain(value)

Sets the minimum gain.

Parameters:value (float) – The new value
vrdSoundNode.setPitch(value)

Sets a frequence shift.

Parameters:value (float) – The new value
vrdSoundNode.setPlay(value)

Starts or stops the sound.

Parameters:value (bool) – If True, the sound starts playing. If False, stopp playing
vrdSoundNode.setReferenceDistance(value)

Sets the distance at which the listener will experience the volume defined by the gain parameter.

Parameters:value (float) – The new value
vrdSoundNode.setReverbEffect(value)

Changes the reverb effect.

Parameters:value (vrdSoundNode.ReverbEffect) – The new value
vrdSoundNode.setRolloffFactor(value)

The roll off parameter increases or decreases the attenuation.

Parameters:value (float) – The new value
vrdSoundNode.setSoundData(value)

Sets the sound data.

Parameters:value (QByteArray) – The sound data in binary format
vrdSoundNode.setSoundFile(value)

Sets a sound file to play.

Parameters:value (string) – Path to the sound file
vrdSoundNode.setSourceRadius(value)

Changes the radius of the sound source.

Parameters:value (float) – The new value
vrdSoundNode.setSpatializeSource(value)

Changes the spatialize source mode.

Parameters:value (vrdSoundNode.SpatializeSourceMode) – The new value
vrdSoundNode.start()

Start playing.

vrdSoundNode.stop()

Stop playing.