Skip to content

Commit c9328c6

Browse files
authored
Update render.md
1 parent 114bb73 commit c9328c6

File tree

1 file changed

+14
-42
lines changed

1 file changed

+14
-42
lines changed

packages/docs/docs/lambda/cli/render.md

+14-42
Original file line numberDiff line numberDiff line change
@@ -102,35 +102,27 @@ Minimum value: <MinimumFramesPerLambda />
102102
The `framesPerLambda` parameter cannot result in more than 200 functions being spawned. See: [Concurrency](/docs/lambda/concurrency)
103103
:::
104104

105-
### `--concurrency-per-lambda`
106-
107-
_Available from v3.0.30_
105+
### `--concurrency-per-lambda` <AvailableFrom v="3.0.30" />
108106

109107
By default, each Lambda function renders with concurrency 1 (one open browser tab). You may use the option to customize this value.
110108

111109
### `--quality`
112110

113111
[Value between 0 and 100 for JPEG rendering quality](/docs/config#setquality). Doesn't work when PNG frames are rendered.
114112

115-
### `--muted`
116-
117-
_available from v3.2.1_
113+
### `--muted` <AvailableFrom v="3.2.1" />
118114

119115
[Disables audio output.](/docs/config#setmuted) This option may only be used when rendering a video.
120116

121117
### `--codec`
122118

123119
[`h264` or `h265` or `png` or `vp8` or `mp3` or `aac` or `wav` or `prores`](/docs/config#setcodec). If you don't supply `--codec`, it will use `h264`.
124120

125-
### `--audio-codec`
126-
127-
_Available from v3.3.42_
121+
### `--audio-codec` <AvailableFrom v="3.3.42" />
128122

129123
[Set which codec the audio should have.](/docs/config#setaudiocodec) For defaults and possible values, refer to the [Encoding guide](/docs/encoding/#audio-codec).
130124

131-
### `--audio-bitrate`
132-
133-
_Available from v3.2.32_
125+
### `--audio-bitrate` <AvailableFrom v="3.2.32" />
134126

135127
Specify the target bitrate for the generated audio.
136128
The syntax for FFMPEGs `-b:a` parameter should be used.
@@ -174,72 +166,52 @@ Specify a location for a dotenv file. Default `.env`.
174166

175167
[Render a subset of a video](/docs/config#setframerange). Example: `--frames=0-9` to select the first 10 frames. To render a still, use the [`still`](/docs/lambda/cli/still) command.
176168

177-
### `--every-nth-frame`
178-
179-
_available from v3.1_
169+
### `--every-nth-frame` <AvailableFrom v="3.1.0" />
180170

181171
[Render only every nth frame.](/docs/config#seteverynthframe) This option may only be set when rendering GIFs. This allows you to lower the FPS of the GIF.
182172

183173
For example only every second frame, every third frame and so on. Only works for rendering GIFs. [See here for more details.](/docs/render-as-gif)
184174

185-
### `--number-of-gif-loops`
186-
187-
_available from v3.1_
175+
### `--number-of-gif-loops` <AvailableFrom v="3.1.0" />
188176

189177
[Set the looping behavior.](/docs/config#setnumberofgifloops) This option may only be set when rendering GIFs. [See here for more details.](/docs/render-as-gif#changing-the-number-of-loops)
190178

191179
### `--out-name`
192180

193181
The file name of the media output as stored in the S3 bucket. By default, it is `out` plus the appropriate file extension, for example: `out.mp4`. Must match `/([0-9a-zA-Z-!_.*'()/]+)/g`.
194182

195-
### `--overwrite`
196-
197-
_available from v3.2.25_
183+
### `--overwrite` <AvailableFrom v="3.2.25" />
198184

199185
If a custom out name is specified and a file already exists at this key in the S3 bucket, decide whether that file will be deleted before the render begins. Default `false`.
200186

201187
An existing file at the output S3 key will conflict with the render and must be deleted beforehand. If this setting is `false` and a conflict occurs, an error will be thrown.
202188

203-
### `--webhook`
204-
205-
_available from v3.2.30_
189+
### `--webhook` <AvailableFrom v="3.2.30" />
206190

207191
Sets a webhook to be called when the render finishes or fails. [`renderMediaOnLambda() -> webhook.url`](/docs/lambda/rendermediaonlambda#webhook). To be used together with `--webhook-secret`.
208192

209-
### `--webhook-secret`
210-
211-
_available from v3.2.30_
193+
### `--webhook-secret` <AvailableFrom v="3.2.30" />
212194

213195
Sets a webhook secret for the webhook (see above). [`renderMediaOnLambda() -> webhook.secret`](/docs/lambda/rendermediaonlambda#webhook). To be used together with `--webhook`.
214196

215-
### `--height`
216-
217-
_available from v3.2.40_
197+
### `--height` <AvailableFrom v="3.2.40" />
218198

219199
[Overrides composition height.](/docs/config#overrideheight)
220200

221-
### `--width`
222-
223-
_available from v3.2.40_
201+
### `--width` <AvailableFrom v="3.2.40" />
224202

225203
[Overrides composition width.](/docs/config#overridewidth)
226204

227-
### `--function-name`
228-
229-
_available from v3.3.38_
205+
### `--function-name` <AvailableFrom v="3.3.38" />
230206

231207
Specify the name of the function which should be used to invoke and orchestrate the render. You only need to pass it if there are multiple functions with different configurations.
232208

233-
### `--renderer-function-name`
234-
235-
_available from v3.3.38_
209+
### `--renderer-function-name` <AvailableFrom v="3.3.38" />
236210

237211
If specified, this function will be used for rendering the individual chunks. This is useful if you want to use a function with higher or lower power for rendering the chunks than the main orchestration function.
238212

239213
If you want to use this option, the function must be in the same region, the same account and have the same version as the main function.
240214

241-
### `--force-bucket-name`
242-
243-
_available from v3.3.42_
215+
### `--force-bucket-name` <AvailableFrom v="3.3.42" />
244216

245217
Specify a specific bucket name to be used. [This is not recommended](/docs/lambda/multiple-buckets), instead let Remotion discover the right bucket automatically.

0 commit comments

Comments
 (0)