changeset 130:1c529bb31219

doc/EFR-library-API: explain dtx argument to EFR_encoder_reset()
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 11 Dec 2022 04:11:57 +0000
parents b722fcb52926
children 615f144b52c6
files doc/EFR-library-API
diffstat 1 files changed, 5 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/EFR-library-API	Sun Dec 11 04:02:00 2022 +0000
+++ b/doc/EFR-library-API	Sun Dec 11 04:11:57 2022 +0000
@@ -180,3 +180,8 @@
 decoder itself when it encounters the ETSI-prescribed decoder homing frame.
 Therefore, there is generally no need for libgsmefr users to call these
 functions directly - but they are made public for the sake of completeness.
+
+If you call EFR_encoder_reset() manually, you can change the DTX enable/disable
+flag from its initial value given to EFR_encoder_create() - the new value of
+this flag passed to EFR_encoder_reset() always takes effect.  There is no
+provision for changing this mode within an encoder session without a full reset.