fbaudio.h File Reference

Audio interface for FBSDK. More...

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbaudiofmt.h>

Go to the source code of this file.

Classes
class	FBAudioIn
	Audio In class. More...
class	FBAudioOut
	Audio Out class. More...
class	FBAudioClip
	Used to play audio clips and access their properties. More...
class	FBPropertyListAudioIn
	List: AudioIn More...
class	FBPropertyListAudioOut
	List: AudioOut More...
class	FBPropertyListAudioClip
	List: AudioClip More...
Defines
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once...
Enumerations
enum	FBAccessMode { kFBAccessModeDisk, kFBAccessModeMemory }
	Data access modes. More...
enum	FBUseChnMode { kFBUseChannelLeftOnly, kFBUseChannelRightOnly, kFBUseChannelBoth }
	Use Channel modes. More...
enum	FBTriggerStyle { kFBTriggerStyleContinue, kFBTriggerStyleCut, kFBTriggerStyleToggle }
	Audio clips' trigger styles. More...
Functions
	__FB_FORWARD (FBAudioIn)
	__FB_FORWARD (FBAudioOut)
	__FB_FORWARD (FBAudioClip)
	FB_DEFINE_COMPONENT (FBSDK_DLL, AudioIn)
	FB_DEFINE_COMPONENT (FBSDK_DLL, AudioOut)
	FB_DEFINE_COMPONENT (FBSDK_DLL, AudioClip)
	FB_DEFINE_ENUM (FBSDK_DLL, AccessMode)
	FB_DEFINE_ENUM (FBSDK_DLL, UseChnMode)
	FB_DEFINE_ENUM (FBSDK_DLL, TriggerStyle)
FBSDK_DLL HFBAudioOut	FBAudioOutGetDefault ()
	Get default audio output.

---

Detailed Description

Audio interface for FBSDK.

Definition in file fbaudio.h.

---

Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Search for all occurrences

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbaudio.h.

---

Enumeration Type Documentation

enum FBAccessMode

Search for all occurrences

Data access modes.

Enumerator:

kFBAccessModeDisk	Access data directly to disk using a cache system. Search for all occurrences
kFBAccessModeMemory	Access data from memory, which means that it will copyed entirely into it. Search for all occurrences

Definition at line 66 of file fbaudio.h.

                  {
    kFBAccessModeDisk,  
    kFBAccessModeMemory 
};

enum FBUseChnMode

Search for all occurrences

Use Channel modes.

Enumerator:

kFBUseChannelLeftOnly	Left channel will be played in both speakers. Search for all occurrences
kFBUseChannelRightOnly	Right channel will be played in both speakers. Search for all occurrences
kFBUseChannelBoth	Default mode, where each channel play in its respective speaker. Search for all occurrences

Definition at line 72 of file fbaudio.h.

                  {
    kFBUseChannelLeftOnly,  
    kFBUseChannelRightOnly, 
    kFBUseChannelBoth       
};

enum FBTriggerStyle

Search for all occurrences

Audio clips' trigger styles.

Enumerator:

kFBTriggerStyleContinue	Previously triggered clips that are still playing won't be stopped and mixing will occur. Search for all occurrences
kFBTriggerStyleCut	Previously triggered clips that are still playing will be stopped. Search for all occurrences
kFBTriggerStyleToggle	If a previously triggered clip is playing, it will only be stopped, otherwise a new starts playing. No mixing and no loop. Search for all occurrences

Definition at line 79 of file fbaudio.h.

                    {
    kFBTriggerStyleContinue,    
    kFBTriggerStyleCut,         
    kFBTriggerStyleToggle       
};

---

Function Documentation

__FB_FORWARD

(

FBAudioIn

)

Search for all occurrences

__FB_FORWARD

(

FBAudioOut

)

Search for all occurrences

__FB_FORWARD

(

FBAudioClip

)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		AudioIn
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		AudioOut
	)

Search for all occurrences

FB_DEFINE_COMPONENT	(	FBSDK_DLL	,
		AudioClip
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		AccessMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		UseChnMode
	)

Search for all occurrences

FB_DEFINE_ENUM	(	FBSDK_DLL	,
		TriggerStyle
	)

Search for all occurrences

FBSDK_DLL HFBAudioOut FBAudioOutGetDefault

(

)

Search for all occurrences

Get default audio output.