Open Reality Reference Guide
|
|
Go to the documentation of this file.
43 #include <kaydaradef.h>
48 #define FBSDK_DLL K_DLLIMPORT
54 #ifdef FBSDKUseNamespace
55 namespace FBSDKNamespace {
315 FBAudioClip(
const char* pFileName,
bool pSetToDefaultDest=
true, HIObject pObject=NULL);
418 #ifdef FBSDKUseNamespace
FBPropertyUseChnMode UseChannelMode
[Deprecated]Read Write Property: Enables you to control which track are used with stereo clips.
@ kFBUseChannelRightOnly
Right channel will be played in both speakers.
FBPropertyDouble Pitch
Read Write Property: The audio clip pitch value. To write to this property, you must first set LockPi...
FBPropertyTake CurrentTake
Read Write Property: The take this media belongs to.
FBPropertyTime Duration
[Deprecated]Read Write Property: Refer to DstDuration.
FBTime GetDelay() const
Returns the delay currently set.
virtual void FBDelete() override
Virtual FBDelete function.
FBUseChnMode
Use Channel modes.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
FBPropertyAudioOut Destination
Read Write Property: The audio output destination where the clip will be played.
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
@ kFBExistingFileAppend
Append the new recording to existing recording. Warning: Be sure that the current file format match y...
void Stop(FBAudioOut *pDestination=NULL)
Stop any playing triggered audio clip on a specified destination.
class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
@ kFBExistingFileAskUser
Ask the user for desired operation via a dialog.
FBPropertyBool Scrubbing
Read Write Property: Control which clip (one at a time) can shuttle when playing a various speeds.
@ kFBAccessModeMemory
Access data from memory, which means that it will copyed entirely into it.
FBPropertyTime EndPoint
[Deprecated]Read Write Property: Refer to DstEnd.
@ kFBAccessModeDisk
Access data directly to disk using a cache system.
bool IsMediaReady()
Check if the audio clip constructed properly.
FBPropertyTime DstIn
Read Write Property: When not used in the Story, this specify when the clips begin to play.
Audio formats definition.
FBPropertyInt Channels
Read Only Property: the number of channels in use.
FBPropertyDouble ClipSpeed
Read Write Property: The speed of the media when being played.
FBPropertyUseChnMode UseChannel
Read Write Property: Enables you to control which track are used with stereo clips.
class K_DLLIMPORT FBPropertyBase< double, kFBPT_double > FBPropertyDouble
Property: double
FBPropertyTime DstEnd
Read Write Property: Total duration of this audio clip.
bool IsReadyToRecord() const
Is the Audio In ready to record (has it been prepared properly)?
@ kFBExistingClipAskUser
Ask the user for desired operation via a dialog.
@ kFBExistingClipAbortOperation
Cancel preparing the audio in to record.
FBAudioOut(HIObject pObject=NULL)
Constructor.
FBPropertyString RelativePath
Read Only Property: Relative path of media.
FBPropertyAccessMode AccessMode
Read Write Property: Specify the media data access mode between disk or memory.
FBAudioClip(const char *pFileName, bool pSetToDefaultDest=true, HIObject pObject=NULL)
Constructor.
FBExistingFileAction
Action to perform, when preparing an Audio In object to record, when the action clip associated to th...
FBAudioIn * operator[](int pIndex)
Get the audio input at pIndex.
bool IsOnline() const
Is the Audio In online?
FBAudioFmt GetSupportedFormats() const
Returns all the Audio In supported formats (i.e.
FBAccessMode
Data access modes.
FBPropertyString Filename
[Deprecated]Read Only Property: Refer to Path
bool SetDestination(FBAudioOut *pAudioOut)
Sets the Audio Out object to be used as the destination.
class K_DLLIMPORT FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
FBAudioOut * operator[](int pIndex)
Get the audio output at pIndex.
FBAudioClip * operator[](int pIndex)
Get the audio clip at pIndex.
#define __FBClassDeclare(Name, Parent)
For internal use only.
bool PrepareToRecord(const char *pRecordingPath, FBExistingClipAction pExistingClipAction=kFBExistingClipAskUser, FBExistingFileAction pExistingFileAction=kFBExistingFileAskUser)
Prepares the Audio In for recording (similar as checking the "Record" checkbox in the UI).
FBAudioOut * GetDestination() const
Returns the Audio Out object currently used as the destination.
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
FBPropertyTime SrcIn
Read Only Property: The begin time of media.
FBPropertyTime InPoint
[Deprecated]Read Write Property: Refer to DstIn.
FBPropertyTime SrcDuration
Read Only Property: The duration time of media.
FBPropertyBool LockPitchToSpeed
Read Write Property: Time stretch enabled factor.
Used to play audio clips and access their properties.
bool Play(FBTriggerStyle pStyle=kFBTriggerStyleContinue, FBAudioOut *pDestination=NULL)
Play audio clip now.
@ kFBExistingClipRemove
Remove the action clip from the scene.
FBPropertyString Path
Read Only Property: Full Path of the media.
K_DLLIMPORT FBAudioOut * FBAudioOutGetDefault()
Get default audio output.
FBPropertyInt Bits
Read Only Property: the bits of media.
FBPropertyBool TakeSetsInPoint
[Deprecated]Read Write Property: Indicates whether to lock the InPoint to the start of the take.
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
FBPropertyInt Format
Read Only Property: Data format of media, including rate, bits and channels count....
bool FileOpen(char const *pPath)
Load an audio clip file.
FBPropertyBool ConstrainDstToTake
Read Write Property: Indicates whether to constrain the EndPoint to the end of the take.
FBPropertyTime SrcEnd
Read Only Property: The end time of media.
FBPropertyInt Rate
Read Only Property: the rate of media.
PropertyList: Concrete class for PropertyList of component
FBAudioIn(HIObject pObject=NULL)
Constructor.
FBAudioFmt GetRecordingFormat() const
Returns the recording format (i.e.
FBPropertyBool LockClipSpeed
Read Write Property: Indicates whether to lock the current playing speed.
bool SetRecordingFormat(FBAudioFmt pAudioFormat)
Sets the recording format (i.e.
bool TurnOffRecording()
Turns off the Audio In recording (similar as un-checking the "Record" checkbox in the UI).
FBTriggerStyle
Audio clips' trigger styles.
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
@ kFBExistingFileOverwrite
Overwrite the existing file on disk.
FBExistingClipAction
Action to perform, when preparing an Audio In object to record, when the action clip associated to th...
bool SetDelay(FBTime &pDelay)
Sets the delay to use.
@ kFBUseChannelLeftOnly
Left channel will be played in both speakers.
@ kFBTriggerStyleToggle
If a previously triggered clip is playing, it will only be stopped, otherwise a new starts playing....
@ kFBTriggerStyleContinue
Previously triggered clips that are still playing won't be stopped and mixing will occur.
Property class: const char * (String).
@ kFBTriggerStyleCut
Previously triggered clips that are still playing will be stopped.
MotionBuilder SDK base class.
@ kFBExistingFileAbortOperation
Cancel preparing the audio in to record.
@ kFBUseChannelBoth
Default mode, where each channel play in its respective speaker.
bool SetOnline(bool pOnline)
Turns Audio In online or offline.
FBPropertyTime DstDuration
Read Write Property: When not used in the Story, this specify when the clips stops playing.