bookoly icon

bookoly

Interact with the bookoly API
Join our community

Actions25

Overview

This node integrates with the Bookoly API to add audio with subtitles to a video. It allows users to provide a video URL and an audio URL, then combines them by optionally muting the original video audio, adjusting volume, trimming audio to match video length, and overlaying styled subtitles in various languages and formats.

Common scenarios include:

  • Enhancing silent or muted videos by adding voiceovers or background music with synchronized subtitles.
  • Creating accessible video content with subtitles in multiple languages.
  • Producing engaging social media videos with customized subtitle styles and positions.

Practical example:
You have a promotional video hosted online and want to add a voiceover track along with highlighted subtitles in English using a playful font style. This node lets you specify all these parameters and outputs a new video with the combined audio and styled subtitles.

Properties

Name Meaning
Name The name of the video to be created or processed.
Video URL Public and downloadable URL of the source video file.
Mute Video Whether to mute the original audio track of the video (true/false).
Audio URL Public and downloadable URL of the audio file to add to the video.
Trim Audio Whether to trim the audio to match the video length if the audio is longer (true/false).
Volume Audio volume level as a percentage from 1% to 100%, where 100% is original volume.
Subtitle - Style Subtitle display style. Options: Simple, Signal, Rainbow, Highlight Current Word, Signal Highlight Current Word, Rainbow Highlight Current Word. Default is "Highlight Current Word".
Subtitle - Language Language code for subtitles. Examples: en (English), es (Spanish), fr (French), de (German), zh (Chinese), etc.
Subtitle - Font Family Font family for subtitles. Options include Arial, Charm, Eagle Lake, Libre Baskerville, Lobster, Luckiest Guy, Marck Script, Nanum Pen Script, Nunito, Pacifico, Roboto, Korean, Chinese Simplified, Chinese Traditional.
Subtitle - Font Size Font size for subtitles, from 1 to 100. Default is 20.
Subtitle - Word Color HEX color code for subtitle words, e.g., #FEEE15 (yellow).
Subtitle - Line Color HEX color code for subtitle lines, e.g., #FFFFFF (white).
Subtitle - Line Words Number of words displayed at a time in subtitles, between 1 and 10.
Subtitle - Outline Width Width of the subtitle outline, from 1 to 100. Default is 5.
Subtitle - Position Position on the video where subtitles appear. Options: Top Left, Top Center, Top Right, Center Left, Center Center, Center Right, Bottom Left, Bottom Center, Bottom Right, Mid Top Center, Mid Bottom Center.
Subtitle - Orientation Text orientation for subtitles: Left to Right (true) or Right to Left (false). Default is Left to Right.
Wait for Completion If true, the node waits until video generation finishes and returns full video data; if false, returns only video ID and creation timestamp immediately.
Webhook URL Optional URL to receive webhook notifications about video processing status, including video ID and URL.

Output

The node outputs JSON data representing the resulting video object after processing. If "Wait for Completion" is enabled, this includes full details such as the final video URL and metadata. If disabled, it returns minimal information like the video ID and creation timestamp.

No binary data output is indicated.

Dependencies

  • Requires access to the Bookoly API service at https://bookoly.com/api/v1.
  • Requires an API key credential for authentication with the Bookoly API.
  • Network access to publicly accessible URLs for both the input video and audio files.
  • Optional webhook URL support for asynchronous notification of video processing completion.

Troubleshooting

  • Invalid or inaccessible video/audio URLs: Ensure that the provided URLs are publicly accessible and downloadable. Private or restricted URLs will cause failures.
  • API authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
  • Timeouts or long processing times: If "Wait for Completion" is enabled, large videos may take significant time to process. Consider disabling wait and using webhook notifications instead.
  • Unsupported subtitle language or font: Confirm that the selected language and font family are supported by the API.
  • Volume or trim settings not applied: Check that numeric values for volume and trim flags are within allowed ranges and correctly set.

Common error messages:

  • "No handler found for video.addAudioWithSubtitlesToVideo": Indicates misconfiguration or missing operation implementation.
  • "Failed to execute addAudioWithSubtitlesToVideo: [error message]": General execution failure, check error details for specific cause.

Links and References

Discussion