hou.audio module
Not implemented yet
Functions
play()-
When the Audio Panel is in the test mode, starts playing the sound specified as a Chop or a file.
reverse()-
When the Audio Panel is in the test mode, starts playing the sound in reverse. The audio sound is specified as a Chop or a file in the Audio Panel.
setAudioFileName(path)-
Sets the file path of the audio file in the Audio Panel, used for playback during testing, animation or scrubbing.
setAudioFrame(frame)-
Sets the frame to sync the audio. The audio offset (in seconds) will coincide with this frame.
setAudioOffset(offset)-
Sets the time offset of the sound to sync the audio. This offset, specified in seconds, will coincide with the audio frame.
setChopPath(path)-
Sets the node path of chop node that should be used for the playback during testing, animation or scrubbing.
setLeftVolume(value)-
Sets the volume for the left audio channel.
setLooping(on)-
When the Audio Panel is in the test mode, sets whether the test should start playing from the beginning once the end is reached.
setMeter(on)-
Sets whether the meter will show the volume levels during the audio playback.
setMono(on)-
Sets whether the audio will play in mono or stereo mode.
setRewind(on)-
When the Audio Panel is in the test mode, sets whether the sound should rewind to the beginning when the test is stopped. If not, on subsequent start, the sound will resume from the point at which it was previously stopped.
setRightVolume(value)-
Sets the volume for the right channel.
setScrubRate(value)-
When the sustain period is non-zero, the small chunk of the sound will be repeated with this frequency when the scrubbing comes to a standstill at a single frame.
setScrubRepeat(on)-
Sets whether the sound chunk is repeated during scrubbing.
setScrubSustain(value)-
Sets the length of time the that the sound chunk is repeatedly played when scrubbing comes to a standstill on a particular single frame. In practice, when the value is zero, no sound will be played when scrubbing keeps hovering over one frame. But, when the value is non-zero, a small sound chunk will keep playing repeatedly with a specified frequency.
setVolumeTied(self, on)-
Sets whether changing the volume of one channel affects the volume of the other channel. If so, both channels will have the same volume set.
stop()-
When the Audio Panel is in the test mode, stops the test playback, if any audio is currently playing.
turnOffAudio()-
Turns off the audio playback.
useAudioFile()-
Sets the Audio Panel to use a disk file for the audio.
useChops()-
Sets the Audio Panel to use a CHOP node for the audio.
useTestMode()-
Put the Audio Panel into a mode that tests the audio playback.
When the Audio Panel is in the test mode, it will play the entire audio soundtrack. The test can be stopped and resumed with stop() and play() functions.
The sound will not play when scrubbing the thumb in the playbar or when playing the animation in the playbar. The audio must be in either scrub or realtime mode for playing the sound during animation or scrubbing.
useTimeLineMode()-
Puts the Audio Panel into a mode that plays the sound during animation or scrubbing.
When the Audio Panel is in the timeline (known as scrub) mode, it will play the audio during the animation or when scrubbing the thumb in the playbar.
useTimeSliceMode()-
Puts the Audio Panel into a mode that plays the sound during animation or scrubbing.
When the Audio Panel is in the timeline (known as scrub) mode, it will play the audio during the animation or when scrubbing the thumb in the playbar.