Contact Us

CATEGORIES

Whoops…Nothing found

Try other keywords in your search

SubtitleCreator

 3 Minutes

 0 Likes

 8 Views

SubtitleCreator imports SubRip Subtitle (.srt) data into PIXERA and creates timed clips on a dedicated layer. The generated clips display the subtitle text while using a selectable resource as their clip content.


Usage

Use SubtitleCreator to turn an SRT subtitle file into timeline clips. Each subtitle entry becomes a clip whose start time, duration, and text are taken from the SRT data. The module can create the required layer and text resource, update existing clips after the source file or settings change, and remove the generated layer and resource.


Setup

  1. Prepare a valid, non-empty .srt file and select it with SRT File Path.
  2. Select an existing Timeline and Screen. Both properties default to None and must be configured before creating subtitles.
  3. Select the resource used by the generated clips with Clip Content.
  4. Configure Font, Clip Offset, Text Position X, Text Position Y, and Text Height as required.
  5. Leave Auto Init enabled or run init manually. Initialization reads the SRT file and resolves the configured timeline, screen, resource, and any existing layer named after the SRT filename.
  6. Run createLayerAndResource or use CreateLayerAndResource Button. The module creates an SRTResources folder under Media, a text resource, a layer named after the SRT file, and one clip per subtitle entry.
  7. After changing the SRT file or configuration, run updateLayerAndResource or use UpdateLayerAndResource Button to update the generated clips and their presentation settings.
  8. Run clearLayerAndResource or use ClearLayerAndResource Button to remove the generated layer and text resource. Clear an existing generated layer before attempting to create it again.

Features

  1. Reads subtitle text and timing from SRT files.
  2. Creates a dedicated timeline layer and timed clip for each subtitle entry.
  3. Supports multi-line subtitle text.
  4. Applies a selectable clip-content resource to all generated clips.
  5. Provides configurable font, text position, text height, and timing offset.
  6. Updates existing clips after source or configuration changes.
  7. Removes the generated layer and text resource when they are no longer needed.

Actions

Action Info Input Output
ref Returns the SubtitleCreator module instance for reference-based calls. - -
init Reads and validates the SRT file, loads the configured properties, creates the Media.SRTResources folder if needed, and resolves existing generated objects. - -
uninit Clears the module’s stored references, settings, parsed SRT data, and clip state. - -
createLayerAndResource Creates the text resource, subtitle layer, and clips from the configured SRT file, then applies the presentation settings. - -
updateLayerAndResource Reads the SRT file again and updates, adds, or removes generated clips before reapplying the presentation settings. - -
clearLayerAndResource Removes the generated subtitle layer and text resource. - -
Settings Folder containing actions that modify the generated subtitle presentation. FOLDER FOLDER
setTextFont Sets the font used by the generated text resource. When no input is supplied, the stored property value is used. font (string) -
setClipContent Assigns a resource to every generated subtitle clip. When no input is supplied, the stored property value is used. contentName (string) -
setClipOffset Moves all generated clips using the supplied or stored timing offset. offset (double) -
setTextPositionX Sets the X position parameter for the generated subtitle layer. xPos (double) -
setTextPositionY Sets the Y position parameter for the generated subtitle layer. yPos (double) -
setTextHeight Sets the line height of the generated text resource. textHeight (double) -
Internal Folder containing option-source, SRT parsing, and file-reading helpers. FOLDER FOLDER
getTimelineNames Supplies None and the available timeline names to the Timeline property. - -
getScreenNames Supplies None and the available screen names to the Screen property. - -
getResourceNames Supplies None and available non-text media resources to the Clip Content property. - -
srtTimeToHMSF Converts an SRT timestamp into PIXERA timeline time. srtTime (string) -
getFileContents Validates and reads the configured SRT file into the module’s internal line list. - -

Properties

Name Content Type Hint Options Source Options Action
Auto Init true bool - -
SRT File Path C:\SRT\SRT.srt file - self.init
Timeline None string self.Internal.getTimelineNames self.init
Screen None string self.Internal.getScreenNames self.init
Font Arial string - self.Settings.setTextFont
Clip Content Media/Standard Content/Atlanta.mp4 string self.Internal.getResourceNames self.Settings.setClipContent
Clip Offset 0 - - self.Settings.setClipOffset
Text Position X 0 number - self.Settings.setTextPositionX
Text Position Y 0 number - self.Settings.setTextPositionY
Text Height 100 number - self.Settings.setTextHeight
CreateLayerAndResource Button Create Layer and Resource button - self.createLayerAndResource
UpdateLayerAndResource Button Update Layer and Resource button - self.updateLayerAndResource
ClearLayerAndResource Button Clear Layer and Resource button - self.clearLayerAndResource
Description SRT, or SubRip Subtitle, is a popular file format used for displaying subtitles for video content. With this Module, you can import an SRT file's data which will then create a Layer with an attached Text Resource to display the specified text at the specified timecode. The "createLayerAndResource" Action will generate the Layer and Clips from the imported SRT data. If needing to delete what the Module has created, you can use the "clearLayerAndResource" Action to do so. Whenever the "Setup" Property settings are changed or the SRT File itself is modified, use the "updateLayerAndResource" Action to make sure the Layer is using the updated information. The text font, content, position, and size can be set in the properties and will update all the Clips with the new values for quick manuevering of the text. There is also an offset option allowing for the generated Clips to start at different locations then what is listed in the SRT file. string - -
Author AV Stumpfl GmbH string - -
Pixera Logo Embedded PIXERA logo image - -
URL www.pixera.one url - -
Version 1 string - -

Changelog


Module Version 1 | 17 September 2026 | AV Stumpfl GmbH

Was this article helpful?