MloSampleBuffer.h File Reference

Sample Buffer objects. More...

#include "MloTypes.h"
#include "MloUtils.h"

Go to the source code of this file.

Data Structures

struct  MLO_SampleFormat
 Information about the encoding, memory layout, sample rate and number of channels of the PCM audio data represented by an MLO_SampleBuffer object. More...

Typedefs

typedef MLO_SampleBuffer MLO_SampleBuffer
 MLO_SampleBuffer object.

Enumerations

enum  MLO_SampleType { MLO_SAMPLE_TYPE_INTERLACED_SIGNED = 0 }
 Sample type indicating the way PCM sample values are encoded and layed out in memory. More...

Functions

MLO_Result MLO_SampleBuffer_Create (MLO_Size size, MLO_SampleBuffer **buffer)
 Create a new instance of an MLO_SampleBuffer object.
MLO_Result MLO_SampleBuffer_Destroy (MLO_SampleBuffer *self)
 Destroy an MLO_SampleBuffer object and free the resources associated with it.
const void * MLO_SampleBuffer_GetSamples (const MLO_SampleBuffer *self)
 Return a (const) pointer to the memory buffer containing the PCM audio samples encapsulated by an MLO_SampleBuffer object.
void * MLO_SampleBuffer_UseSamples (MLO_SampleBuffer *self)
 Return a pointer to the memory buffer containing the PCM audio samples encapsulated by an MLO_SampleBuffer object.
MLO_Cardinal MLO_SampleBuffer_GetSampleCount (const MLO_SampleBuffer *self)
 Return the number of audio samples encapsulated in a MLO_SampleBuffer object.
MLO_Result MLO_SampleBuffer_SetSampleCount (MLO_SampleBuffer *self, MLO_Cardinal sample_count)
 Set the number of audio samples encapsulated in a MLO_SampleBuffer object.
MLO_Size MLO_SampleBuffer_GetSize (const MLO_SampleBuffer *self)
 Return the size of the buffer encapsulated in a MLO_SampleBuffer object.
const MLO_SampleFormatMLO_SampleBuffer_GetFormat (const MLO_SampleBuffer *self)
 Return the format of the PCM samples encapsulated by an MLO_SampleBuffer object.
void MLO_SampleBuffer_SetFormat (MLO_SampleBuffer *self, const MLO_SampleFormat *format)
 Sets the format of the PCM samples encapsulated by an MLO_SampleBuffer object.


Detailed Description

Sample Buffer objects.