View source for Audio (lx-audio.hpp)

{{DISPLAYTITLE:audio (lx_audio.hpp)}}

<span id="C1"></span>
<span id="S1"></span>
== 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 =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 Item) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         void                   **ppvObj);
</syntaxhighlight>

<span id="C2"></span>
===== (2) SDK: AudioAnimService::Sample =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 Sample) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         double                   time,
         unsigned int             type,
         void                    *value);
</syntaxhighlight>

<span id="C3"></span>
Return true if the audio for animation is playing.

===== (3) SDK: AudioAnimService::Playing =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  int,
 Playing) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C4"></span>
Return true if the audio for animation is loop mode.

===== (4) SDK: AudioAnimService::Loop =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  int,
 Loop) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C5"></span>
Return true if the audio for animation is in mute.

===== (5) SDK: AudioAnimService::Mute =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  int,
 Mute) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C6"></span>
Return true if the scurb is enabled.

===== (6) SDK: AudioAnimService::Scrub =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  int,
 Scrub) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C7"></span>
Return the start time to play audio.

===== (7) SDK: AudioAnimService::Start =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  double,
 Start) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C8"></span>
Return the end time to play audio.

===== (8) SDK: AudioAnimService::End =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  double,
 End) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C9"></span>
Return the audio object.

===== (9) SDK: AudioAnimService::Audio =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 Audio) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         void                   **ppvObj);
</syntaxhighlight>

<span id="C10"></span>
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 =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 Preview) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         double                   startTime,
         double                   endTime,
         void                   **ppvObj);
</syntaxhighlight>

<span id="C11"></span>
===== (11) SDK: AudioAnimService::ItemSample =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 ItemSample) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              obj,
         int                      loop,
         double                   time,
         unsigned int             type,
         void                    *value);
</syntaxhighlight>

<span id="C12"></span>
Return the audio object.

===== (12) SDK: AudioAnimService::ItemAudio =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 ItemAudio) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              obj,
         void                   **ppvObj);
</syntaxhighlight>

<span id="C13"></span>
===== (13) SDK: LXu_AUDIOANIMSERVICE define =====

<syntaxhighlight>
 #define [[LXu_AUDIOANIMSERVICE (index)|LXu_AUDIOANIMSERVICE]]    "42F4A65B-A5BE-4C77-8A66-3C1B245C6BB0"</syntaxhighlight>

<span id="C14"></span>
===== (14) SDK: CLxUser_AudioAnimService::GetAudio method =====

<syntaxhighlight>
         bool
 GetAudio (
         CLxUser_Audio           &audio)
 {
         [[LXtObjectID (index)|LXtObjectID]]              obj;
 
         if ([[LXx_FAIL (index)|LXx_FAIL]] (Audio (&obj)))
                 return false;
 
         return audio.take (obj);
 }
         bool
 GetItemAudio (
         CLxUser_Item             item,
         CLxUser_Audio           &audio)
 {
         [[LXtObjectID (index)|LXtObjectID]]              obj;
 
         if ([[LXx_FAIL (index)|LXx_FAIL]] (ItemAudio (item, &obj)))
                 return false;
 
         return audio.take (obj);
 }
</syntaxhighlight>

<span id="C15"></span>
Empty AudioAnim service Python user class.

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

<syntaxhighlight>
 pass
</syntaxhighlight>

[[Category:Headers]]
[[Category:Autogenerated]]