2025.3 Add-on API changes

[NVDA Add-on API Announcements]

Reminder, this mailing list is read only, please provide feedback by replying directly to emails, or via GitHub.
This list is intended to notify of changes to the add-on API, for confirmation of the latest state for breakages or deprecations, please refer to the 'changes file' for the NVDA release you are interested in.
To review NVDAs add-on API compatibility process, refer to the latest version of the developer guide.

Add-on API changes have been merged, planned for inclusion in the 2025.3 release:
"Fix SAPI5 #18300"

If API breaks or planned future breaks (deprecations) will cause difficulties for the ongoing development of an add-on you maintain, please let NVDA developers know by replying directly to emails, or via GitHub.

Deprecations:

• The following symbols in synthDrivers.sapi5 are deprecated with no replacement:
  
  •   LP_c_ubyte
  •   LP_c_ulong
  •   LP__ULARGE_INTEGER
  •   SynthDriver.isSpeaking

[NVDA Add-on API Announcements]

Add-on API changes have been merged, planned for inclusion in the 2025.3 release:

"Encapsulate registry keys more consistently #18608"

If API breaks or planned future breaks (deprecations) will cause difficulties for the ongoing development of an add-on you maintain, please let NVDA developers know by replying directly to emails, or via GitHub.

Deprecations:

• easeOfAccess.RegistryKey and config.RegistryKey is deprecated, use config.registry.RegistryKey instead.
  

[NVDA Add-on API Announcements]

Add-on API changes have been merged, planned for inclusion in the 2025.3 release:

"preserve tabs in codefences #18638"

If API breaks or planned future breaks (deprecations) will cause difficulties for the ongoing development of an add-on you maintain, please let NVDA developers know by replying directly to emails, or via GitHub.

Deprecations:

• Importing DEFAULT_EXTENSIONS from md2html is deprecated. Importing from md2html is discouraged.

[NVDA Add-on API Announcements]

2025.3beta1 has been released.

API Status:

The add-on API for 2025.3 has entered feature freeze. Development is now focused on bug fixes. The core API functionality for this release has been established, and most changes introduced from this point should be minor and non-breaking. The API will be finalised with the 2025.3rc1 release, barring any emergency exceptions.

Action Items for Add-on Authors:

1. Test your add-ons against the 2025.3 API using 2025.3beta1
2. Consider publishing a beta/dev release to the Add-on Store for user testing

[NVDA Add-on API Announcements]

2025.3beta2 has been released.

API Status:

This is the last planned beta for 2025.3. The add-on API has now entered API freeze. Only critical changes will be considered before the API is finalised with 2025.3rc1.

Action Items for Add-on Authors:

1. Perform final testing of your add-ons with 2025.3beta2
2. Submit beta/dev releases to the Add-on Store for user testing
3. Prepare stable releases for the upcoming RC

[NVDA Add-on API Announcements]

2025.3rc1 has been released.

API Status:

The add-on API for 2025.3 is now final.

Action Items for Add-on Authors

1. Complete final testing with 2025.3rc1
2. Release add-ons marked as compatible with the 2025.3 API
3. Submit compatible add-ons to the Add-on Store's stable channel