[PATCH 22/32] docs: formatdomain-devices: Split out <sound>

Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/formatdomain-devices-sound.rst | 45 +++++++++++++++++++++++++++ docs/formatdomain-devices.rst | 47 +---------------------------- docs/meson.build | 1 + 3 files changed, 47 insertions(+), 46 deletions(-) create mode 100644 docs/formatdomain-devices-sound.rst diff --git a/docs/formatdomain-devices-sound.rst b/docs/formatdomain-devices-sound.rst new file mode 100644 index 0000000000..1f156b473c --- /dev/null +++ b/docs/formatdomain-devices-sound.rst @@ -0,0 +1,45 @@ +:anchor:`<a id="elementsSound"/>` + +Sound devices +~~~~~~~~~~~~~ + +A virtual sound card can be attached to the host via the ``sound`` element. +:since:`Since 0.4.3` + +:: + + ... + <devices> + <sound model='es1370'/> + </devices> + ... + +``sound`` + The ``sound`` element has one mandatory attribute, ``model``, which specifies + what real sound device is emulated. Valid values are specific to the + underlying hypervisor, though typical choices are 'es1370', 'sb16', 'ac97', + 'ich6' and 'usb'. ( :since:` 'ac97' only since 0.6.0, 'ich6' only since + 0.8.8, 'usb' only since 1.2.7` ) + +:since:`Since 0.9.13` , a sound element with ``ich6`` model can have optional +sub-elements ``<codec>`` to attach various audio codecs to the audio device. If +not specified, a default codec will be attached to allow playback and recording. + +Valid values are: + +- 'duplex' - advertise a line-in and a line-out +- 'micro' - advertise a speaker and a microphone +- 'output' - advertise a line-out :since:`Since 4.4.0` + +:: + + ... + <devices> + <sound model='ich6'> + <codec type='micro'/> + </sound> + </devices> + ... + +Each ``sound`` element has an optional sub-element ``<address>`` which can tie +the device to a particular PCI slot, `documented above <#elementsAddress>`__. diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index 0e4ea95d3b..acf08e8d15 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -54,52 +54,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3.9.0` .. include:: formatdomain-devices-graphics.rst .. include:: formatdomain-devices-video.rst .. include:: formatdomain-devices-chardev.rst - -:anchor:`<a id="elementsSound"/>` - -Sound devices -~~~~~~~~~~~~~ - -A virtual sound card can be attached to the host via the ``sound`` element. -:since:`Since 0.4.3` - -:: - - ... - <devices> - <sound model='es1370'/> - </devices> - ... - -``sound`` - The ``sound`` element has one mandatory attribute, ``model``, which specifies - what real sound device is emulated. Valid values are specific to the - underlying hypervisor, though typical choices are 'es1370', 'sb16', 'ac97', - 'ich6' and 'usb'. ( :since:` 'ac97' only since 0.6.0, 'ich6' only since - 0.8.8, 'usb' only since 1.2.7` ) - -:since:`Since 0.9.13` , a sound element with ``ich6`` model can have optional -sub-elements ``<codec>`` to attach various audio codecs to the audio device. If -not specified, a default codec will be attached to allow playback and recording. - -Valid values are: - -- 'duplex' - advertise a line-in and a line-out -- 'micro' - advertise a speaker and a microphone -- 'output' - advertise a line-out :since:`Since 4.4.0` - -:: - - ... - <devices> - <sound model='ich6'> - <codec type='micro'/> - </sound> - </devices> - ... - -Each ``sound`` element has an optional sub-element ``<address>`` which can tie -the device to a particular PCI slot, `documented above <#elementsAddress>`__. +.. include:: formatdomain-devices-sound.rst :anchor:`<a id="elementsWatchdog"/>` diff --git a/docs/meson.build b/docs/meson.build index 440356f7ac..c6efff8b80 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -139,6 +139,7 @@ docs_rst_files = [ 'formatdomain-devices-graphics.rst', 'formatdomain-devices-video.rst', 'formatdomain-devices-chardev.rst', + 'formatdomain-devices-sound.rst', ] }, { 'name': 'hacking' }, -- 2.26.2