When upgrading to 5.10, the new and improved transcode system is automatically used. The old transcode system can still be used in 5.10 but will be deprecated in later releases.
This page describes the most important things to be aware of in relation to the new transcode system.
EXIF
In previous version of the old transcode system, it was possible to embed EXIF metadata in the generated renditions/transcodes. This is not supported in the new transcode system.
API and SDK users
It has been ensured that the automatic switch to the new transcode system is seamless in all applications and integrations developed by Digizuite. However, the new transcode system has a few caveats to be aware of for anyone that uses the Digizuite API or SDK:
Handling of unavailable renditions.
Search2.
New thumbnail formats.
Handling of unavailable renditions
A main difference between the old transcode system and the new transcode system is that renditions might not be immediately ready when they are requested.
Previously, asset streamer URLs would never be returned for renditions that weren’t ready for download. However, with the new transcode system, asset streamer URLs are returned for renditions that can be generated.
For users of the SDK, this is relevant for all URLs that are returned in the AssetResponse
class from the services IAssetSearchService
and IAssetService
. For users of the API, this is relevant for the URLs that are returned in responses from the endpoints <api-url>/DigizuiteCore/LegacyService/api/assets/search
, <api-url>/DigizuiteCore/LegacyService/api/assets/<asset-id>
, and <api-url>/DigizuiteCore/LegacyService/api/assets
.
Previously, no asset streamer URLs would be returned for renditions before they were ready.
Search2
New thumbnail formats
With the 5.10 release, the thumbnail and preview formats that are defined out of the box have been reworked. By default, this is handled automatically and no manual actions should be required.
The main difference between the old and the new thumbnail formats is that they are now webp
files with transparency. The old thumbnails were jpeg
files without transparency.
As described above, the thumbnails for existing assets are not automatically re-generated. If the existing thumbnails should be re-generated, this can be done by setting up an automation that uses the “Generate asset renditions” step with the “Force generate” flag enabled.
Since the file type of the thumbnails has been changed, the asset streamer returns the response header Content-Type: image/webp
instead of the correct response header Content-Type: image/jpeg
for existing thumbnails. Most browsers should be able to display the thumbnails despite of this. If it becomes an issue, the existing thumbnails can either be re-generated as described above, or the thumbnail formats can be modified to be of the type jpeg
.
Search2
Search2 allows the tables media_transcode_proxy_destination
and media_transcode_proxy
to be referenced in both input and output, providing access to information about transcodes/renditions. Information about renditions generated with the new transcode system can not be accessed through these tables. If one of these tables is used in a search, it is recommended to start using the API or the SDK to retrieve information about transcodes instead. This can be done using the endpoint <api-url>/DigizuiteCore/LegacyService/api/assets/search
or IAssetSearchService
in the SDK.
Search2 allows URLs for renditions of old media formats to be retrieved with the functions urlAbsolut
, urlRelative
, downloadUrlAbsolut
, and downloadUrlRelative
. It has been ensured that this still works, even if the targeted old media format has been mapped to a new format. If an old media format has not been mapped to a new format, these functions work in exactly the same way as previously.
However, a few caveats should be mentioned in the case where an old media format is mapped to a new format:
A URL is always returned, even though a rendition of the asset in the old media format can not be generated. As an example, this means that a
thumb
URL is included for an asset in the defaultGetAssets
search, even if it can not be generated. Previously, thethumb
URL would be null in this case. Thus, it must be ensured that clients do no rely on the URL in a search to be null when it can’t be generated.If the
urlRelative
ordownloadUrlRelative
function is used, the returned relative URL will be relative to<api-url>
instead of<api-url>/dmm3bwsv3
as it was before.
If the caveats above are addressed, Search2 can still be used to retrieve valid URLs for old media formats that have been mapped to new formats, ensuring that the new transcode system is used. However, it is generally recommended to start rewriting applications that use Search2 to use the new API or SDK instead. If this is not possible, it is still possible to opt-out of using the new transcode system by ensuring that no old media formats are mapped to new formats.
On-demand transcoding
A key difference between the old transcode system and the new transcode system is that renditions can now be generated on-demand. In particular, this means that