Union Bytes EngineModulesSoundsSetSoundFrequency

Union Bytes Engine

GeneralHilfeseitensyntaxModules
AnimationBillboardCageCameraControlDefinitionDrawingFontGadgetGeneralJoystickLightMaterialMathMeshNetworkNodeObjectParticlePhysicShaderSounds
ExamineSoundsFreeSoundGetSoundLengthGetSoundStateIsSoundLoadSoundDefinitionLoadSoundFileMoveSoundPauseSoundPlaySoundResumeSoundRotateSoundSetCollisionSoundSetSoundConeSetSoundDirectionSetSoundFrequencySetSoundRangeSetSoundStateSetSoundVolumeSoundSoundIDStopSoundUnsetCollisionSound
SpriteTexture

SetSoundFrequency

Description

Sets the frequency of the specified sound.

Syntax

UBE_SetSoundFrequency( Sound.i, Frequency.f )

Parameters

Sound The number of the sound or #UBE_GLOBAL.
Frequency The value of the new frequency. This value is relative, so the sound played faster if Frequency > 1.0 and slower if Frequency < 1.0. By default the frequency is 1.0. This value is the personal sound frequency or the global sound frequency if Sound is set to #UBE_Global.

Return value

None

Remarks

The absolute audible frequency of the sound depends (multiplicative) on the global sound frequency, the personal frequency and (if the Doppler effect is enabled) the relative velocity between the sound and the listener.

See also

Union Bytes | Login