KFile.h File Reference

KFile structure management functions More...

#include <KList.h>
#include <KCList.h>
#include <KStrList.h>
#include "iklaxlib_global.h"

Defines
#define	IKX_SONG_AUTHOR   "AUTHOR"
	Predefined music tag for author name.
#define	IKX_SONG_FEATURING   "FEATURING"
	Predefined music tag for song feature.
#define	IKX_SONG_TITLE   "TITLE"
	Predefined music tag for song title.
#define	IKX_SONG_ALBUM   "ALBUM"
	Predefined music tag for album title.
#define	IKX_SONG_YEAR   "YEAR"
	Predefined music tag for the song year.
#define	IKX_SONG_COPYRIGHT   "COPYRIGHT"
	Predefined music tag for song copyright.
#define	IKX_SONG_STYLE   "STYLE"
	Predefined music tag for song style.
#define	IKX_SONG_ITUNESLINK   "iTUNES_LINK"
	Predefined music tag for itunes link.
#define	IKX_SONG_VIDEOLINK   "VIDEO_MAIN"
	Predefined music tag for video web link.
Typedefs
typedef _KFile	KFile
	iKlax file hidden structure
Functions
KL_API void	KFile_delete (KFile **ppFile)
	Deletes a KFile structure.
KL_API KFile *	KFile_clone (KFile *kfile)
	Clones a KFile structure.
KL_API KBool	KFile_check (KFile *kfile)
	Verifies the efficiency of a KFile structure.
KL_API KInt	KFile_getConsttNb (KFile *kfile)
	Gets the constraints number of a KFile structure.
KL_API KInt	KFile_getTotalEltNb (KFile *kfile)
	Gets the total elements number of a KFile structure.
KL_API KDouble	KFile_getVersion (KFile *kfile)
	Gets the version number of a KFile structure.
KL_API KInt	KFile_getTrackNb (KFile *kfile)
	Gets the tracks number of a KFile structure.
KL_API KCString	KFile_getId (KFile *pKFile)
	Gets a copy of the ID of a KFile structure.
KL_API KCString	KFile_getFilePath (KFile *kfile)
	Gets the file name of a KFile structure.
KL_API KDouble	KFile_getLength (KFile *kfile)
	Gets the length of a file in seconds.
KL_API KInt	KFile_getPlayedEltsNb (KFile *kfile)
	Gets the elements number with playing status of a KFile structure.
KL_API KLevel	KFile_getMasterLvl (KFile *kfile)
	Gets the volume level of the master of a KFile structure.
KL_API KDouble	KFile_getMasterPan (KFile *kfile)
	Gets the panoramization of the master of a KFile structure.
KL_API KString	k_getTagValue (KFile *kfile, KCString tag)
	Gets the value of a tag of a KFile structure.
KL_API KStrList *	k_getAllUserTags (KFile *kfile)
	Gets the value of the users tag of a KFile structure.
KL_API KStrList *	k_getAllTagKeys (KFile *kfile)
	Gets the keys of all the tags of a KFile structure.
KL_API KStrList *	k_getTopElements (KFile *kfile)
	Gets the top elements of a KFile structure.
KL_API KStrList *	k_getChilds (KFile *kfile, KCString eltname)
	Gets the childs of an element in a KFile structure.
KL_API KInt	k_getLevelFamily (KFile *pKFile, KString sEltName)
	Gets the hierarchical depth of an element in a KFile structure.
KL_API KStrList *	k_getTracksNames (KFile *pKFile)
	Obtains all the tracks names of a KFile structure.

---

Detailed Description

KFile structure management 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 KStrList* k_getAllTagKeys (  KFile *  kfile  )

Gets the keys of all the tags of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the pointer to a list that contains the keys of all the tags of the given KFile structure

KL_API KStrList* k_getAllUserTags (  KFile *  kfile  )

Gets the value of the users tag of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: a list which contains all user tags and its keys

KL_API KStrList* k_getChilds (  KFile *  kfile, KCString  eltname )

Gets the childs of an element in a KFile structure. Parameters: kfile  the pointer to the KFile structure eltname  the element name Returns: the pointer to the list that contains the child element names of the given element if successful otherwise knull

KL_API KInt k_getLevelFamily (  KFile *  pKFile, KString  sEltName )

Gets the hierarchical depth of an element in a KFile structure. Parameters: pKFile  the pointer to the KFile structure sEltName  the element name Returns: the hierarchical depth of the given element if successful otherwise -1

KL_API KString k_getTagValue (  KFile *  kfile, KCString  tag )

Gets the value of a tag of a KFile structure. Parameters: kfile  the pointer to the KFile structure tag  the tag corresponding to the value to be obtained Returns: the value corresponding to the given tag if it exists otherwise knull

KL_API KStrList* k_getTopElements (  KFile *  kfile  )

Gets the top elements of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the pointer to the list that contains the names of the top elements of the given structure if successful otherwise knull. This function returns a string list.

KL_API KStrList* k_getTracksNames (  KFile *  pKFile  )

Obtains all the tracks names of a KFile structure. Parameters: pKFile  the pointer to the KFile structure Returns: the pointer to a list that contains all tracks names.

KL_API KBool KFile_check (  KFile *  kfile  )

Verifies the efficiency of a KFile structure. Parameters: kfile  the pointer to the KFile structure to be checked Returns: ktrue if the given structure is correct otherwise kfalse

KL_API KFile* KFile_clone (  KFile *  kfile  )

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

KL_API void KFile_delete (  KFile **  ppFile  )

Deletes a KFile structure. Parameters: ppFile  a reference to a KFile structure pointer

KL_API KInt KFile_getConsttNb (  KFile *  kfile  )

Gets the constraints number of a KFile structure. This function returned the number of both constraints and groups Parameters: kfile  the pointer to the KFile structure Returns: the number of constraints of the given KFile structure

KL_API KCString KFile_getFilePath (  KFile *  kfile  )

Gets the file name of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the path of the given KFile structure otherwise knull

KL_API KCString KFile_getId (  KFile *  pKFile  )

Gets a copy of the ID of a KFile structure. Parameters: pKFile  the pointer to the KFile structure Returns: the copy of the ID of the given KFile structure

KL_API KDouble KFile_getLength (  KFile *  kfile  )

Gets the length of a file in seconds. This duration corresponds to the length of the largest track by taking care of the starting delay Parameters: kfile  the pointer to the KFile structure Returns: the floating point number that represents the length of the given KFile structure

KL_API KLevel KFile_getMasterLvl (  KFile *  kfile  )

Gets the volume level of the master of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the volume level of the master

KL_API KDouble KFile_getMasterPan (  KFile *  kfile  )

Gets the panoramization of the master of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the panoramization of trhe master

KL_API KInt KFile_getPlayedEltsNb (  KFile *  kfile  )

Gets the elements number with playing status of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the elements number with playing status of the given structure

KL_API KInt KFile_getTotalEltNb (  KFile *  kfile  )

Gets the total elements number of a KFile structure. Elements : Constraints + Groups + Tracks Parameters: kfile  the pointer to the KFile structure Returns: the total elements number of the given KFile structure

KL_API KInt KFile_getTrackNb (  KFile *  kfile  )

Gets the tracks number of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the tracks number of the given KFile structure

KL_API KDouble KFile_getVersion (  KFile *  kfile  )

Gets the version number of a KFile structure. Parameters: kfile  the pointer to the KFile structure Returns: the version number of the given KFile structure

---