nw::snd::WaveSoundHandle::FadeIn Member Function

Syntax

#include <nw/snd/snd_WaveSoundHandle.h>
void FadeIn(
     int frames
);

Arguments

Name Description
in frames Number of elapsed frames during a fade-in. The number of frames is based on the number of calls to SoundArchivePlayer::Update.

Return Values

None.

Description

Fades in the sound when playback starts.

If fade-ins are specified with this function, they are configured to occur when SoundArchivePlayer::Update is called for the first time after SoundArchivePlayer::StartSound or StartPrepared is used to start playback.

This function has no effect if it was called after playback of the sound started and the first call to SoundArchivePlayer::Update.

The volume control used for fade-in is also used for fade-out when playback stops.

See Also

SoundArchivePlayer::StartSound
StartPrepared

Revision History

2010/12/24
Added information about the number of frames.
2010/01/22
Initial version.

CONFIDENTIAL