player.h File Reference

Player init. More...

#include <pulsar/archive/archive.h>

Go to the source code of this file.

Data Structures
struct	PLSR_PlayerConfig
	Player config. More...
struct	PLSR_PlayerSoundChannel
	Player sound channel. More...
struct	PLSR_PlayerSound
	Player sound. More...
struct	PLSR_Player
	Player. More...

Macros
#define	PLSR_PLAYER_MAX_CHANNELS   2
#define	PLSR_PLAYER_INVALID_SOUND   NULL

Typedefs
typedef const PLSR_PlayerSound *	PLSR_PlayerSoundId
	Player sound ID.

Enumerations
enum	PLSR_PlayerCategoryType {   PLSR_PlayerCategoryType_Init = 0,   PLSR_PlayerCategoryType_Load,   PLSR_PlayerCategoryType_LoadFormats,   PLSR_PlayerCategoryType_LoadLookup }
	Player method categories.

Functions
const PLSR_PlayerConfig *	plsrPlayerGetDefaultConfig (void)
	Get default player configuration.
PLSR_Player *	plsrPlayerGetInstance (void)
	Get player instance (NULL if not initialized)
PLSR_RC	plsrPlayerInitEx (const PLSR_PlayerConfig *config)
	Initialize player with a custom configuration.
NX_INLINE PLSR_RC	plsrPlayerInit (void)
	Initialize player with the default configuration.
NX_INLINE void	plsrPlayerWaitNextFrame (void)
	Convenience shortcut to wait until next audio renderer frame.
void	plsrPlayerExit (void)
	De-initialize player.
PLSR_RC	plsrPlayerPlay (PLSR_PlayerSoundId id)
	Play a loaded sound from the beginning.
PLSR_RC	plsrPlayerStop (PLSR_PlayerSoundId id)
	Stop a sound if it is currently playing.
void	plsrPlayerFree (PLSR_PlayerSoundId id)
	Free ressources used by a loaded sound.
PLSR_RC	plsrPlayerSetPitch (PLSR_PlayerSoundId id, float pitch)
	Set sound pitch factor (effective next time it's played)
PLSR_RC	plsrPlayerSetVolume (PLSR_PlayerSoundId id, float volume)
	Set sound volume factor (effective next time it's played)

Detailed Description

Player init.