KAudioFormat.h File Reference

Defines the data flow format. More...

#include "EAudioFmt.h"

Data Structures
struct	KAudioFormat
	KAudioFormat structure. Management of the audio formats More...
Defines
#define	KAudioFormat_clone(pFmt)   _KAudioFormat_clone (pFmt, __K_FILE__, __K_LINE__)
	Clones a KAudioFormat structure.
Functions
KTL_API KAudioFormat *	KAudioFormat_new ()
	Creates a KAudioFormat structure.
KTL_API void	KAudioFormat_init (KAudioFormat *pFmt)
	Initializes a KAudioFormat structure.
KTL_API void	KAudioFormat_delete (KAudioFormat **ppAFmt)
	Deletes a KAudioFormat structure.
KTL_API KUInt32	KAudioFormat_getBits (const KAudioFormat *pFmt)
	Obtains the bits number used by the given audio format.
KTL_API KBool	KAudioFormat_computeBitrate (KAudioFormat *pFmt)
	Update the bitrate.
KTL_API KAudioFormat *	_KAudioFormat_clone (const KAudioFormat *kFormat, KString sFile, KInt32 iLine)
	Clones a KAudioFormat structure.
KTL_API KAudioFormat *	KAudioFormat_copy (KAudioFormat *dst, const KAudioFormat *src)
	Copies a KAudioFormat structure in another allocated one.
KTL_API KBool	KAudioFormat_check (KAudioFormat *fmt)
	Verifies the KAudioFormat structure efficiency.
KTL_API void	KAudioFormat_print (KAudioFormat *fmt)
	Prints a KAudioFormat structure.

---

Detailed Description

Defines the data flow format.

Version:

KToolLib-1.0

Author:

Fabien Gallot

Date:

22/01/2008

Note:

Copyright © 2008-2010 iKlax Media SAS (www.iklaxmedia.com). All rights reserved.

---

Define Documentation

#define KAudioFormat_clone (  pFmt   )     _KAudioFormat_clone (pFmt, __K_FILE__, __K_LINE__)

Clones a KAudioFormat structure. Parameters: pFmt  the pointer to the KAudioFormat structure to be cloned Returns: the pointer to the cloned KAudioFormat structure if successful otherwise knull

---

Function Documentation

KTL_API KAudioFormat* _KAudioFormat_clone (  const KAudioFormat *  kFormat, KString  sFile, KInt32  iLine )

Clones a KAudioFormat structure. Warning: Do not use this function but prefer 'KAudioFormat_clone' Parameters: kFormat  the pointer to the KAudioFormat structure to be cloned sFile  the file name where this function is called iLine  the line number where this function is called Returns: the pointer to the cloned KAudioFormat structure if successful otherwise knull

KTL_API KBool KAudioFormat_check (  KAudioFormat *  fmt  )

Verifies the KAudioFormat structure efficiency. Parameters: fmt  the pointer to the KAudioFormat structure to be checked Returns: ktrue if the structure is efficient otherwise kfalse

KTL_API KBool KAudioFormat_computeBitrate (  KAudioFormat *  pFmt  )

Update the bitrate. All fields of the structure must be filled to compute the bitrate Parameters: pFmt  the pointer to the KAudioFormat structure Returns: ktrue if successful otherwise kfalse

KTL_API KAudioFormat* KAudioFormat_copy (  KAudioFormat *  dst, const KAudioFormat *  src )

Copies a KAudioFormat structure in another allocated one. Parameters: dst  the pointer to the allocated KAudioFormat structure src  the pointer to the KAudioFormat structure to be copied Returns: the pointer to the copied KAudioFormat structure if successful otherwise knull

KTL_API void KAudioFormat_delete (  KAudioFormat **  ppAFmt  )

Deletes a KAudioFormat structure. Parameters: ppAFmt  a reference to a KAudioFormat structure pointer

KTL_API KUInt32 KAudioFormat_getBits (  const KAudioFormat *  pFmt  )

Obtains the bits number used by the given audio format. Parameters: pFmt  the pointer to the KAudioFormat structure Returns: the bits number used by the audio format

KTL_API void KAudioFormat_init (  KAudioFormat *  pFmt  )

Initializes a KAudioFormat structure. Parameters: pFmt  the pointer to the KAudioFormat structure to be initialized

KTL_API KAudioFormat* KAudioFormat_new (   )

Creates a KAudioFormat structure. Returns: the pointer to the created KAudioFormat structure if successful otherwise knull

KTL_API void KAudioFormat_print (  KAudioFormat *  fmt  )

Prints a KAudioFormat structure. Warning: Only in debug mode Parameters: fmt  the pointer to the KAudioFormat structure

---