#include <soundobj.h>
Class Description
- See also:
- Class
ReferenceTarget, Class Animatable.
- Description:
- This is the base class for the creation of sound plug-ins. The
3ds Max user may choose a sound plug-in using the File /
Preferences... Animation Tab / Sound Plug-In option.
There is always one sound object in the scene. A sound object's
primary purpose is to provide a sound track for the scene. The
sound object also serves as a clock that controls timing when an
animation is played. This ensure the animation is synched to the
sound object. This class has methods to start and stop the sound
playing, play a specified range of the sound, and toggle the sound
on and off.
A sound plug-in can participate in Track View by implementing the
methods of Animatable such as PaintTrack().
See the Advanced Topics section Track View for
details.
Sound Object
plug-ins use a Super Class ID of SOUNDOBJ_CLASS_ID.
Member Function Documentation
virtual SClass_ID
SuperClassID |
( |
|
) |
[inline, virtual] |
Retrieves a constant representing the type of the plugin.
- Returns:
- A super class id that uniquely identifies the type (category)
of the plugin. Note that several plugin classes can be of the same
type, thus return the same super class id. Plugins are uniquely
identified by their class ids.
List of Super Class IDs.
- See also:
- SClass_ID
Reimplemented from ReferenceTarget.
- Parameters:
- TimeValue tStart
The time to start playing the sound.
TimeValue t0
The loop begin range.
TimeValue t1
The loop end range.
TimeValue frameStep
The frame increment.
- Returns:
- TRUE if the sound was played; FALSE otherwise.
- Parameters:
- TimeValue t0
The start time for playback.
TimeValue t1
The end time for playback.
- Returns:
- The time at which the sound was stopped.
- Returns:
- The current time.
virtual BOOL Playing |
( |
|
) |
[pure virtual] |
- Parameters:
- PAVIFILE pfile
The file to save the sound track to.
TimeValue t0
The start of the time range to save.
TimeValue t1
The end of the time range to save.
virtual void SetMute |
( |
BOOL |
mute |
) |
[pure virtual] |
- Parameters:
- BOOL mute
Specifies if the sound should be muted. TRUE indicates the sound
should be muted; FALSE indicates the sound should be enabled.
virtual BOOL IsMute |
( |
|
) |
[pure virtual] |