k_file-rw.h File Reference

KFile structure written management functions More...

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

Functions
KL_API KStrList *	k_getAllEltsNames (KFile *pKFile)
	Gets all elements names of a KFile structure.
KL_API KBool	k_exportIKlaxFile (KFile *pKFile, KCString sPath, KAudioFormat *pFmt, KProgress *pPrg)
	Exports a KFile structure in an iKlax File.
KL_API KFile *	KFile_create (KCString sFilePath)
	Allocates a KFile structure.
KL_API KBool	k_addTag (KFile *pKFile, KCString sTag, KCString sText)
	Adds a tag and an associated text to a KFile structure.
KL_API KBool	k_delTag (KFile *pKFile, KCString sTag)
	Deletes a tag and an its associated text from a KFile structure.
KL_API KBool	KFile_setMasterLvl (KFile *pKFile, KLevel dLvl)
	Sets the volume level of the master of a KFile structure.
KL_API KBool	KFile_setMasterPan (KFile *pKFile, KDouble dPan)
	Sets the panoramization of the master of a KFile structure.

---

Detailed Description

KFile structure written management functions

Version:

iKlaxLib-1.5

Author:

Fabien Gallot

Date:

15/01/2010

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_addTag (  KFile *  pKFile, KCString  sTag, KCString  sText )

Adds a tag and an associated text to a KFile structure. Parameters: pKFile  the pointer to the KFile structure sTag  the tag to be added sText  the associated text to be added Returns: ktrue if successful otherwise kfalse

KL_API KBool k_delTag (  KFile *  pKFile, KCString  sTag )

Deletes a tag and an its associated text from a KFile structure. Parameters: pKFile  the pointer to the KFile structure sTag  the tag to be added Returns: ktrue if successful otherwise kfalse

KL_API KBool k_exportIKlaxFile (  KFile *  pKFile, KCString  sPath, KAudioFormat *  pFmt, KProgress *  pPrg )

Exports a KFile structure in an iKlax File. Parameters: pKFile  a pointer to a valid KFile structure sPath  the path to the iKlax file pFmt  a pointer to a valid KAudioFormat structure which contains the output audio format. pPrg  a pointer to a valid KProgress structure which contains the output progression values. May be null. Returns: ktrue if successful otherwise kfalse See also: KAudioFormat type in KToolLib. KProgress type in KToolLib.

KL_API KStrList* k_getAllEltsNames (  KFile *  pKFile  )

Gets all elements names of a KFile structure. Parameters: pKFile  the pointer to the KFile structure Returns: an elements names list as a pointer to a KStrList structure.

KL_API KFile* KFile_create (  KCString  sFilePath  )

Allocates a KFile structure. Parameters: sFilePath  the file path from which the KFile structure should be created Returns: the pointer to the created KFile structure if successful otherwise knull

KL_API KBool KFile_setMasterLvl (  KFile *  pKFile, KLevel  dLvl )

Sets the volume level of the master of a KFile structure. Parameters: pKFile  the pointer to the KFile structure dLvl  the volume level of the master Returns: ktrue if successful otherwise kfalse

KL_API KBool KFile_setMasterPan (  KFile *  pKFile, KDouble  dPan )

Sets the panoramization of the master of a KFile structure. Parameters: pKFile  the pointer to the KFile structure dPan  the panoramization of the master Returns: ktrue if successful otherwise kfalse

---