Audio

The Audio API plays, records and streams audio files.

The Audio API provides features to play the following file formats: MIDI, MP3, AAC, WAV and AMR, as well as volume adjustment function. It can also record audio files in WAV and AMR format in addition to streamimg which allows you to play audio streams in PCM, AMR, AAC and MP3 formats.

Limitation

N/A

Functions

Function	Description
vm_audio_clear_interrupt_callback	Clears interrupt callback
vm_audio_get_volume	Gets the currently set volume level.
vm_audio_is_calling	Check if it is in calling now
vm_audio_is_playing	This is to check if there is another applications that is currently playing audio
vm_audio_play_close	Closes the opened audio.
vm_audio_play_get_current_time	Get the current play time.
vm_audio_play_open	Opens an audio file.
vm_audio_play_pause	Pause the audio playback.
vm_audio_play_resume	Resume audio playback
vm_audio_play_start	Plays the audio
vm_audio_play_stop	Stops the opened audio.
vm_audio_record_pause	Pause recording.
vm_audio_record_resume	Resume recording.
vm_audio_record_start	Starts recording.
vm_audio_record_stop	Stops recording.
vm_audio_register_interrupt_callback	Registers an interrupt callback. When the audio playback is interrupted, this callback will be invoked.
vm_audio_set_volume	Sets the play volume level.
vm_audio_stream_play_close	Closes the bit-stream audio.
vm_audio_stream_play_finish	Tells the driver to put no more data through.
vm_audio_stream_play_get_buffer_status	Gets the data buffer status including free buffer and total buffer size.
vm_audio_stream_play_get_play_time	Gets the current play time.
vm_audio_stream_play_open	Opens a PCM type bit-stream audio.
vm_audio_stream_play_put_data	Puts the audio data to the buffer.
vm_audio_stream_play_start	Starts to play audio.
vm_audio_stream_play_stop	Stop playing the audio.

Structs, Records, Enums

Struct, Record, Enum	Description
VM_AUDIO_DEVICE	path to play
VM_AUDIO_FORMAT	media type
vm_audio_play_parameters_t	open parameters
VM_AUDIO_RECORD_RESULT	record operation result
VM_AUDIO_RESULT	audio operation result
vm_audio_stream_play_buffer_status_t	buffer status
vm_audio_stream_play_config_t	PCM bit-stream audio configuration structure
vm_audio_stream_play_start_parameters_t	play audio parameters
VM_AUDIO_VOLUME	Audio volume level enum for 7 level volume

Types

Type	Description
VM_AUDIO_HANDLE	audio handle
vm_audio_record_result_callback	VM_AUDIO_RECORD_RESULT Record callback function.
vm_audio_result_callback	Audio callback function pointer

Links

Topics, Functions, Structs, Records, Enums, Types

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

support@toolsfactory.com.