---
source: sighthound-developer-portal
url: https://dev.sighthound.com/redactor/docs/release-notes-5/
markdown-url: https://dev.sighthound.com/redactor/docs/release-notes-5.md
title: "Redactor 5.x Release Notes"
description: "Archive of Sighthound Redactor 5.x release notes."
content-type: text/markdown
---
> For AI agents: a documentation index is available at [llms.txt](https://dev.sighthound.com/llms.txt). Markdown versions are available at matching `.md` URLs.
# Redactor 5.x Release Notes
Redactor changelog archive
Historical Redactor 5.x updates, fixes, and API changes. Return to [latest release notes](release-notes.md).
## 5.2.13 - August 8, 2024
##### Updates
- Custom metadata presentation support added.
- (API) Legacy `processConfig` options supported again to mitigate error handling/crashes caused by this.
- (API) Custom metadata resolution on intake.
- Show "picture" icon over thumbnail on Projects page when media is an image.
- Video list action buttons are disabled when video is in Use.
- Contact Support modal wording and layout changed.
##### Bug Fixes
- (API) Use filename from Content-Disposition header if available by the server.
- Modifying static boxes now only shows _Apply_ and _Cancel_ buttons.
- v5.2.12 introduced an issue with displaying the list of videos in the Admin Videos section.
- (API) v5.2.12 introduced an issue with applying ACL
## 5.2.12 - July 16, 2024
##### New Features
- (API) Ad-hoc, static redaction regions can now be defined in the API request body as part of the renderConfig in `redactionTransientData`. These regions will be overlaid with any other existing redactions, but they will not be persisted like other redaction regions. This is useful for redacting known areas of a video like timestamps or logos. The transient redaction coordinates can be specified as either absolute pixels or relative percentages of the video's dimensions [0...1]. See the example below for more details.
```json
{
"inputUri": "https://127.0.0.1:60750/media/small.mp4",
"features": [
"FACE_DETECTION",
"LICENSE_PLATE_DETECTION",
"MEDIA_RENDER",
"STATE_DROP"
],
"videoContext": {
"renderConfig": {
"redactionIntensity": "MEDIUM",
"redactionShape": "ELLIPSE",
"redactionStyle": "BLUR",
"videoPreset": "FAST",
"videoQuality": 0.55,
"redactionTransientData": {
"static": [
{
"x": 8,
"y": 4,
"width": 32,
"height": 16
},
{
"x": 0.9,
"y": 0.95,
"width": 0.098,
"height": 0.075,
"relative": true
}
]
}
}
},
"outputUri": "file:///C:/example/my-bucket/redacted.mp4",
}
```
- (Embedded UI) Initial work was completed to use an iframe to display the editor from an HTML page hosted on the Redactor server. The current embedded UI integration guidance lives in the [Embedded Redactor UI tutorial](../examples/embedded-ui.md) and [deployment reference](../examples/embedded-ui-deployment.md).
##### Updates
- (Server) The download filename no longer contains the session id as a prefix.
- Show confirmation dialog when a user attempts to remove a video on the Projects page.
##### Bug Fixes
- (Server) The filename for the redacted download was incorrectly missing the original filename.
## 5.2.11 - July 11, 2024
##### New Features
- (API) Metadata can now be provided in prepareConfig. Use `etc_media_title` to set the display name of the media in the Projects page and for export name purposes. If not provided, the display name will be the filename.
```json
"prepareConfig": {
"metadata": {
"etc_media_title": "my custom title",
}
}
```
- (API) Allow a custom “Save” button to be displayed in the normal Redactor Server UI. This feature works alongside the new browser event webhook mentioned below and will emit events when a user clicks the Save button. This could be used by your team to signal the user's intent to push the redacted video to your backend service.
- (API) Redactor server can send certain browser events to a webhook which is specified via ENV or in an API request body during MEDIA_PREPARE. Full documentation and an example will be added to this site soon. To specify the webhook via ENV, set a System environment variable `REDACTOR_EVENT_WEBHOOK` (E.g. `REDACTOR_EVENT_WEBHOOK=http://127.0.0.1:7737/`). Or, to specify the webhook via API request body, use the `etc_event_webhook` item in the `prepareConfig.metadata` object:
```json
"videoContext": {
"prepareConfig": {
"metadata": {
"etc_event_webhook": "http://127.0.0.1:7737/",
"etc_customize": {
"export": {
"download": "hide",
"save": "close"
},
"session": {
"remove": "hide",
"deleteRedactionData": "show"
}
},
"etc_media_title": "my custom title"
}
}
},
```
##### Updates
- Display an error message if the in-app "Contact Support" function does not submit properly. This is typically only an issue for those with a Redactor server behind a restrictive firewall.
- Show confirmation dialog when a user attempts to delete redaction data from a video on the Projects page.
- (Embedded UI) Saving image from current video frame now works when using Shadow DOM
##### Bug Fixes
- Timestamps and tick marks in audio waveform were not always visible.
- The path used for the last export was not being remembered in the desktop version.
## 5.2.9 - June 10, 2024
##### New Features
- (API) Synchronize a redaction session's data with a different bucket/location. If a session:// is given for the input URI and a bucket for the output URI, the entire state of the session will be saved to the outputUri. This is useful if you want to create a backup of the session data or move it off the server/S3/Azure before shutting it down. You will be able to restore the session from the data stored in the outputUri.
- Safari browser is now supported. We haven’t used that browser in the past, so if you find rare glitches on your end please let us now. Tested against the latest Safari 17.4.1 (MacOS 14.4.1 on M1).
##### Updates
- (API) Improved bucket synchronization efficiency: The manifest.json left in buckets now contains checksums will avoid media files being retransmitted if they already exist on the server.
- (API) forceConversion also enabled by default in the API. It is still possible to disable conversion at MEDIA_PREPARE via forceConversion: false if needed, but we recommend to convert always, since it fixes a lot of glitches we’ve seen in the past due to irregular video data, in a broad sense.
- (API) Context menu enabled and can be customized by the Redactor embedded API constructor call.
- (Embedded UI) Console output can now be filtered by a log level and the messages prefixed for distinct handling, configurable in the SighthoundRedactorEditor constructor options.
- (Embedded UI) Made the SighthoundRedactorEditor.cleanup() async so it’s safe to continue when the editor is truly closed; this was possible before for initiating it and then wait for the exit event, yet the promise is an integrated and a more convenient choice
- Websockets connectivity improved. In case of connection loss, resumption should be transparent and non-interruptive for an active user session, up to a certain timeout or a server restart. Pending messages will be replayed.
- Windows Installer didn’t store custom port numbers on fresh installs. This only happened when no former data directory existed. Now it gets created first thing.
##### Bug Fixes
- (Embedded UI) Download and preview links in the video list were broken. In case downloadOnly is used for redirecting downloads the associated event now carries the URL which would have been used directly.
- (Embedded UI) The renderConfig event wasn’t truly reflecting all of the choices possible in the export dialog.
- (API) Audio waveform package's global instance prevented the script from being reloaded.
- (API) maskAudio regions provided in the renderConfig was removing custom audio regions. This has been adjusted and the regions are now rendered correctly.
- Audio mute button didn’t restore the formerly set volume.
- Scrollbars were always showing in audio transcripts for Chrome & Edge browsers.
- Image loading didn’t clear the progress dialog.
- Export save path wasn’t remembered in the desktop version.
## 5.2.1 - April 18, 2024
##### New Features
- (Embedded UI) “Save” button option for embedded UI.
- (Embedded UI) Download Event - redactor.export.download event is emitted when users click either of the Download buttons and it includes the `sessionId` for the selected video.
- Set REDACTOR_DIAG_PROBE_MODE default to “always”.
- (API) /api/v11/videos:list endpoint to get an array of videos loaded into Redactor and their “rendered” status. It can be filtered based on sessionId or projectId.
- (Embedded UI) Add configurable “Save” button to Projects page items
- Allow specifying different outputUri for API calls using `session://` as `inputUri`. The outputUri can be different than those used (if provided) in the initial MEDIA_PREPARE call.
- New "/api/v11/videos:list" endpoint to query a list of videos loaded into Redactor. It can be filtered based on sessionId or projectId.
- FFprobe is run for all imported videos and results are logged.
##### Updates
- Improve the (optional) ignoring of SSL certificate errors for video imports from remote resources.
- (Embedded UI) Scramble intensity events are now emitted in redactor.export.submit event in “maskAudioParams”. Intensity value will be either LOW, MEDIUM, or HIGH.
##### Bug Fixes
- (API) The timeout for internal API operations has been removed. Previously, the API timeout would be the same as the one set to “Disconnect idle users”.
- (Embedded UI) Video Preview was not appearing on top of buttons.
- (Embedded UI) Fix dropdown not working in Export Dialog (Shadow DOM).
- Filenames with emoji and some Unicode characters would crash the render/export.
- Fixed potential issues when canceling an import operation.
- CSS updates for button transitions.
- Audio waveform tick marks were not showing up in light mode.
- Various Node and Package updates.
- Person checkbox could not be selected/deselected in Objects List.
- Fix export for videos that contain audio tracks with blocks of missing packets.
## 5.2.0 - March 7, 2024
##### New Features
- Modify the size or location of an object for only one frame with the "Apply to Single Frame" button. The previous behavior of re-tracking the object based on the changes is still available and is now called "Apply and Track".
##### Updates
- Start and stop times can now be specified as `hh:mm:ss` when exporting a portion of the video.
- Imported videos will now be re-encoded by default. This should prevent any synchronization issues between the video and rendered boxes during editing. Holding the SHIFT key down before importing a new video will bypass conversion.
##### Bug Fixes
- Fixed issue with Export Range not working properly
- Fixed a bug with rendering not working correctly on multi-export
- Progress reporting was not working properly for video conversion/encoding at import time
- (API) Fixed issue with API service not starting after new license activation
- (API Embedded UI) React context menu click not working in Shadow DOM
## 5.1.0 - January 13, 2024
##### Updates
- Improve detections for fast-moving objects with Body/Dash Cam profile
- (API) AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY are not required to be specified if using SAS for input/output URIs
- (API) AZURE_STORAGE_ACCOUNT value does not need to match the output Azure Storage Account when using SAS
- (API Embedded UI) Shadow DOM beta
- KNOWN ISSUE: Can’t select options after right-clicking on detections
##### Bug Fixes
- Fix white screen issue when user with Supervisor group tries to access the Admin section
- (API) Images can now be exported
## 5.0.6 - December 22, 2023
##### New Features
- Added “Invert Regions” to Audio Redaction to "unmute" a portion of previously selected audio
##### Updates
- Update the render options in the bulk export dialog to include audio redaction strength & "default" settings
- (API) API export could lock a video as "in-use" if consecutive export calls were made to the same outputUri
##### Bug Fixes
- Previewing already exported video did not show updated redaction types
- Add Media & Convert now properly resets after the file uploads
- Fixed “Merge Regions” to only appear if audio redactions can be merged
## 5.0.5 - December 11, 2023
##### Updates
- Redaction boxes may disappear on last frame for certain videos
- Fixed force conversion not working on drag and drop
##### API
- Full export options exposure to the API
## 5.0.4 - November 27, 2023
##### New Features
- Audio transcript text can be downloaded from within the Speech panel
##### Updates
- Capture additional logs if a video fails to load.
- "Add Media" button now shows "Add Media & Convert" when holding SHIFT on keyboard.
- Removed country flags from multi-language UI selector in settings.
- Removed the detection types from the export settings. What is selected in the view through [Objects] is what will be rendered.
- Added missing audio setting into Multi-select export settings.
- The multi-select settings overwrite all of the individual media’s export settings, except the ones not presented there, because of the compound nature (detection types, region, …).
- Included full timestamp in exported filename instead of a random number.
- Do not show export options that won’t apply to the selection: no audio, only images, etc.
- Save the multi-export options so it remembers them for next time.
- Fix the issue where if multiple videos are selected and one is deleted, the status (_5 + selected_ ) doesn’t change and stays sticky until a video is opened again to clear the state.
##### Bug Fixes
- Image redaction export crashes if bounding box touched edge
##### API
- (Embedded UI) "active()" method added to embedded UI to notate editor is open
- New licensing endpoint: `GET http://localhost:${SERVER_PORT}/licensing`
- Fix issue where invalid projectId format would crash service
- Events are emitted with sessionId when editor is entered and exited
## 5.0.3 - October 24, 2023
##### New Features
- Show "Unsupported Browser" message for Safari browser
- Checkmark now appears beside audio transcript languages that have already been processed
##### Updates
- Added "View options" and "Redaction type" filter to Objects Panel
- (API Embedded UI) Emit commands and events from the editor
##### Bug Fixes
- "Automatically Track" timing issues for boxes
## 5.0.1 - October 9, 2023
##### Bug Fixes
- Removed 5-minute timeout for large file uploads
- Automatically Track was off for forward and backward passes
- Cancelling processing tasks would cause a crash
- Fall back to CPU processing mode for GPUs with compute capability < 5
## 5.0.0 - October 5, 2023
##### New Features
- Speech detection and transcription for videos
- Multi-language support in the UI
- Upgrade to Sighthound Gen6 Computer Vision models
- Enable CUDA video decoding
- New Settings/Help Section
- Frame-by-frame editing mode (Hold down SHIFT key before clicking Apply in Edit mode)
- (API) "Projects" feature added to the embedded UI
##### Updates
- Performance improvements for processing and exporting with GPU
- Move Export Options from sidebar into a modal that’s displayed on export
- (Docker) Set the timezone in the container to GMT
##### Bug Fixes
- Disable video controls when in editing mode to show that playback is prevented
- Bug fix for exporting trimmed and scrambled videos
- A few log entries were incorrectly displayed as errors
---
# Agent Instructions
Use this Markdown page as context for Sighthound Developer Portal questions. For broader navigation, read https://dev.sighthound.com/llms.txt. Answer from Sighthound documentation, cite relevant source URLs, and do not ask users to paste secrets, tokens, license keys, or credentials into chat.