transloadit 3.0.2 → 4.0.0-4

package/dist/alphalib/types/robots/video-subtitle.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.robotVideoSubtitleInstructionsSchema = exports.meta = void 0;
+const zod_1 = require("zod");
+const _instructions_primitives_ts_1 = require("./_instructions-primitives.js");
+const stackVersions_ts_1 = require("../stackVersions.js");
+exports.meta = {
+    allowed_for_url_transform: false,
+    bytescount: 1,
+    discount_factor: 1,
+    discount_pct: 0,
+    example_code: {
+        steps: {
+            subtitled: {
+                robot: '/video/subtitle',
+                use: {
+                    steps: [
+                        { name: ':original', fields: 'input_video', as: 'video' },
+                        { name: ':original', fields: 'input_srt', as: 'subtitles' },
+                    ],
+                },
+                ffmpeg_stack: stackVersions_ts_1.stackVersions.ffmpeg.recommendedVersion,
+            },
+        },
+    },
+    example_code_description: 'If you have two file input fields in a form — one for a video and another for an SRT or VTT subtitle, named `input_video` and `input_srt` respectively (with the HTML `name` attribute), hereʼs how to embed the subtitles into the video with Transloadit:',
+    minimum_charge: 0,
+    output_factor: 0.6,
+    override_lvl1: 'Video Encoding',
+    purpose_sentence: 'adds subtitles and closed captions to videos',
+    purpose_verb: 'subtitle',
+    purpose_word: 'subtitle',
+    purpose_words: 'Add subtitles to videos',
+    service_slug: 'video-encoding',
+    slot_count: 60,
+    title: 'Add subtitles to videos',
+    typical_file_size_mb: 80,
+    typical_file_type: 'video',
+    uses_tools: ['ffmpeg'],
+};
+exports.robotVideoSubtitleInstructionsSchema = _instructions_primitives_ts_1.robotBase
+    .merge(_instructions_primitives_ts_1.robotUse)
+    .merge(_instructions_primitives_ts_1.robotFFmpegVideo)
+    .extend({
+    robot: zod_1.z.literal('/video/subtitle').describe(`
+This <dfn>Robot</dfn> supports both SRT and VTT subtitle files.
+`),
+    subtitles_type: zod_1.z
+        .enum(['burned', 'external', 'burn'])
+        .transform((val) => (val === 'burn' ? 'burned' : val))
+        .default('external').describe(`
+Determines if subtitles are added as a separate stream to the video (value \`"external"\`) that then can be switched on and off in your video player, or if they should be burned directly into the video (value \`"burned"\` or \`"burn"\`) so that they become part of the video stream.
+`),
+    border_style: zod_1.z.enum(['box', 'outline', 'shadow']).default('outline').describe(`
+Specifies the style of the subtitle. Use the \`border_color\` parameter to specify the color of the border.
+`),
+    border_color: _instructions_primitives_ts_1.color_with_alpha.default('40000000').describe(`
+The color for the subtitle border. The first two hex digits specify the alpha value of the color.
+`),
+    // TODO: Make font an enum
+    font: zod_1.z.string().default('Arial').describe(`
+The font family to use. Also includes boldness and style of the font.
+
+[Here](/docs/supported-formats/fonts/) is a list of all supported fonts.
+`),
+    font_color: _instructions_primitives_ts_1.color_without_alpha.default('FFFFFF').describe(`
+The color of the subtitle text. The first two hex digits specify the alpha value of the color.
+`),
+    font_size: zod_1.z.number().int().min(1).default(16).describe(`
+Specifies the size of the text.
+`),
+    position: _instructions_primitives_ts_1.positionSchema.default('bottom').describe(`
+Specifies the position of the subtitles.
+`),
+})
+    .strict();
+//# sourceMappingURL=video-subtitle.js.map

package/dist/alphalib/types/robots/video-subtitle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"video-subtitle.js","sourceRoot":"","sources":["../../../../src/alphalib/types/robots/video-subtitle.ts"],"names":[],"mappings":";;;AAAA,6BAAuB;AAEvB,+EAOsC;AAEtC,0DAAmD;AAEtC,QAAA,IAAI,GAAc;IAC7B,yBAAyB,EAAE,KAAK;IAChC,UAAU,EAAE,CAAC;IACb,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,CAAC;IACf,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,SAAS,EAAE;gBACT,KAAK,EAAE,iBAAiB;gBACxB,GAAG,EAAE;oBACH,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,EAAE,OAAO,EAAE;wBACzD,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,EAAE;qBAC5D;iBACF;gBACD,YAAY,EAAE,gCAAa,CAAC,MAAM,CAAC,kBAAkB;aACtD;SACF;KACF;IACD,wBAAwB,EACtB,6PAA6P;IAC/P,cAAc,EAAE,CAAC;IACjB,aAAa,EAAE,GAAG;IAClB,aAAa,EAAE,gBAAgB;IAC/B,gBAAgB,EAAE,8CAA8C;IAChE,YAAY,EAAE,UAAU;IACxB,YAAY,EAAE,UAAU;IACxB,aAAa,EAAE,yBAAyB;IACxC,YAAY,EAAE,gBAAgB;IAC9B,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,yBAAyB;IAChC,oBAAoB,EAAE,EAAE;IACxB,iBAAiB,EAAE,OAAO;IAC1B,UAAU,EAAE,CAAC,QAAQ,CAAC;CACvB,CAAA;AAEY,QAAA,oCAAoC,GAAG,uCAAS;KAC1D,KAAK,CAAC,sCAAQ,CAAC;KACf,KAAK,CAAC,8CAAgB,CAAC;KACvB,MAAM,CAAC;IACN,KAAK,EAAE,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC;;CAEhD,CAAC;IACE,cAAc,EAAE,OAAC;SACd,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;SACpC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACrD,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC;;CAEnC,CAAC;IACE,YAAY,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;;CAElF,CAAC;IACE,YAAY,EAAE,8CAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC;;CAE/D,CAAC;IACE,0BAA0B;IAC1B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC;;;;CAI9C,CAAC;IACE,UAAU,EAAE,iDAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC;;CAE9D,CAAC;IACE,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC;;CAE3D,CAAC;IACE,QAAQ,EAAE,4CAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC;;CAEvD,CAAC;CACC,CAAC;KACD,MAAM,EAAE,CAAA"}