mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-04 13:30:08 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

rawmidi: doc - fix the framing / read mode section

Browse source 
Follow the previous changes and describe the current API.

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2021-09-22 11:13:57 +02:00
parent d3c5e9e009
commit 11f54c2774
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/rawmidi/rawmidi.c
View file

@ -118,14 +118,14 @@ hw:soundwave,1,2
hw:DEV=1,CARD=soundwave,SUBDEV=2 hw:DEV=1,CARD=soundwave,SUBDEV=2
\endcode \endcode
\section rawmidi_framing Framing of rawmidi data \section read_mode Read mode
Optionally, incoming rawmidi bytes can be put inside a frame of type snd_rawmidi_framing_tstamp_t. Optionally, incoming rawmidi bytes can be marked with timestamps. The library hides
The main current benefit is that can enable in-kernel timestamping of incoming bytes, and that the kernel implementation (linux kernel 5.14+) and exports
timestamp is likely to be more precise than what userspace can offer. the \link ::snd_rawmidi_tread() \endlink function which returns the
midi bytes marked with the identical timestamp in one iteration.
Tstamp type framing requires a kernel >= 5.14 and a buffer size that is a multiple of The timestamping is available only on input streams.
sizeof(snd_rawmidi_framing_tstamp_t). It is only available on input streams.
\section rawmidi_examples Examples \section rawmidi_examples Examples