k_element.h File Reference

Element of iKlax File structure managment. More...

Functions
KL_API KBool	kelt_isPlaying (KFile *pFile, KCString sEltName)
	Checks if an element is playing.
KL_API KLevel	kelt_getCurrentLevel (KFile *pFile, KCString sEltName)
	Gets the current level of an element.
KL_API KLevel	kelt_getDefaultLevel (KFile *pFile, KCString sEltName)
	Gets the default level of an element.
KL_API KBool	kelt_isGroup (KFile *pFile, KCString sEltName)
	Checks if an element is a group.
KL_API KBool	kelt_isTrack (KFile *pFile, KCString sEltName)
	Checks if an element is a track.
KL_API KBool	kelt_setPano (KFile *pKFile, KCString sEltName, KDouble dPan)
	Sets a panoramisation value to an element.
KL_API KDouble	kelt_getPano (KFile *pKFile, KCString sEltName)
	Gets the relative panoramisation of an element.

---

Detailed Description

Element of iKlax File structure managment.

Version:

iKlaxLib-1.5

Author:

Fabien Gallot

Date:

02/12/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 KLevel kelt_getCurrentLevel (  KFile *  pFile, KCString  sEltName )

Gets the current level of an element. Parameters: pFile  a pointer to the KFile structure sEltName  an element name Returns: the current level value between 0.0 and 4.0

KL_API KLevel kelt_getDefaultLevel (  KFile *  pFile, KCString  sEltName )

Gets the default level of an element. Parameters: pFile  a pointer to the KFile structure sEltName  an element name Returns: the default level value between 0.0 and 4.0

KL_API KDouble kelt_getPano (  KFile *  pKFile, KCString  sEltName )

Gets the relative panoramisation of an element. Parameters: pKFile  a pointer to a valid KFile structure sEltName  an element name Returns: the element panoramisation as a value between -1.0 and 1.0

KL_API KBool kelt_isGroup (  KFile *  pFile, KCString  sEltName )

Checks if an element is a group. Parameters: pFile  a pointer to the KFile structure sEltName  an element name Returns: ktrue if the element is a group otherwise kfalse

KL_API KBool kelt_isPlaying (  KFile *  pFile, KCString  sEltName )

Checks if an element is playing. Parameters: pFile  a pointer to the KFile structure sEltName  an element name Returns: ktrue if the element is playing otherwise kfalse

KL_API KBool kelt_isTrack (  KFile *  pFile, KCString  sEltName )

Checks if an element is a track. Parameters: pFile  a pointer to the KFile structure sEltName  an element name Returns: ktrue if the element is a track otherwise kfalse

KL_API KBool kelt_setPano (  KFile *  pKFile, KCString  sEltName, KDouble  dPan )

Sets a panoramisation value to an element. Parameters: pKFile  a pointer to a valid KFile structure sEltName  an element name dPan  a panoramisation value between -1.0 and 1.0 Returns: ktrue if successful otherwise kfalse

---