mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-10-29 05:40:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated documentation for snd_pcm_mmap_commit()

Browse source
This commit is contained in:
Jaroslav Kysela 2001-11-28 16:51:31 +00:00
parent 095cbbb467
commit e0aaf895d8
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/pcm/pcm.c
View file

@ -4853,8 +4853,12 @@ int snd_pcm_mmap_begin(snd_pcm_t *pcm,
* \param size area portion size in frames
* \return 0 on success otherwise a negative error code
*
* To call this with offset/frames values different from that returned
* by snd_pcm_mmap_begin() has undefined effects and it has to be avoided.
* You should pass this function the offset value that
* snd_pcm_mmap_begin() returned. The frames parameter should hold the
* number of frames you have written or read to/from the audio
* buffer. The frames parameter must never exceed the configuous frames
* count that snd_pcm_mmap_begin() returned. Each call to snd_pcm_mmap_begin()
* must be followed by a call to snd_pcm_mmap_commit().
*
* Example:
\code