Result Codes
Module: Audio / Audio Definitions / Acoustics
RESULT CODES.
Enums
| Name | |
|---|---|
| enum | Anonymous Enum 3 { MLResultAPIPrefix_Audio = ( 0x9e11 << 16) } |
| enum | MLAudioResult { MLAudioResult_NotImplemented = MLResultAPIPrefix_Audio, MLAudioResult_HandleNotFound, MLAudioResult_InvalidSampleRate, MLAudioResult_InvalidBitsPerSample, MLAudioResult_InvalidValidBits, MLAudioResult_InvalidSampleFormat, MLAudioResult_InvalidChannelCount, MLAudioResult_InvalidBufferSize, MLAudioResult_BufferNotReady, MLAudioResult_FileNotFound, MLAudioResult_FileNotRecognized, MLAudioResult_ResourceNotFound, MLAudioResult_ResourceDiscarded, MLAudioResult_OperationUnavailable, MLAudioResult_OperationNotReady, MLAudioResult_InternalConfigError, MLAudioResult_Ensure32Bits = 0x7FFFFFFF } Return values for Audio Service API calls. |
Functions
| Name | |
|---|---|
| const char * | MLAudioGetResultString(MLResult result_code) Returns an ASCII string for each result code. |
Enums Documentation
Anonymous Enum 3
| Enumerator | Value | Description |
|---|---|---|
| MLResultAPIPrefix_Audio | ( 0x9e11 << 16) | Defines the prefix for MLAudioResult codes. |
MLAudioResult
| Enumerator | Value | Description |
|---|---|---|
| MLAudioResult_NotImplemented | MLResultAPIPrefix_Audio | Function not implemented. |
| MLAudioResult_HandleNotFound | Not a valid MLHandle for a sound or input. | |
| MLAudioResult_InvalidSampleRate | Sample rate not supported. | |
| MLAudioResult_InvalidBitsPerSample | Bits per sample not supported. | |
| MLAudioResult_InvalidValidBits | Valid bits per sample not supported. | |
| MLAudioResult_InvalidSampleFormat | Sample format not supported. | |
| MLAudioResult_InvalidChannelCount | Channel count not supported. | |
| MLAudioResult_InvalidBufferSize | Buffer size too small. | |
| MLAudioResult_BufferNotReady | Buffer not ready for read or write. | |
| MLAudioResult_FileNotFound | Specified file not found. | |
| MLAudioResult_FileNotRecognized | Specified file has unsupported format. | |
| MLAudioResult_ResourceNotFound | Specified resource is not on the list. | |
| MLAudioResult_ResourceDiscarded | Data was unloaded or file was closed. | |
| MLAudioResult_OperationUnavailable | Requested operation not possible for given item. | |
| MLAudioResult_OperationNotReady | Requested operation has not yet been processed. | |
| MLAudioResult_InternalConfigError | Internal configuration problem was detected. | |
| MLAudioResult_Ensure32Bits | 0x7FFFFFFF | Ensure enum is represented as 32 bits. |
Return values for Audio Service API calls.
API Level:
- 4
Functions Documentation
MLAudioGetResultString
const char * MLAudioGetResultString(
MLResult result_code
)
Returns an ASCII string for each result code.
Parameters
| MLResult | result_code | MLResult to be converted. |
MLResult and MLAudioResult codes are converted to more detailed descriptions.
Return: ASCII string containing readable version of result code.