Add support for subtitles

package.json

@@ -1,6 +1,6 @@
 {
   "name": "creatomate",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Official Node.js SDK for the Creatomate video rendering API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/Client.ts

@@ -61,7 +61,7 @@ export class Client {
         try {
           const updatedRender = await this.fetchRender(render.id);
 
-          if (updatedRender.status !== 'planned' && updatedRender.status !== 'rendering') {
+          if (updatedRender.status !== 'planned' && updatedRender.status !== 'rendering' && updatedRender.status !== 'transcribing') {
             unfinishedRenders = unfinishedRenders.filter(({ id }) => id !== render.id);
 
             finishedRenders.push(updatedRender);

src/RenderStatus.ts

@@ -1 +1 @@
-export type RenderStatus = 'planned' | 'rendering' | 'succeeded' | 'failed';
+export type RenderStatus = 'planned' | 'rendering' | 'transcribing' | 'succeeded' | 'failed';

src/elements/ElementBase.ts

@@ -15,6 +15,11 @@ import { AnimationBase } from '../animations';
 import { expandProperties, transformObjectKeys, transformCamelToSnakeCase } from '../utility';
 
 export interface ElementProperties {
+  /**
+   * A unique identifier for this element.
+   */
+  id?: string;
+
   /**
    * The track number on which this element is placed. If you are rendering an image, you can leave this value undefined.
    */

src/elements/Text.ts

@@ -6,6 +6,9 @@ import {
   StrokeJoin,
   TextBackground,
   TextTransform,
+  TranscriptEffect,
+  TranscriptPlacement,
+  TranscriptSplit,
   ValueOrKeyframes,
 } from '../properties';
 import { ElementBase, ElementProperties } from './ElementBase';
@@ -175,6 +178,37 @@ export interface TextProperties extends ElementProperties {
    * width. A value of 0% disables alignment.
    */
   backgroundAlignThreshold?: ValueOrKeyframes<number | string>;
+
+  /**
+   * To use auto-transcription for this text element, set it to the ID of the video element for which subtitles are to
+   * be generated.
+   */
+  transcriptSource?: string;
+
+  /**
+   * The transcript effect: color, karaoke, highlight, fade, bounce, slide, or enlarge.
+   */
+  transcriptEffect?: TranscriptEffect;
+
+  /**
+   * The transcript split: none, word, or line.
+   */
+  transcriptSplit?: TranscriptSplit;
+
+  /**
+   * The transcript placement: static, animate, or align.
+   */
+  transcriptPlacement?: TranscriptPlacement;
+
+  /**
+   * The maximum number of characters shown simultaneously.
+   */
+  transcriptMaximumLength?: number;
+
+  /**
+   * The color applied to the currently spoken text (word or line). Use this in conjunction with "transcriptSplit".
+   */
+  transcriptColor?: string;
 }
 
 export class Text extends ElementBase<TextProperties> {

src/properties/TranscriptEffect.ts

@@ -0,0 +1 @@
+export type TranscriptEffect = 'color' | 'karaoke' | 'highlight' | 'fade' | 'bounce' | 'slide' | 'enlarge';

src/properties/TranscriptPlacement.ts

@@ -0,0 +1 @@
+export type TranscriptPlacement = 'static' | 'animate' | 'align';

src/properties/TranscriptSplit.ts

@@ -0,0 +1 @@
+export type TranscriptSplit = 'none' | 'word' | 'line';

src/properties/index.ts

@@ -22,6 +22,9 @@ export * from './StrokeCap';
 export * from './StrokeJoin';
 export * from './TextBackground';
 export * from './TextTransform';
+export * from './TranscriptEffect';
+export * from './TranscriptPlacement';
+export * from './TranscriptSplit';
 export * from './Warp';
 export * from './WarpMode';
 export * from './WarpPoint';