vmupro_audio.h File Reference

VMUPro SDK Audio API. More...

#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Typedefs
typedef int16_t	vmupro_audio_sample_t
	Audio sample format.

Functions
bool	vmupro_audio_start_listen_mode (void)
void	vmupro_audio_exit_listen_mode (void)
	Exit audio listen mode.
int	vmupro_audio_add_stream_samples (const vmupro_audio_sample_t *samples, int count, bool applyGlobalVolume)
void	vmupro_audio_clear_ring_buffer (void)
int	vmupro_get_global_volume (void)
void	vmupro_set_global_volume (int volume)

Detailed Description

VMUPro SDK Audio API.

This header provides audio functionality for the VMUPro device.

Note

Currently only supports 44.1kHz mono audio

Audio functions are designed for real-time audio streaming

Author

8BitMods

Version

1.0.0

Date

2025-07-01

Copyright

Copyright (c) 2025 APPCAKE Limited. Distributed under the MIT License.

Definition in file vmupro_audio.h.

Typedef Documentation

vmupro_audio_sample_t

typedef int16_t vmupro_audio_sample_t

Audio sample format.

Currently only 16-bit signed samples are supported.

Examples

/home/runner/work/vmupro-sdk/vmupro-sdk/sdk/include/vmupro_audio.h.

Definition at line 30 of file vmupro_audio.h.

Function Documentation

vmupro_audio_add_stream_samples()

int vmupro_audio_add_stream_samples	(	const vmupro_audio_sample_t *	samples,
		int	count,
		bool	applyGlobalVolume
	)

Examples

/home/runner/work/vmupro-sdk/vmupro-sdk/sdk/include/vmupro_audio.h.

vmupro_audio_clear_ring_buffer()

void vmupro_audio_clear_ring_buffer

(

void

)

Examples

/home/runner/work/vmupro-sdk/vmupro-sdk/sdk/include/vmupro_audio.h.

vmupro_audio_exit_listen_mode()

void vmupro_audio_exit_listen_mode

(

void

)

Exit audio listen mode.

Stops audio streaming mode and releases audio resources. Should be called when audio streaming is no longer needed.

Note

This will stop any ongoing audio playback

Must be called after vmupro_audio_start_listen_mode() to clean up resources

Examples

/home/runner/work/vmupro-sdk/vmupro-sdk/sdk/include/vmupro_audio.h.

vmupro_audio_start_listen_mode()

bool vmupro_audio_start_listen_mode

(

void

)

Examples

/home/runner/work/vmupro-sdk/vmupro-sdk/sdk/include/vmupro_audio.h.

vmupro_get_global_volume()

int vmupro_get_global_volume

(

void

)

Examples

/home/runner/work/vmupro-sdk/vmupro-sdk/sdk/include/vmupro_audio.h.

vmupro_set_global_volume()

void vmupro_set_global_volume

(

int

volume

)

Examples

/home/runner/work/vmupro-sdk/vmupro-sdk/sdk/include/vmupro_audio.h.