k_mix.h File Reference

Mix management functions. More...

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

Functions
KL_API KBool	kmix_create (KFile *pKFile, KCString sMixName)
	Creates a mix in a KFile structure.
KL_API KBool	kmix_delete (KFile *pKFile, KCString sMixName)
	Deletes a mix from a KFile structure.
KL_API KBool	kmix_addTrack (KFile *pKFile, KCString sMixName, KCString sTrkName)
	Adds a track in a mix in a KFile structure.
KL_API KBool	kmix_removeTrack (KFile *pKFile, KCString sMixName, KCString sTrkName)
	Removes a track from a mix in a KFile structure.
KL_API KBool	kmix_setEltLevel (KFile *pKFile, KCString sMixName, KCString sEltName, KLevel dLevel)
	Sets a level value to an element in a mix in a KFile structure.
KL_API KBool	kmix_setDefault (KFile *pKFile, KCString sMixName)
	Sets a mix as the default mix in a KFile structure.
KL_API KBool	kmix_rename (KFile *pKFile, KCString sOldName, KCString sNewName)
	Renames a mix in a KFile structure.
KL_API KStrList *	kmix_getTracks (KFile *pKFile, KCString sMixName)
	Gets tracks names of a mix in a KFile structure.

---

Detailed Description

Mix 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 kmix_addTrack (  KFile *  pKFile, KCString  sMixName, KCString  sTrkName )

Adds a track in a mix in a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sMixName  a mix name sTrkName  a track name Returns: ktrue if successful otherwise kfalse

KL_API KBool kmix_create (  KFile *  pKFile, KCString  sMixName )

Creates a mix in a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sMixName  a mix name Returns: ktrue if successful otherwise kfalse

KL_API KBool kmix_delete (  KFile *  pKFile, KCString  sMixName )

Deletes a mix from a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sMixName  a mix name Returns: ktrue if successful otherwise kfalse

KL_API KStrList* kmix_getTracks (  KFile *  pKFile, KCString  sMixName )

Gets tracks names of a mix in a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sMixName  a mix name Returns: a tracks names list of the mix as a pointer to a KStrList structure.

KL_API KBool kmix_removeTrack (  KFile *  pKFile, KCString  sMixName, KCString  sTrkName )

Removes a track from a mix in a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sMixName  a mix name sTrkName  a track name Returns: ktrue if successful otherwise kfalse

KL_API KBool kmix_rename (  KFile *  pKFile, KCString  sOldName, KCString  sNewName )

Renames a mix in a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sOldName  the name of the mix to rename sNewName  the new mix name Returns: ktrue if successful otherwise kfalse

KL_API KBool kmix_setDefault (  KFile *  pKFile, KCString  sMixName )

Sets a mix as the default mix in a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sMixName  a mix name Returns: ktrue if successful otherwise kfalse

KL_API KBool kmix_setEltLevel (  KFile *  pKFile, KCString  sMixName, KCString  sEltName, KLevel  dLevel )

Sets a level value to an element in a mix in a KFile structure. Parameters: pKFile  a pointer to a valid KFile structure sMixName  a mix name sEltName  an element name dLevel  a level value Returns: ktrue if successful otherwise kfalse

---