summaryrefslogtreecommitdiff
path: root/lib/avtp_pipeline/intf_tonegen/openavb_intf_tonegen.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/avtp_pipeline/intf_tonegen/openavb_intf_tonegen.md')
-rw-r--r--lib/avtp_pipeline/intf_tonegen/openavb_intf_tonegen.md22
1 files changed, 8 insertions, 14 deletions
diff --git a/lib/avtp_pipeline/intf_tonegen/openavb_intf_tonegen.md b/lib/avtp_pipeline/intf_tonegen/openavb_intf_tonegen.md
index 6afd810a..ce0d3b12 100644
--- a/lib/avtp_pipeline/intf_tonegen/openavb_intf_tonegen.md
+++ b/lib/avtp_pipeline/intf_tonegen/openavb_intf_tonegen.md
@@ -14,17 +14,11 @@ Name | Description
-----------------------------|---------------------------
intf_nv_tone_hz | The frequency of the generated tone
intf_nv_on_off_interval_msec | How many millisecs to turn on and off the tone
-intf_nv_melody_string | A simple melody to play. When a melody string is \
- set the on/off tone hz is not used. The string \
- holds the notes in a 2 octave range with the use \
- of letters A B C D E F G a b c d e f g followed \
- by a duration of the note. For example the full \
- scale is A4B4C4D4E4F4G4a4b4c4d4e4f4g4.
-intf_nv_audio_rate | Audio rate, numberic values defined by \
- @ref avb_audio_rate_t
-intf_nv_audio_bit_depth | Bit depth of audio, numeric values defined by \
- @ref avb_audio_bit_depth_t
-intf_nv_audio_channels | Number of audio channels, numeric values should \
- be within range of values in \
- @ref avb_audio_channels_t
-
+intf_nv_melody_string | A simple melody to play. When a melody string is set the on/off tone hz is not used. The string holds the notes in a 2 octave range with the use of letters A B C D E F G a b c d e f g followed by a duration of the note. For example the full scale is A4B4C4D4E4F4G4a4b4c4d4e4f4g4.
+intf_nv_audio_rate | Audio rate, numberic values defined by @ref avb_audio_rate_t
+intf_nv_audio_bit_depth | Bit depth of audio, numeric values defined by @ref avb_audio_bit_depth_t
+intf_nv_audio_channels | Number of audio channels, numeric values should be within range of values in @ref avb_audio_channels_t
+intf_nv_audio_endian | Data endianess possible values <ul><li>big</li><li>little</li></ul>
+intf_nv_audio_channels | Number of audio channels, numeric values should be within range of values in @ref avb_audio_channels_t
+intf_nv_volume | The volune of the tone generation PCM in dB
+intf_nv_fv1 and intf_nv_fv2 | Optionally replace the last channel, or last two channels if both are defined, with fixed 32-bit sample values