SR_EventLog Struct Reference
[SR_EventLog API functions]


Detailed Description

Represents a EventLog.

Data Fields

ESR_ReturnCode(* destroy )(struct SR_EventLog_t *self)
ESR_ReturnCode(* token )(struct SR_EventLog_t *self, const LCHAR *token, const LCHAR *value)
ESR_ReturnCode(* tokenInt )(struct SR_EventLog_t *self, const LCHAR *token, int value)
ESR_ReturnCode(* tokenUint16_t )(struct SR_EventLog_t *self, const LCHAR *token, asr_uint16_t value)
ESR_ReturnCode(* tokenSize_t )(struct SR_EventLog_t *self, const LCHAR *token, size_t value)
ESR_ReturnCode(* tokenBool )(struct SR_EventLog_t *self, const LCHAR *token, ESR_BOOL value)
ESR_ReturnCode(* tokenFloat )(struct SR_EventLog_t *self, const LCHAR *token, float value)
ESR_ReturnCode(* event )(struct SR_EventLog_t *self, const LCHAR *eventName)
ESR_ReturnCode(* eventSession )(struct SR_EventLog_t *self)
ESR_ReturnCode(* audioOpen )(struct SR_EventLog_t *self, const LCHAR *audio_type, size_t sample_rate, size_t sample_size)
ESR_ReturnCode(* audioClose )(struct SR_EventLog_t *self)
ESR_ReturnCode(* audioWrite )(struct SR_EventLog_t *self, void *buffer, size_t num_bytes)
ESR_ReturnCode(* audioGetFilename )(struct SR_EventLog_t *self, LCHAR *waveformFilename, size_t *len)

Field Documentation

ESR_ReturnCode(* SR_EventLog::destroy)(struct SR_EventLog_t *self)

Destroys a EventLog.

Parameters:
self EventLog handle

ESR_ReturnCode(* SR_EventLog::token)(struct SR_EventLog_t *self, const LCHAR *token, const LCHAR *value)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

ESR_ReturnCode(* SR_EventLog::tokenInt)(struct SR_EventLog_t *self, const LCHAR *token, int value)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

ESR_ReturnCode(* SR_EventLog::tokenUint16_t)(struct SR_EventLog_t *self, const LCHAR *token, asr_uint16_t value)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

ESR_ReturnCode(* SR_EventLog::tokenSize_t)(struct SR_EventLog_t *self, const LCHAR *token, size_t value)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

ESR_ReturnCode(* SR_EventLog::tokenBool)(struct SR_EventLog_t *self, const LCHAR *token, ESR_BOOL value)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

ESR_ReturnCode(* SR_EventLog::tokenFloat)(struct SR_EventLog_t *self, const LCHAR *token, float value)

Logs an OSI log token.

Parameters:
self SR_EventLog handle
token Token name
value Token value

ESR_ReturnCode(* SR_EventLog::event)(struct SR_EventLog_t *self, const LCHAR *eventName)

Commits all previously accumulated log tokens.

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

ESR_ReturnCode(* SR_EventLog::eventSession)(struct SR_EventLog_t *self)

Log the contents of the ESR_Session.

Parameters:
self SR_EventLog handle

ESR_ReturnCode(* SR_EventLog::audioOpen)(struct SR_EventLog_t *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.

ESR_ReturnCode(* SR_EventLog::audioClose)(struct SR_EventLog_t *self)

Closes the current file.

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

ESR_ReturnCode(* SR_EventLog::audioWrite)(struct SR_EventLog_t *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.

ESR_ReturnCode(* SR_EventLog::audioGetFilename)(struct SR_EventLog_t *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.


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