psai API Reference  1.5
Classes | Enumerations
psai Namespace Reference

Classes

struct  SegmentInfo
 The SegmentInfo struct is used to query information about the Segment with the given id. More...
 
struct  ThemeInfo
 The ThemeInfo struct is used to query information about the Theme with the given id. More...
 
struct  PsaiInfo
 The PsaiInfo struct is used to retrieve information about psai's momentary internal state. More...
 
class  SoundtrackInfo
 The SoundtrackInfo struct is used to retrieve information about the psai Soundtrack currently loaded. More...
 
class  PsaiCore
 All of psai's functionality can be accessed using an instance of psai::PsaiCore. More...
 

Enumerations

enum  PSAI_RESULT {
  PSAI_OK, PSAI_RC_ALREADY_ACTIVE, PSAI_RC_BADCOMMAND, PSAI_RC_CHANNEL_ALLOC_FAILED,
  PSAI_RC_CHANNEL_STOLEN, PSAI_RC_FILE_ERROR, PSAI_RC_FILE_COULDNOTSEEK, PSAI_RC_FILE_DISKEJECTED,
  PSAI_RC_FILE_EOF, PSAI_RC_FILE_NOTFOUND, PSAI_RC_FORMAT_ERROR, PSAI_RC_INITIALIZATION_ERROR,
  PSAI_RC_INTERNAL_ERROR, PSAI_RC_INVALID_HANDLE, PSAI_RC_INVALID_PARAM, PSAI_RC_MEMORY_ERROR,
  PSAI_RC_NOTREADY, PSAI_RC_CREATEBUFFER_FAILED, PSAI_OUTPUT_FORMAT_ERROR, PSAI_RC_OUTPUT_INIT_FAILED,
  PSAI_RC_OUTPUT_FAILURE, PSAI_RC_UPDATE_ERROR, PSAI_RC_WRONG_VERSION, PSAI_RC_UNKNOWN_THEME,
  PSAI_RC_ESSENTIAL_SEGMENT_MISSING, PSAI_RC_COMMAND_IGNORED, PSAI_RC_TRIGGER_DENIED, PSAI_RC_TRIGGER_IGNORED_FOLLOWING_THEME_ALREADY_SET,
  PSAI_RC_TRIGGER_IGNORED_LOW_PRIORITY, PSAI_RC_COMMAND_IGNORED_MENU_MODE_ACTIVE, PSAI_RC_COMMAND_IGNORED_CUTSCENE_ACTIVE
}
 The result codes returned by various psai methods. More...
 
enum  LogLevel {
  PSAI_LOGLEVEL_OFF = 0, PSAI_LOGLEVEL_FATAL, PSAI_LOGLEVEL_ERROR, PSAI_LOGLEVEL_WARN,
  PSAI_LOGLEVEL_INFO, PSAI_LOGLEVEL_DEBUG, PSAI_LOGLEVEL_ALL
}
 The level of debug output written to the psai.log file. More...
 
enum  ThemeType {
  THEMETYPE_NULL = 0, THEMETYPE_BASIC_MOOD = 1, THEMETYPE_BASIC_MOOD_ALTERATION = 2, THEMETYPE_ACTION_EVENT = 3,
  THEMETYPE_SHOCK_EVENT = 5, THEMETYPE_HIGHLIGHT_LAYER = 6, THEMETYPE_DRAMATICEVENT = 7
}
 Enumeration of psai's Theme Types. More...
 
enum  SegmentSuitability {
  SEGMENTSUITABILITY_NULL = 0, SEGMENTSUITABILITY_START = 1, SEGMENTSUITABILITY_MIDDLE = 2, SEGMENTSUITABILITY_END = 4,
  SEGMENTSUITABILITY_BRIDGE = 8, SEGMENTSUITABILITY_WHATEVER = 15
}
 Enumeration of flags that denote a Segment's suitability for various playback positions within their Theme. More...
 
enum  PsaiState { PSAISTATE_NOTREADY = 0, PSAISTATE_SILENCE, PSAISTATE_PLAYING, PSAISTATE_REST }
 Enumeration of psai's error handling options. More...
 

Enumeration Type Documentation

The level of debug output written to the psai.log file.

psai::See PsaiCore::setLogLevel().

Enumerator
PSAI_LOGLEVEL_OFF 
PSAI_LOGLEVEL_FATAL 
PSAI_LOGLEVEL_ERROR 
PSAI_LOGLEVEL_WARN 
PSAI_LOGLEVEL_INFO 
PSAI_LOGLEVEL_DEBUG 
PSAI_LOGLEVEL_ALL 

The result codes returned by various psai methods.

Enumerator
PSAI_OK 
PSAI_RC_ALREADY_ACTIVE 
PSAI_RC_BADCOMMAND 
PSAI_RC_CHANNEL_ALLOC_FAILED 
PSAI_RC_CHANNEL_STOLEN 
PSAI_RC_FILE_ERROR 
PSAI_RC_FILE_COULDNOTSEEK 
PSAI_RC_FILE_DISKEJECTED 
PSAI_RC_FILE_EOF 
PSAI_RC_FILE_NOTFOUND 
PSAI_RC_FORMAT_ERROR 
PSAI_RC_INITIALIZATION_ERROR 
PSAI_RC_INTERNAL_ERROR 
PSAI_RC_INVALID_HANDLE 
PSAI_RC_INVALID_PARAM 
PSAI_RC_MEMORY_ERROR 
PSAI_RC_NOTREADY 
PSAI_RC_CREATEBUFFER_FAILED 
PSAI_OUTPUT_FORMAT_ERROR 
PSAI_RC_OUTPUT_INIT_FAILED 
PSAI_RC_OUTPUT_FAILURE 
PSAI_RC_UPDATE_ERROR 
PSAI_RC_WRONG_VERSION 
PSAI_RC_UNKNOWN_THEME 
PSAI_RC_ESSENTIAL_SEGMENT_MISSING 
PSAI_RC_COMMAND_IGNORED 
PSAI_RC_TRIGGER_DENIED 
PSAI_RC_TRIGGER_IGNORED_FOLLOWING_THEME_ALREADY_SET 
PSAI_RC_TRIGGER_IGNORED_LOW_PRIORITY 
PSAI_RC_COMMAND_IGNORED_MENU_MODE_ACTIVE 
PSAI_RC_COMMAND_IGNORED_CUTSCENE_ACTIVE 

Enumeration of psai's error handling options.

See psai::PsaiCore::setErrorHandling()

Enumerator
PSAISTATE_NOTREADY 
PSAISTATE_SILENCE 
PSAISTATE_PLAYING 
PSAISTATE_REST 

Enumeration of flags that denote a Segment's suitability for various playback positions within their Theme.

Enumerator
SEGMENTSUITABILITY_NULL 
SEGMENTSUITABILITY_START 
SEGMENTSUITABILITY_MIDDLE 
SEGMENTSUITABILITY_END 
SEGMENTSUITABILITY_BRIDGE 
SEGMENTSUITABILITY_WHATEVER 

Enumeration of psai's Theme Types.

Enumerator
THEMETYPE_NULL 
THEMETYPE_BASIC_MOOD 
THEMETYPE_BASIC_MOOD_ALTERATION 
THEMETYPE_ACTION_EVENT 
THEMETYPE_SHOCK_EVENT 
THEMETYPE_HIGHLIGHT_LAYER 
THEMETYPE_DRAMATICEVENT