audio

Go to: Attributes.

This node contains information about a sound used in the system. Audio nodes are used for interactive sound scrubbing, playback with sound, etc., and can be created through the "sound" command. An audio node contains a path to a sound file in AIFF or AIFF-C format, and a start time for the sound.

Attributes (14)

channels, duration, endFrame, filename, frameCount, mute, offset, order, sampleRate, silence, sourceEnd, sourceStart, track, trackState

Long name (short name)	Type	Default	Flags
channels (c)	integer	0
The number of channels in the sound file
duration (du)	time	::zero
The length of the sound file in frames
endFrame (ef)	time	::zero
The end time of the audio clip
filename (f)	string	NULL
The path name to the actual sound file.
frameCount (fc)	integer	0
The number of sound frames in the sound file. A sound frame is a discrete sound sample
mute (mu)	bool	0
Whether the sound is muted. Note: animating this attribute is not supported
offset (o)	time	::zero
The time the sound file begins
order (r)	integer	1
Playback order
sampleRate (sr)	integer	0
The sample rate of the sound file
silence (si)	time	::zero
Amount of silence before playing the sound (this is useful when trying to manage the audio clip)
sourceEnd (se)	time	::zero
The frame from the original source file at which this sound actually stops playing (used for trimming the end of sound playback)
sourceStart (ss)	time	::zero
The frame from the original source file at which this sound actually begins playing (used for trimming the beginning of sound playback)
track (tk)	integer	1
Track number. This flag was obsoleted and was only present for 2010 compatibility, however, I need it for the track naming feature.
trackState (ts)	short	0
Flag bits for the track state. Current mask values are: 1: when set means that all the audio clips on the track are locked 2: when set means that all the audio clips on the track are soloed 4: when set means that all the audio clips on the track are muted 8: when set means that another track is soloed, so this track acts as if it is muted 16: when set means that the audio clip is muted, used by tools that work on a shot/shot basis, not via tracks