Added more descriptions for offset/size values for mmap access functions

This commit is contained in:
Jaroslav Kysela 2001-11-05 08:13:18 +00:00
parent 250be2be98
commit d9dfe8f023

View file

@ -4304,8 +4304,8 @@ void snd_pcm_info_set_stream(snd_pcm_info_t *obj, snd_pcm_stream_t val)
* \brief Application request to access a portion of direct (mmap) area
* \param pcm PCM handle
* \param areas Returned mmap channel areas
* \param offset Returned mmap area offset
* \param size mmap area portion size (wanted on entry, contiguous available on exit)
* \param offset Returned mmap area offset in bits
* \param size mmap area portion size in frames (wanted on entry, contiguous available on exit)
* \return 0 on success otherwise a negative error code
*
* The function should be called before a sample-direct area can be accessed.
@ -4345,6 +4345,8 @@ int snd_pcm_mmap_begin(snd_pcm_t *pcm,
/**
* \brief Application has completed the access to area requested with #snd_pcm_mmap_begin
* \param pcm PCM handle
* \param offset area offset in bits
* \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