KMixFileMng.h File Reference

This file contains functions used to manage mix files and KFile structure. More...

#include "iklaxlib_global.h"
#include "KFile.h"

Typedefs
typedef _KMixFileMng	KMixFileMng
	Mix files directory management hidden structure.
Functions
KL_API KMixFileMng *	KMixFileMng_new ()
	Creates and initializes a KMixFileMng structure.
KL_API void	KMixFileMng_delete (KMixFileMng **ppMFM)
	Deletes a KMixFileMng structure.
KL_API KBool	KMixFileMng_setIKmixDir (KMixFileMng *pMFM, KCString sDirPath)
	Sets a directory for the mix files.
KL_API KFile *	KMixFileMng_openIKlax (KMixFileMng *pMFM, KCString sIKlaxFilePath)
	Opens an iKlax file and loads its mixes.
KL_API KBool	KMixFileMng_closeIKlax (KMixFileMng *pMFM)
	Closes an iKlax file.
KL_API KBool	KMixFileMng_isAuthorMix (KMixFileMng *pMFM, KCString sMixName)
	Says if the given mix is an author mix in an opened file.
KL_API KFile *	KMixFileMng_getKFile (KMixFileMng *pMFM)
	Gets the KFile structure associated to the given KMixFileMng.

---

Detailed Description

This file contains functions used to manage mix files and KFile structure.

The specifity of this object is an automatic loading of iKmix files. If you set a directory to this object, it will can:

• scan the directory and load all iKmix files corresponding to an iKlax file
• remember, with a settings file, all iKmix files path which aren't in the directory

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 KMixFileMng_closeIKlax (  KMixFileMng *  pMFM  )

Closes an iKlax file. Saves its non-author mixes in the mix files directory Parameters: pMFM  the pointer to the KMixFileMng structure Returns: ktrue if successful otherwise kfalse

KL_API void KMixFileMng_delete (  KMixFileMng **  ppMFM  )

Deletes a KMixFileMng structure. Parameters: ppMFM  a reference to a KMixFileMng structure pointer

KL_API KFile* KMixFileMng_getKFile (  KMixFileMng *  pMFM  )

Gets the KFile structure associated to the given KMixFileMng. Parameters: pMFM  the pointer to the KMixFileMng structure Returns: the pointer to the KFile structure if successful otherwise knull

KL_API KBool KMixFileMng_isAuthorMix (  KMixFileMng *  pMFM, KCString  sMixName )

Says if the given mix is an author mix in an opened file. Parameters: pMFM  the pointer to the KMixFileMng structure sMixName  the name of the mix Returns: ktrue if the given mix is an author one otherwise kfalse

KL_API KMixFileMng* KMixFileMng_new (   )

Creates and initializes a KMixFileMng structure. Returns: the pointer to the created and initialized KMixFileMng structure if successful otherwise knull

KL_API KFile* KMixFileMng_openIKlax (  KMixFileMng *  pMFM, KCString  sIKlaxFilePath )

Opens an iKlax file and loads its mixes. The loaded mixes are found in the mix files directory Parameters: pMFM  the pointer to the KMixFileMng structure sIKlaxFilePath  the path of the file to be opened Returns: the pointer to the KFile structure if successful otherwise knull

KL_API KBool KMixFileMng_setIKmixDir (  KMixFileMng *  pMFM, KCString  sDirPath )

Sets a directory for the mix files. Parameters: pMFM  the pointer to the KMixFileMng structure sDirPath  the path of the directory Returns: ktrue if successful otherwise kfalse

---