SR_EventLog API functions


Detailed Description

Provides OSI logging.


Data Structures

struct  SR_EventLog

Defines

#define OSI_LOG_LEVEL_BASIC   0x01
#define OSI_LOG_LEVEL_AUDIO   0x02
#define OSI_LOG_LEVEL_ADDWD   0x04
#define SR_EventLogToken_BASIC(log, loglevel, tokenName, value)
#define SR_EventLogTokenInt_BASIC(log, loglevel, tokenName, value)
#define SR_EventLogTokenUint16_t_BASIC(log, loglevel, tokenName, value)
#define SR_EventLogTokenSize_t_BASIC(log, loglevel, tokenName, value)
#define SR_EventLogTokenBool_BASIC(log, loglevel, tokenName, value)
#define SR_EventLogTokenFloat_BASIC(log, loglevel, tokenName, value)
#define SR_EventLogEvent_BASIC(log, loglevel, eventName)
#define SR_EventLogToken_AUDIO(log, loglevel, tokenName, value)
#define SR_EventLogTokenInt_AUDIO(log, loglevel, tokenName, value)
#define SR_EventLogEvent_AUDIO(log, loglevel, eventName)

Functions

SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogCreate (SR_EventLog **self)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogDestroy (SR_EventLog *self)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogToken (SR_EventLog *self, const LCHAR *token, const LCHAR *value)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogTokenInt (SR_EventLog *self, const LCHAR *token, int value)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogTokenUint16_t (SR_EventLog *self, const LCHAR *token, asr_uint16_t value)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogTokenSize_t (SR_EventLog *self, const LCHAR *token, size_t value)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogTokenBool (SR_EventLog *self, const LCHAR *token, ESR_BOOL value)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogTokenFloat (SR_EventLog *self, const LCHAR *token, float value)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogEventSession (SR_EventLog *self)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogEvent (SR_EventLog *self, const LCHAR *eventName)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogAudioOpen (SR_EventLog *self, const LCHAR *audio_type, size_t sample_rate, size_t sample_size)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogAudioClose (SR_EventLog *self)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogAudioWrite (SR_EventLog *self, void *buffer, size_t num_bytes)
SREC_EVENTLOG_API
ESR_ReturnCode 
SR_EventLogAudioGetFilename (SR_EventLog *self, LCHAR *waveformFilename, size_t *len)


Define Documentation

#define OSI_LOG_LEVEL_ADDWD   0x04

Log ADDWORD commands.

#define OSI_LOG_LEVEL_AUDIO   0x02

Log audio data.

#define OSI_LOG_LEVEL_BASIC   0x01

OSI Event Log levels Basic logging level.

#define SR_EventLogEvent_AUDIO ( log,
loglevel,
eventName   ) 

Value:

((loglevel & OSI_LOG_LEVEL_AUDIO) ? \
   log->event(log, eventName) : ESR_SUCCESS ) \
Log an event using the audio logging level.

#define SR_EventLogEvent_BASIC ( log,
loglevel,
eventName   ) 

Value:

((loglevel & OSI_LOG_LEVEL_BASIC) ? \
   log->event(log, eventName) : ESR_SUCCESS ) \
Log an event using the basic logging level.

#define SR_EventLogToken_AUDIO ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_AUDIO) ? \
   log->token(log, tokenName, value) : ESR_SUCCESS ) \
Log a string token using the audio logging level.

#define SR_EventLogToken_BASIC ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_BASIC) ? \
   log->token(log, tokenName, value) : ESR_SUCCESS ) \
Log a string token using the basic logging level.

#define SR_EventLogTokenBool_BASIC ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_BASIC) ? \
   log->tokenBool(log, tokenName, value) : ESR_SUCCESS ) \
Log a boolean token using the basic logging level.

#define SR_EventLogTokenFloat_BASIC ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_BASIC) ? \
   log->tokenFloat(log, tokenName, value) : ESR_SUCCESS ) \
Log a float token using the basic logging level.

#define SR_EventLogTokenInt_AUDIO ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_AUDIO) ? \
   log->tokenInt(log, tokenName, value) : ESR_SUCCESS ) \
Log an integer token using the audio logging level.

#define SR_EventLogTokenInt_BASIC ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_BASIC) ? \
   log->tokenInt(log, tokenName, value) : ESR_SUCCESS ) \
Log an integer token using the basic logging level.

#define SR_EventLogTokenSize_t_BASIC ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_BASIC) ? \
   log->tokenSize_t(log, tokenName, value) : ESR_SUCCESS ) \
Log a size_t token using the basic logging level.

#define SR_EventLogTokenUint16_t_BASIC ( log,
loglevel,
tokenName,
value   ) 

Value:

((loglevel & OSI_LOG_LEVEL_BASIC) ? \
   log->tokenUint16_t(log, tokenName, value) : ESR_SUCCESS ) \
Log a uint16 token using the basic logging level.


Function Documentation

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogAudioClose ( SR_EventLog self  ) 

Closes the current file.

Parameters:
self SR_EventLog handle

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogAudioGetFilename ( SR_EventLog self,
LCHAR waveformFilename,
size_t *  len 
)

Returns the filename of the current audio file used for logging.

Parameters:
self SR_EventLog handle
waveformFilename Name of the current audio file.
len Length of buffer.

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogAudioOpen ( SR_EventLog self,
const LCHAR audio_type,
size_t  sample_rate,
size_t  sample_size 
)

Opens a new file for recording a waveform of audio. Filename is automatically generated. Opened file becomes the current one where data is written to until closed.

Parameters:
self SR_EventLog handle
audio_type String identifying type of audio e.g. L("audio/L16")
sample_rate Sampling rate
sample_size Size of sampling in bytes.

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogAudioWrite ( SR_EventLog self,
void *  buffer,
size_t  num_bytes 
)

Writes datat to the current audio file.

Parameters:
self SR_EventLog handle
buffer Buffer holding the data to write
num_bytes The number of bytes in the buffer.

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogCreate ( SR_EventLog **  self  ) 

Create a new EventLog

Parameters:
self EventLog handle

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogDestroy ( SR_EventLog self  ) 

Destroys a EventLog.

Parameters:
self EventLog handle

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogEvent ( SR_EventLog self,
const LCHAR eventName 
)

Commits all previously accumulated log tokens.

Parameters:
self SR_EventLog handle
eventName Name of the event associated with the tokens

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogEventSession ( SR_EventLog self  ) 

Log the contents of the ESR_Session.

Parameters:
self SR_EventLog handle

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogToken ( SR_EventLog self,
const LCHAR token,
const LCHAR value 
)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogTokenBool ( SR_EventLog self,
const LCHAR token,
ESR_BOOL  value 
)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogTokenFloat ( SR_EventLog self,
const LCHAR token,
float  value 
)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogTokenInt ( SR_EventLog self,
const LCHAR token,
int  value 
)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogTokenSize_t ( SR_EventLog self,
const LCHAR token,
size_t  value 
)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

SREC_EVENTLOG_API ESR_ReturnCode SR_EventLogTokenUint16_t ( SR_EventLog self,
const LCHAR token,
asr_uint16_t  value 
)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value


Generated on Thu May 1 15:37:26 2008 for SREC by  doxygen 1.5.3