k_imex.h File Reference

Import & export functions. More...

#include <KAudioFormat.h>
#include <KProgress.h>
#include "iklaxlib_global.h"
#include "KFile.h"

Functions
KL_API KFile *	k_loadIKlaxFile (KCString iklax_path)
	Loads an iKlax file.
KL_API KBool	k_loadIKmixFile (KFile *kfile, KCString ikmix_path)
	Loads a mix.
KL_API KString	k_getIKlaxFileID (KCString sFilePath)
	Gets the ID of an iKlax file or mix.
KL_API KBool	k_exportIKMixToFile (KFile *pKFile, KCString sMixName, KCString sFilePath, KBool bEraseExisted)
	Exports a mix from a KFile structure to a file.
KL_API KBool	k_exportAllIKmixToFile (KFile *pKFile, KCString sFilePath, KList *lExcluedMix)
	Exports all mixes from a KFile structure in a file.
KL_API KBool	k_exportiKmixToAudioFile (KFile *kFile, KCString mix, KCString path, KAudioFormat *fmt, KProgress *kprog)
	Exports a mix from a KFile structure to an audio file.

---

Detailed Description

Import & export functions.

Version:

iKlaxLib-1.5

Author:

Fabien Gallot

Date:

26/11/2009

See also:

This file has been developed with KToolLib.

Note:

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

---

Function Documentation

KL_API KBool k_exportAllIKmixToFile (  KFile *  pKFile, KCString  sFilePath, KList *  lExcluedMix )

Exports all mixes from a KFile structure in a file. Deletes the given file if it exists Parameters: pKFile  the pointer to the KFile structure sFilePath  the file path lExcluedMix  the pointer to the list that stores the mix that the function must not export Returns: ktrue if successful otherwise kfalse

KL_API KBool k_exportiKmixToAudioFile (  KFile *  kFile, KCString  mix, KCString  path, KAudioFormat *  fmt, KProgress *  kprog )

Exports a mix from a KFile structure to an audio file. Parameters: kFile  the pointer to the KFile structure mix  the name of the mix to be exported path  the audio file path fmt  the pointer to the audio format of the file kprog  the pointer to the KProgress structure Returns: ktrue if successful otherwise kfalse

KL_API KBool k_exportIKMixToFile (  KFile *  pKFile, KCString  sMixName, KCString  sFilePath, KBool  bEraseExisted )

Exports a mix from a KFile structure to a file. Parameters: pKFile  the pointer to the KFile structure sMixName  the name of the mix to be exported sFilePath  the file name bEraseExisted  the boolean that specifies the way of file creation. ktrue means that the file will be overwritten if it already exists. kfalse means that the mix is added to the file if it already exists Returns: ktrue if successful otherwise kfalse

KL_API KString k_getIKlaxFileID (  KCString  sFilePath  )

Gets the ID of an iKlax file or mix. Parameters: sFilePath  the file path Returns: the ID if it is found in the file otherwise knull. The returned string must be deleted by end-user after its use.

KL_API KFile* k_loadIKlaxFile (  KCString  iklax_path  )

Loads an iKlax file. Loads an iKlax file and provides the corresponding KFile structure Parameters: iklax_path  the path of the file to be loaded Returns: the pointer to the initialized KFile structure if successful otherwise knull

KL_API KBool k_loadIKmixFile (  KFile *  kfile, KCString  ikmix_path )

Loads a mix. Completes the given KFile structure Parameters: kfile  the pointer to the KFile structure to be completed ikmix_path  the file path of the mix to be loaded Returns: ktrue if successful otherwise kfalse

---