sound

Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

sound [-endTime time] [-file string] [-length] [-mute] [-name string] [-offset time] [-sourceEnd time] [-sourceStart time] [objects]

sound is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
-file(-f)	string
Name of sound file.
-offset(-o)	time
Time at which to start the sound.
-endTime(-et)	time
Time at which to end the sound.
-sourceStart(-ss)	time
Time offset from the start of the sound file at which to start the sound.
-sourceEnd(-se)	time
Time offset from the start of the sound file at which to end the sound.
-name(-n)	string
Name to give the resulting audio node.
-length(-l)
The length (in the current time unit) of the sound.
-mute(-m)
Mute the audio clip.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// Create an audio node for a sound file, and have it
// start at time 10.  This command will return the name
// of the created node, something like "audio1".
//
sound -offset 10 -file "ohNo.aiff";

// In order to have this sound displayed in a
// timeControl widget (like the timeSlider) use a
// command like this one, where the global MEL variable
// $gPlayBackSlider is the name of the widget to display
// the sound in.
//
global string $gPlayBackSlider;
timeControl -edit -sound audio1 $gPlayBackSlider;