You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -438,14 +440,14 @@ You can also set this to \`false\` to skip metadata extraction and speed up tran
438
440
`Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times`,
Force a Robot to accept a file type it would have ignored.
443
+
force_accept: z.boolean().default(false)
444
+
.describe(`Force a Robot to accept a file type it would have ignored.
443
445
444
-
By default Robots ignore files they are not familiar with.
445
-
[🤖/video/encode](https://transloadit.com/docs/robots/video-encode/), for
446
+
By default, Robots ignore files they are not familiar with.
447
+
[🤖/video/encode](/docs/robots/video-encode/), for
446
448
example, will happily ignore input images.
447
449
448
-
With the force_accept parameter set to true you can force Robots to accept all files thrown at them.
450
+
With the \`force_accept\` parameter set to \`true\`, you can force Robots to accept all files thrown at them.
449
451
This will typically lead to errors and should only be used for debugging or combatting edge cases.
450
452
`),
451
453
})
@@ -1167,9 +1169,9 @@ Go back to your Google credentials project and enable the "Google Cloud Storage
1167
1169
1168
1170
Now you can set up the \`storage.objects.create\` and \`storage.objects.delete\` permissions. The latter is optional and only required if you intend to overwrite existing paths.
1169
1171
1170
-
To do this from the Google Cloud console, navigate to "IAM & Admin" and select "Roles". From here, select "+CREATE ROLE", enter a name, set the role launch stage as general availability and set the permissions stated above.
1172
+
To do this from the Google Cloud console, navigate to "IAM & Admin" and select "Roles". From here, click "Create Role", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.
1171
1173
1172
-
Next, relocate to your storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "ADD MEMBER", enter your service account as a new member and select your newly created role.
1174
+
Next, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "Add Member", enter your service account as a new member, and select your newly created role.
1173
1175
1174
1176
Then, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your <dfn>Template Credentials</dfn> as this parameter's value.
See the [available resize strategies](/docs/robots/image-resize/#resize-strategies).
1353
+
See the [available resize strategies](/docs/topics/resize-strategies/).
1352
1354
`),
1353
1355
zoom: z.boolean().default(true).describe(`
1354
-
If this is set to \`false\`, smaller videos will not be stretched to the desired width and height. For details about the impact of zooming for your preferred resize strategy, see the list of available [resize strategies](/docs/robots/image-resize/#resize-strategies).
1356
+
If this is set to \`false\`, smaller videos will not be stretched to the desired width and height. For details about the impact of zooming for your preferred resize strategy, see the list of available [resize strategies](/docs/topics/resize-strategies/).
Specify an object containing coordinates for the top left and bottom right corners of the rectangle to be cropped from the original video(s). Values can be integers for absolute pixel values or strings for percentage based values.
1358
1360
1359
1361
For example:
1360
1362
1361
1363
\`\`\`json
1362
-
1363
1364
{
1364
1365
"x1": 80,
1365
1366
"y1": 100,
1366
1367
"x2": "60%",
1367
1368
"y2": "80%"
1368
1369
}
1369
-
1370
1370
\`\`\`
1371
1371
1372
1372
This will crop the area from \`(80, 100)\` to \`(600, 800)\` from a 1000×1000 pixels video, which is a square whose width is 520px and height is 700px. If \`crop\` is set, the width and height parameters are ignored, and the \`resize_strategy\` is set to \`crop\` automatically.
1373
1373
1374
-
You can also use a JSON string of such an object with coordinates in similar fashion: \`"{ "x1": <Integer>, "y1": <Integer>, "x2": <Integer>, "y2": <Integer> }"\`
1374
+
You can also use a JSON string of such an object with coordinates in similar fashion:
The background color of the resulting video the \`"rrggbbaa"\` format (red, green, blue, alpha) when used with the \`"pad"\` resize strategy. The default color is black.
@@ -1400,7 +1404,7 @@ Splits the video into multiple chunks so that each chunk can be encoded in paral
1400
1404
Allows you to specify the duration of each chunk when \`turbo\` is set to \`true\`. This means you can take advantage of that feature while using fewer <dfn>Priority Job Slots</dfn>. For instance, the longer each chunk is, the fewer <dfn>Encoding Jobs</dfn> will need to be used.
1401
1405
`),
1402
1406
watermark_url: z.string().default('').describe(`
1403
-
A URL indicating a PNG image to be overlaid above this image. You can also [supply the watermark via another Assembly Step](/docs/robots/video-encode/#watermark-parameters-video-encode).
1407
+
A URL indicating a PNG image to be overlaid above this image. You can also [supply the watermark via another Assembly Step](/docs/topics/use-parameter/#supplying-the-watermark-via-an-assembly-step).
'The pages to select from the input PDF and to be included in the output PDF. Each entry can be a single page number (e.g. 5), or a range (e.g. `5-10`). Page numbers start at 1.',
42
-
),
41
+
'The pages to select from the input PDF and to be included in the output PDF. Each entry can be a single page number (e.g. 5), or a range (e.g. `5-10`). Page numbers start at 1. By default all pages are extracted.',
Copy file name to clipboardExpand all lines: src/alphalib/types/robots/file-preview.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ Height of the thumbnail, in pixels.
75
75
resize_strategy: resize_strategy.describe(`
76
76
To achieve the desired dimensions of the preview thumbnail, the <dfn>Robot</dfn> might have to resize the generated image. This happens, for example, when the dimensions of a frame extracted from a video do not match the chosen \`width\` and \`height\` parameters.
77
77
78
-
See the list of available [resize strategies](/docs/robots/image-resize/#resize-strategies) for more details.
78
+
See the list of available [resize strategies](/docs/topics/resize-strategies/) for more details.
The hexadecimal code of the color used to fill the background (only used for the pad resize strategy). The format is \`#rrggbb[aa]\` (red, green, blue, alpha). Use \`#00000000\` for a transparent padding.
Copy file name to clipboardExpand all lines: src/alphalib/types/robots/google-store.ts
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -59,9 +59,9 @@ Go back to your Google credentials project and enable the "Google Cloud Storage
59
59
60
60
Now you can set up the \`storage.objects.create\` and \`storage.objects.delete\` permissions. The latter is optional and only required if you intend to overwrite existing paths.
61
61
62
-
To do this from the Google Cloud console, navigate to "IAM & Admin" and select "Roles". From here, select "+CREATE ROLE", enter a name, set the role launch stage as general availability and set the permissions stated above.
62
+
To do this from the Google Cloud console, navigate to "IAM & Admin" and select "Roles". From here, click "Create Role", enter a name, set the role launch stage to _General availability,_ and set the permissions stated above.
63
63
64
-
Next, relocate to your storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "ADD MEMBER", enter your service account as a new member and select your newly created role.
64
+
Next, go to Storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "Add Member", enter your service account as a new member, and select your newly created role.
65
65
66
66
Then, create your associated [Template Credentials](/c/template-credentials/) in your Transloadit account and use the name of your <dfn>Template Credentials</dfn> as this parameter's value.
Copy file name to clipboardExpand all lines: src/alphalib/types/robots/image-resize.ts
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -105,10 +105,10 @@ In this example, the background color is determined by the [Assembly Variable](h
105
105
),
106
106
])
107
107
.default('fit').describe(`
108
-
See the list of available [resize strategies](/docs/robots/image-resize/#resize-strategies).
108
+
See the list of available [resize strategies](/docs/topics/resize-strategies/).
109
109
`),
110
110
zoom: z.boolean().default(true).describe(`
111
-
If this is set to \`false\`, smaller images will not be stretched to the desired width and height. For details about the impact of zooming for your preferred resize strategy, see the list of available [resize strategies](/docs/robots/image-resize/#resize-strategies).
111
+
If this is set to \`false\`, smaller images will not be stretched to the desired width and height. For details about the impact of zooming for your preferred resize strategy, see the list of available [resize strategies](/docs/topics/resize-strategies/).
Specify an object containing coordinates for the top left and bottom right corners of the rectangle to be cropped from the original image(s). The coordinate system is rooted in the top left corner of the image. Values can be integers for absolute pixel values or strings for percentage based values.
@@ -129,7 +129,7 @@ This will crop the area from \`(80, 100)\` to \`(600, 800)\` from a 1000×1000 p
129
129
You can also use a JSON string of such an object with coordinates in similar fashion:
To crop around human faces, see [🤖/image/facedetect](/docs/robots/image-facedetect/).
@@ -265,7 +265,7 @@ Increases or decreases the saturation of the image by using a multiplier. For ex
265
265
Changes the hue by rotating the color of the image. The value \`100\` would produce no change whereas \`0\` and \`200\` will negate the colors in the image.
266
266
`),
267
267
watermark_url: z.string().optional().describe(`
268
-
A URL indicating a PNG image to be overlaid above this image. Please note that you can also [supply the watermark via another Assembly Step](/docs/robots/image-resize/#image-resize-supply-watermark-via-assembly-step). With watermarking you can add an image onto another image. This is usually used for logos.
268
+
A URL indicating a PNG image to be overlaid above this image. Please note that you can also [supply the watermark via another Assembly Step](/docs/topics/use-parameter/#supplying-the-watermark-via-an-assembly-step). With watermarking you can add an image onto another image. This is usually used for logos.
Copy file name to clipboardExpand all lines: src/alphalib/types/robots/tus-store.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ To change the \`title\` or \`description\` per video, we recommend to [inject va
59
59
The URL of the Tus-compatible server, which you're uploading files to.
60
60
`),
61
61
credentials: z.string().optional().describe(`
62
-
Create <dfn>Template Credentials</dfn> for this <dfn>Robot</dfn> in your [Transloadit account]({{site.base_url}}/c/template-credentials/) and use the name of the <dfn>Template Credentials</dfn> as this parameter's value. For this <dfn>Robot</dfn>, use the HTTP template, which allows request headers to be passed along to the destination server.
62
+
Create <dfn>Template Credentials</dfn> for this <dfn>Robot</dfn> in your [Transloadit account](/c/template-credentials/) and use the name of the <dfn>Template Credentials</dfn> as this parameter's value. For this <dfn>Robot</dfn>, use the HTTP template, which allows request headers to be passed along to the destination server.
63
63
`),
64
64
headers: z.record(z.string()).default({}).describe('Headers to pass along to destination')
If the given width/height parameters are bigger than the input image's dimensions, then the \`resize_strategy\` determines how the image will be resized to match the provided width/height. See the [available resize strategies](/docs/robots/image-resize/#resize-strategies).
47
+
If the given width/height parameters are bigger than the input image's dimensions, then the \`resize_strategy\` determines how the image will be resized to match the provided width/height. See the [available resize strategies](/docs/topics/resize-strategies/).
The background color of the resulting video the \`"rrggbbaa"\` format (red, green, blue, alpha) when used with the \`"pad"\` resize strategy. The default color is black.
The background color of the resulting thumbnails in the \`"rrggbbaa"\` format (red, green, blue, alpha) when used with the \`"pad"\` resize strategy. The default color is black.
0 commit comments