Skip to content

Commit

Permalink
Update AutomatedTesting.md (#1969)
Browse files Browse the repository at this point in the history
Describe new data_paths test parameters
  • Loading branch information
philburk authored Feb 29, 2024
1 parent eb6e5aa commit ac76bf6
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions apps/OboeTester/docs/AutomatedTesting.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Boolean parameters are sent using:

For example:

--ez use_input_devices false
--ez use_input_presets false

## Parameters

Expand Down Expand Up @@ -108,15 +108,24 @@ There are several optional parameters for just the "glitch" test:
// input preset, default is "voicerec"
--es in_preset ("generic", "camcorder", "voicerec", "voicecomm", "unprocessed", "performance"}

There are several optional parameters for just the "data_paths" test:
There are several optional parameters for just the "data_paths" test. Note the Note the use of "-ez" for the boolean parameters.

--ez use_input_presets {"true", 1, "false", 0} // Whether to test various input presets. Note use of "-ez"
--ez use_input_devices {"true", 1, "false", 0} // Whether to test various input devices. Note use of "-ez"
--ez use_output_devices {"true", 1, "false", 0} // Whether to test various output devices. Note use of "-ez"
--ez use_all_output_channel_masks {"true", 1, "false", 0} // Whether to test all output channel masks. Note use of "-ez". Default is false
--ez use_input_presets {"true", 1, "false", 0} // Whether to test various input presets.
--ez use_all_sample_rates {"true", 1, "false", 0} // Whether to test all sample rates. Note use of "-ez". Default is false
--ei single_test_index {testId} // Index for testing one specific test

These parameters are used with the "data_paths" test starting with v2.5.11.

--ez use_input_channel_masks {"true", 1, "false", 0} // Whether to test the reported input channel MASKS. Default is false.
--ez use_all_channel_counts {"true", 1, "false", 0} // Whether to test all the supported channel COUNTS. Default is true.
--ei output_channel_masks_level {0, 1, 2} // Whether to test NONE=0, SOME=1, or ALL=2 channel masks. Default is false.

These parameters were used with the "data_paths" test prior to v2.5.11.

--ez use_input_devices {"true", 1, "false", 0} // Whether to test various input devices.
--ez use_output_devices {"true", 1, "false", 0} // Whether to test various output devices.
--ez use_all_output_channel_masks {"true", 1, "false", 0} // Whether to test all output channel masks. Default is false

There are some optional parameters for just the "output" test:

--es signal_type {sine, sawtooth, freq_sweep, pitch_sweep, white_noise} // type of sound to play, default is sine
Expand Down

0 comments on commit ac76bf6

Please sign in to comment.