k_soundout.h File Reference

This file contains functions to play an iKlax file. More...

Enumerations
enum	ESOLoop { IKX_NO_LOOP = 0, IKX_SIMPLE_LOOP = 1, IKX_RANDOM_LOOP = 2 }
	Loop enumeration. More...
enum	ESOMixLevel {   KSO_MXL_VERYUP, KSO_MXL_UP, KSO_MX_DEF, KSO_MX_DOWN,   KSO_MX_VERYDOWN }
	An enumerator to control mix level. More...
enum	ESOPriority { KSO_PRIORITY_MAX, KSO_PRIORITY_MIN, KSO_PRIORITY_MIDDLE }
	An enumerator to control sound out thread priority. More...
Functions
KL_API KBool	so_play (KFile *file, KProgress *kProg)
	Launches the playing.
KL_API KBool	so_init ()
	Initializes the audio card.
KL_API KBool	so_close ()
	Closes the audio card.
KL_API KBool	so_pause ()
	Puts the playing in a pause state.
KL_API KBool	so_stop ()
	Stops the playing.
KL_API KBool	so_setVolume (KDouble v)
	Sets a new general volume.
KL_API KDouble	so_getVolume ()
	Gets the general volume.
KL_API KBool	so_setLoop (ESOLoop tLoop)
	Sets the loop mode.
KL_API KBool	so_setTime (KDouble t)
	Continues the reading from a new date. This function has an effect only in playing or pause mode.
KL_API KDouble	so_getTime (KFile *file)
	Gets the current time.
KL_API KBool	so_isLoop ()
	Indicates if the mode repeat is active.
KL_API KBool	so_isPlay ()
	Indicates if the state is playing or pause.
KL_API KBool	so_isPause ()
	Indicates if the state is pause.
KL_API KBool	so_setMasterPan (const KDouble pan)
	Sets the general panoramization.
KL_API KDouble	so_getMasterPan ()
	Gets the general panoramization.
KL_API KInt	so_getRealTime ()
	Gets the time in seconds.
KL_API void	so_set_mix_level (ESOMixLevel eMixLvl)
	Controls the mix level.
KL_API void	so_set_priority (ESOPriority ePriority)
	Sets the priority of the sound out thread.

---

Detailed Description

This file contains functions to play an iKlax file.

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.

---

Enumeration Type Documentation

enum ESOLoop

Loop enumeration. Enumeration values: IKX_NO_LOOP  No loop. IKX_SIMPLE_LOOP  Classic loop. IKX_RANDOM_LOOP  Loop with random on track states and levels.

enum ESOMixLevel

An enumerator to control mix level. Enumeration values: KSO_MXL_VERYUP  Up the mix level very up. KSO_MXL_UP  Up the mix level. KSO_MX_DEF  Stay the default mix level. KSO_MX_DOWN  Down the mix level. KSO_MX_VERYDOWN  Down the mix level very down.

enum ESOPriority

An enumerator to control sound out thread priority. Enumeration values: KSO_PRIORITY_MAX  Max priority. KSO_PRIORITY_MIN  Min priority. KSO_PRIORITY_MIDDLE  Middle priority.

---

Function Documentation

KL_API KBool so_close (   )

Closes the audio card. Returns: ktrue if successful otherwise kfalse

KL_API KDouble so_getMasterPan (   )

Gets the general panoramization. The sound card must be initialized before calling this function with the so_init function Returns: the general panoramization value between -1.0 for 100% left and 1.0 fot 100% right.

KL_API KInt so_getRealTime (   )

Gets the time in seconds. The sound card must be initialized before calling this function with the so_init function Returns: the time in seconds

KL_API KDouble so_getTime (  KFile *  file  )

Gets the current time. The sound card must be initialized before calling this function with the so_init function Parameters: file  the pointer to the KFile structure Returns: the current time between 0.0 and 1.0

KL_API KDouble so_getVolume (   )

Gets the general volume. The sound card must be initialized before calling this function with the so_init function Returns: the general volume between 0.0 and 1.0 if successful otherwise a negative floating point number

KL_API KBool so_init (   )

Initializes the audio card. Returns: ktrue if successful otherwise kfalse

KL_API KBool so_isLoop (   )

Indicates if the mode repeat is active. The sound card must be initialized before calling this function with the so_init function Returns: ktrue if the mode repeat is active (mode IKX_SIMPLE_LOOP or IKX_RANDOM_LOOP, otherwise kfalse

KL_API KBool so_isPause (   )

Indicates if the state is pause. The sound card must be initialized before calling this function with the so_init function Returns: ktrue if the state is pause otherwise kfalse

KL_API KBool so_isPlay (   )

Indicates if the state is playing or pause. The sound card must be initialized before calling this function with the so_init function Returns: ktrue if the state is playing otherwise kfalse

KL_API KBool so_pause (   )

Puts the playing in a pause state. If the playing is already in pause, puts it in play state The sound card must be initialized before calling this function with the so_init function Returns: ktrue if successful otherwise kfalse

KL_API KBool so_play (  KFile *  file, KProgress *  kProg )

Launches the playing. The sound card must be initialized before calling this function with the so_init function Parameters: file  the pointer to the KFile structure kProg  the pointer to the KProgress structure (can be null). See KToolLib Documentation for more information about KProgress structure. Returns: ktrue if successful otherwise kfalse

KL_API void so_set_mix_level (  ESOMixLevel  eMixLvl  )

Controls the mix level. The sound card must be initialized before calling this function with the so_init function Parameters: eMixLvl  a value of ESOMixLevel enum

KL_API void so_set_priority (  ESOPriority  ePriority  )

Sets the priority of the sound out thread. The sound card must be initialized before calling this function with the so_init function Parameters: ePriority  an ESOPriority enum value

KL_API KBool so_setLoop (  ESOLoop  tLoop  )

Sets the loop mode. The sound card must be initialized before calling this function with the so_init function Parameters: tLoop  an ESOLoop code Returns: ktrue if successful otherwise kfalse

KL_API KBool so_setMasterPan (  const KDouble  pan  )

Sets the general panoramization. The sound card must be initialized before calling this function with the so_init function Parameters: pan  the new general panoramization value between -1.0 for 100% left and 1.0 fot 100% right. Returns: ktrue if successful otherwise kfalse

KL_API KBool so_setTime (  KDouble  t  )

Continues the reading from a new date. This function has an effect only in playing or pause mode. The sound card must be initialized before calling this function with the so_init function Parameters: t  the new date Returns: ktrue if successful otherwise kfalse

KL_API KBool so_setVolume (  KDouble  v  )

Sets a new general volume. The sound card must be initialized before calling this function with the so_init function Parameters: v  the new general volume, between 0.0 and 1.0 Returns: ktrue if successful otherwise kfalse

KL_API KBool so_stop (   )

Stops the playing. The sound card must be initialized before calling this function with the so_init function Returns: ktrue if successful otherwise kfalse

---