Release Notes

The following releases are available for the OpenShot Cloud API. It is recommended you use the most current release when spinning up a new instance. See Upgrade instructions.

Release Notes

  • 1.2.3
    • Added retry logic for download files from URL or S3 (when creating File objects)
    • Added retry logic when inspecting newly uploaded File objects
    • Improved error handling and logging when invalid or corrupted File objects are used
    • Added secure download endpoints for media files (/files/<id>/download/ and /exports/<id>/download/)
    • Workers now fallback to secure download endpoints, if direct media URLs are invalid (i.e. if you manually disable them in Apache for security)
    • Added new configuration setting to override HTTP_HOST (and force all URLs to use any public URL you want). This is especially useful for webhooks (which often refers to http://127.0.0.1).
    • Improvements to config-openshot-cloud command, messages, formatting, AWS/Azure cloud detection, and support for Azure cloud backend (Queue and Blob storage)
    • Added Azure Blob Storage support to File and Export endpoints (Exports can support both S3 and Azure Blob storage concurrently)
    • Added Azure Queue Storage support for Export queue management (OpenShot API now supports both SQS or Azure Queues… just not at the same time)
  • 1.2.2
    • Improved /files/<id>/copy/ endpoint, which now has an optional “project” parameter. This can be used to copy a file to a different project.
    • Much improved config-openshot-cloud command (formatting and layout improvements, ability to register for support)
    • Fixed Effect (Mask) bug where workers were not able to download a custom asset
    • Added new unit tests with more coverage and many additional edge cases handled
    • Upgraded libopenshot C++ library with latest improvements and bug fixes (including a serious SVG mask related bug)
    • Experimental hardware acceleration support in libopenshot (requires instances with hardware encoders/decoders)
    • More reliable asset downloading between workers and server (retry logic and improved error reporting)
    • Enable CORS (cross-origin resource sharing) by default (can be disabled in /etc/apache2/sites-available/openshot.conf)
    • Upgraded boto3 module, for improved AWS S3/SQS support (added support for more regions: ap-south-1)
    • Updated system libraries and applied security updates
    • Improved documentation (REST methods, frame # calculations, suggested instance types, upgrade instructions)
  • 1.2.1
    • Fixed regression with /files/<id>/copy/ endpoint, where original file media was removed
    • Fixed regression with /projects/<id>/copy/ endpoint, where original file media was removed
    • Improved documentation for token authentication
  • 1.2.0
    • Upgrade from Ubuntu 16.04 LTS to 18.04 LTS
    • All libraries and frameworks updated (including Qt, FFmpeg, resvg, and Python)
    • Improved SVG rendering (due to updated Qt dependency)
    • Fixed SVG right alignment bug (due to updated Qt dependency)
  • 1.1.1
    • Much improved SVG rendering (using resvg library). Supports more of the SVG language than our previous Qt SVG library.
    • Fixed bug with export object, where webhooks and S3 options were being clobbered at the end of an export.
    • Fixed S3 upload failures
    • Added more unit tests to validate S3 uploading and webhooks
    • Added new /info/fonts/thumbnail/ endpoint, to preview all installed fonts
    • New default font, when the API can not find an installed font
  • 1.1.0
    • Replaced ZMQ queue with AWS SQS (for more reliable and scalable queue handling of video exports). Requires IAM user and permissions (AmazonSQSFullAccess & AmazonS3FullAccess).
    • Worker queue processing now restarts after exports are complete (clearing memory)
    • Worker file synchronizing is much faster (and more optimized)
    • Fixed /projects/<id>/load/ endpoint bug when loading ZIP archive of project files.
    • New /info/fonts/ endpoint for adding new Font files dynamically (POST method now accepted)
    • Memcached replacing local memory caching (more efficient caching)
    • /projects/<id>/files/find/ endpoint has been modified, to provide the media URL and file object URL
    • Updated documentation with new AWS SQS instructions
  • 1.0.10
    • Improved API performance (less DB queries per request)
    • File updating bug fix (updating the media of a file would break)
    • New libopenshot version (fixes some codec issues, improved performance, better detection of various media formats)
  • 1.0.9
    • Added /files/<id>/copy/ endpoint to Project and File objects
    • Added /projects/<id>/download/ endpoint for projects (ZIP archive of entire project with relative paths)
    • Added /files/<id>/text-replace/ endpoint for File objects (for easily editing SVG or text-based files)
    • Improved /projects/<id>/load/ endpoint to optionally accept a ZIP archive of an entire project with media files
    • Improved detection of installed AAC encoders
    • Improved speed of many endpoints (by reducing # of SQL queries and caching)
    • Reduced default video bitrate, for smaller files by default
    • Changed /projects/<id>/title/ endpoint to return the new file JSON (instead of a 302 redirect)
    • Allow OPTIONS method without authentication (for CORS)
    • Fixed webhooks for pending and failed exports
    • Fixed UTF-8 encoding error with unicode fonts (also added Noto fonts, including Japanese font)
    • Maintain original_id when /load/ endpoint is used
    • Added new unit tests for more coverage of API endpoints
    • Updated documentation with new endpoints
  • 1.0.8 - Updated libopenshot version (fixed volume keyframe regression), and misc library improvements / fixes
  • 1.0.7 - Reverting to libfdk_aac for AAC support. New native S3 support (for File and Export objects). Duplicate files on PUT or PATCH bug fixed. Improved file-system clean-up. Also improved docs with new S3 examples, and added upgrade instructions and release notes.
  • 1.0.6 - Improved Audio Support (AAC), Better Memory Management, Misc Bug Fixes
  • 1.0.5 - Stability Improvements, New Presets, Improved Docs
  • 1.0.4 - Improved Webhooks, Improved Docs, Improved Logging, Misc Bug fixes
  • 1.0.3 - Title Endpoints, Improved Docs, Misc Bug fixes
  • 1.0.2 - Improved Performance, Improved Stability
  • 1.0.1 - Stability Improvements, Misc Bug Fixes
  • 1.0.0 - Initial Release of OpenShot Cloud API