Public Member Functions

IWaveSound Class Reference

Search for all occurrences

Detailed Description

SeeAlso: Class Interface.



Description:
This class provides an interface into 3ds Max's default WAV sound object. Use the Interface method GetSoundObject() to get a pointer to the current sound object and then use the macro GetWaveSoundInterface() on the result to see if it supports this interface. See the sample code below:

// Retrieve the current sound object

SoundObj *sound = ip->GetSoundObject();

// Attempt to get a wave interface

IWaveSound *iWave = GetWaveSoundInterface(sound);

if (iWave) {

iWave->SetSoundFileName(_M("LedZep.wav"))

}

All methods of this class are implemented by the system.

#include <istdplug.h>

Inheritance diagram for IWaveSound:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual const
MaxSDK::AssetManagement::AssetUser
GetSoundFile ()=0
virtual BOOL  SetSoundFile (const MaxSDK::AssetManagement::AssetUser &name)=0
virtual void  SetStartTime (TimeValue t)=0
virtual TimeValue  GetStartTime ()=0
virtual TimeValue  GetEndTime ()=0

Member Function Documentation

virtual const MaxSDK::AssetManagement::AssetUser& GetSoundFile ( ) [pure virtual]
Remarks:
Returns the name of the current sound file asset.
virtual BOOL SetSoundFile ( const MaxSDK::AssetManagement::AssetUser name ) [pure virtual]
Remarks:
Sets the sound file asset. This will cause the .WAV to be loaded into the track view.
Parameters:
MSTR name

The name of the sound file asset to set.
Returns:
FALSE if the file can't be opened or no wave track exists; otherwise TRUE.
virtual void SetStartTime ( TimeValue  t ) [pure virtual]
Remarks:
Sets the time offset for the wave file.
Parameters:
TimeValue t

The start time.
virtual TimeValue GetStartTime ( ) [pure virtual]
Remarks:
Returns the start time offset for the wave.
virtual TimeValue GetEndTime ( ) [pure virtual]
Remarks:
Returns the end time for the wave.

IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound
IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound IWaveSound