audio (lx_audio.hpp)

From The Foundry MODO SDK wiki
(Redirected from ILxAudioAnimService (index))
Jump to: navigation, search
There are security restrictions on this page


Global Service

Audio for animation can be accessed through the SDK using a global service interface.

Return the audio clip item for animation.

(1) SDK: AudioAnimService::Item
         LXxMETHOD(  LxResult,
 Item) (
         LXtObjectID              self,
         void                   **ppvObj);

(2) SDK: AudioAnimService::Sample
         LXxMETHOD(  LxResult,
 Sample) (
         LXtObjectID              self,
         double                   time,
         unsigned int             type,
         void                    *value);

Return true if the audio for animation is playing.

(3) SDK: AudioAnimService::Playing
         LXxMETHOD(  int,
 Playing) (
         LXtObjectID              self);

Return true if the audio for animation is loop mode.

(4) SDK: AudioAnimService::Loop
         LXxMETHOD(  int,
 Loop) (
         LXtObjectID              self);

Return true if the audio for animation is in mute.

(5) SDK: AudioAnimService::Mute
         LXxMETHOD(  int,
 Mute) (
         LXtObjectID              self);

Return true if the scurb is enabled.

(6) SDK: AudioAnimService::Scrub
         LXxMETHOD(  int,
 Scrub) (
         LXtObjectID              self);

Return the start time to play audio.

(7) SDK: AudioAnimService::Start
         LXxMETHOD(  double,
 Start) (
         LXtObjectID              self);

Return the end time to play audio.

(8) SDK: AudioAnimService::End
         LXxMETHOD(  double,
 End) (
         LXtObjectID              self);

Return the audio object.

(9) SDK: AudioAnimService::Audio
         LXxMETHOD(  LxResult,
 Audio) (
         LXtObjectID              self,
         void                   **ppvObj);

This also return the audio object between start and end times, but this is resampled with the current animation settings like Start time and Loop. The audio object must be release on user side.

(10) SDK: AudioAnimService::Preview
         LXxMETHOD(  LxResult,
 Preview) (
         LXtObjectID              self,
         double                   startTime,
         double                   endTime,
         void                   **ppvObj);

(11) SDK: AudioAnimService::ItemSample
         LXxMETHOD(  LxResult,
 ItemSample) (
         LXtObjectID              self,
         LXtObjectID              obj,
         int                      loop,
         double                   time,
         unsigned int             type,
         void                    *value);

Return the audio object.

(12) SDK: AudioAnimService::ItemAudio
         LXxMETHOD(  LxResult,
 ItemAudio) (
         LXtObjectID              self,
         LXtObjectID              obj,
         void                   **ppvObj);

(13) SDK: LXu_AUDIOANIMSERVICE define
 #define LXu_AUDIOANIMSERVICE    "42F4A65B-A5BE-4C77-8A66-3C1B245C6BB0"

(14) SDK: CLxUser_AudioAnimService::GetAudio method
         bool
 GetAudio (
         CLxUser_Audio           &audio)
 {
         LXtObjectID              obj;
 
         if (LXx_FAIL (Audio (&obj)))
                 return false;
 
         return audio.take (obj);
 }
         bool
 GetItemAudio (
         CLxUser_Item             item,
         CLxUser_Audio           &audio)
 {
         LXtObjectID              obj;
 
         if (LXx_FAIL (ItemAudio (item, &obj)))
                 return false;
 
         return audio.take (obj);
 }

Empty AudioAnim service Python user class.

(15) PY: empty Service.AudioAnim user class
 pass