Audio interface for FBSDK. More...

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

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...

Macros
#define	FBSDK_DLL K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...

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...

enum	FBExistingClipAction { kFBExistingClipAskUser , kFBExistingClipRemove , kFBExistingClipAbortOperation }
	Action to perform, when preparing an Audio In object to record, when the action clip associated to the recording path is already in the scene. More...

enum	FBExistingFileAction { kFBExistingFileAskUser , kFBExistingFileOverwrite , kFBExistingFileAppend , kFBExistingFileAbortOperation }
	Action to perform, when preparing an Audio In object to record, when the action clip associated to the recording path already exists on disk and is not empty. More...

Functions
	__FB_FORWARD (FBAudioIn)

	__FB_FORWARD (FBAudioOut)

	__FB_FORWARD (FBAudioClip)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, AudioIn)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, AudioOut)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, AudioClip)

	FB_DEFINE_ENUM (K_DLLIMPORT, AccessMode)

	FB_DEFINE_ENUM (K_DLLIMPORT, UseChnMode)

	FB_DEFINE_ENUM (K_DLLIMPORT, TriggerStyle)

	FB_DEFINE_ENUM (K_DLLIMPORT, ExistingClipAction)

	FB_DEFINE_ENUM (K_DLLIMPORT, ExistingFileAction)

K_DLLIMPORT FBAudioOut *	FBAudioOutGetDefault ()
	Get default audio output. More...

Detailed Description

Audio interface for FBSDK.

Definition in file fbaudio.h.

Macro Definition Documentation

◆ FBSDK_DLL

#define FBSDK_DLL K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbaudio.h.

Enumeration Type Documentation

◆ FBAccessMode

enum FBAccessMode

Data access modes.

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

Definition at line 66 of file fbaudio.h.

◆ FBExistingClipAction

enum FBExistingClipAction

Action to perform, when preparing an Audio In object to record, when the action clip associated to the recording path is already in the scene.

Enumerator
kFBExistingClipAskUser	Ask the user for desired operation via a dialog.
kFBExistingClipRemove	Remove the action clip from the scene.
kFBExistingClipAbortOperation	Cancel preparing the audio in to record.

Definition at line 86 of file fbaudio.h.

◆ FBExistingFileAction

enum FBExistingFileAction

Action to perform, when preparing an Audio In object to record, when the action clip associated to the recording path already exists on disk and is not empty.

Enumerator
kFBExistingFileAskUser	Ask the user for desired operation via a dialog.
kFBExistingFileOverwrite	Overwrite the existing file on disk.
kFBExistingFileAppend	Append the new recording to existing recording. Warning: Be sure that the current file format match your recording option!
kFBExistingFileAbortOperation	Cancel preparing the audio in to record.

Definition at line 93 of file fbaudio.h.

◆ FBTriggerStyle

enum FBTriggerStyle

Audio clips' trigger styles.

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

Definition at line 79 of file fbaudio.h.

◆ FBUseChnMode

enum FBUseChnMode

Use Channel modes.

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

Definition at line 72 of file fbaudio.h.

Function Documentation

◆ FBAudioOutGetDefault()

K_DLLIMPORT FBAudioOut* FBAudioOutGetDefault ( )

Get default audio output.

Classes

Macros

Enumerations

Functions