@remotion/lambda 4.0.243 → 4.0.245
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/dist/admin/make-layer-public.js +10 -11
- package/dist/api/create-function.d.ts +1 -2
- package/dist/api/create-function.js +10 -10
- package/dist/api/delete-function.d.ts +0 -7
- package/dist/api/delete-function.js +2 -5
- package/dist/api/delete-render.d.ts +0 -8
- package/dist/api/delete-render.js +2 -6
- package/dist/api/delete-site.d.ts +0 -10
- package/dist/api/delete-site.js +3 -9
- package/dist/api/deploy-function.d.ts +3 -14
- package/dist/api/deploy-function.js +5 -13
- package/dist/api/deploy-site.d.ts +0 -9
- package/dist/api/deploy-site.js +3 -8
- package/dist/api/download-media.d.ts +0 -11
- package/dist/api/download-media.js +1 -8
- package/dist/api/estimate-price.d.ts +0 -6
- package/dist/api/estimate-price.js +1 -3
- package/dist/api/get-aws-client.d.ts +0 -8
- package/dist/api/get-aws-client.js +2 -6
- package/dist/api/get-compositions-on-lambda.d.ts +0 -13
- package/dist/api/get-compositions-on-lambda.js +2 -11
- package/dist/api/get-function-info.d.ts +0 -7
- package/dist/api/get-function-info.js +2 -5
- package/dist/api/get-functions.d.ts +0 -7
- package/dist/api/get-functions.js +2 -5
- package/dist/api/get-or-create-bucket.d.ts +0 -6
- package/dist/api/get-or-create-bucket.js +3 -5
- package/dist/api/get-regions.d.ts +0 -5
- package/dist/api/get-regions.js +3 -4
- package/dist/api/get-render-progress.d.ts +0 -10
- package/dist/api/get-render-progress.js +1 -7
- package/dist/api/get-sites.d.ts +0 -6
- package/dist/api/get-sites.js +3 -5
- package/dist/api/iam-validation/simulate.d.ts +0 -7
- package/dist/api/iam-validation/simulate.js +2 -5
- package/dist/api/iam-validation/suggested-policy.d.ts +0 -10
- package/dist/api/iam-validation/suggested-policy.js +2 -4
- package/dist/api/presign-url.d.ts +0 -10
- package/dist/api/presign-url.js +2 -8
- package/dist/api/render-media-on-lambda.d.ts +0 -19
- package/dist/api/render-media-on-lambda.js +2 -17
- package/dist/api/render-still-on-lambda.d.ts +0 -16
- package/dist/api/render-still-on-lambda.js +3 -15
- package/dist/api/speculate-function-name.d.ts +0 -8
- package/dist/api/speculate-function-name.js +3 -7
- package/dist/api/upload-dir.js +44 -27
- package/dist/api/validate-webhook-signature.d.ts +0 -8
- package/dist/api/validate-webhook-signature.js +3 -7
- package/dist/cli/commands/functions/deploy.js +4 -1
- package/dist/cli/log.d.ts +3 -3
- package/dist/functions/http-client.d.ts +7 -0
- package/dist/functions/http-client.js +22 -0
- package/dist/index.js +26 -5
- package/dist/pricing/price-per-1-s.js +102 -0
- package/dist/regions.d.ts +1 -1
- package/dist/regions.js +3 -0
- package/dist/shared/call-lambda-async.d.ts +3 -0
- package/dist/shared/call-lambda-async.js +20 -0
- package/dist/shared/call-lambda-streaming.d.ts +7 -0
- package/dist/shared/call-lambda-streaming.js +124 -0
- package/dist/shared/call-lambda-sync.d.ts +3 -0
- package/dist/shared/call-lambda-sync.js +30 -0
- package/dist/shared/get-layers.d.ts +1 -2
- package/dist/shared/get-layers.js +2 -4
- package/dist/shared/hosted-layers.d.ts +0 -1
- package/dist/shared/hosted-layers.js +139 -537
- package/dist/shared/lambda-insights-extensions.d.ts +1 -1
- package/dist/shared/lambda-insights-extensions.js +3 -0
- package/dist/shared/validate-aws-region.js +1 -1
- package/package.json +12 -12
- package/remotionlambda-arm64.zip +0 -0
package/LICENSE.md
CHANGED
|
@@ -27,10 +27,15 @@ const layerInfo = {
|
|
|
27
27
|
'me-south-1': [],
|
|
28
28
|
'sa-east-1': [],
|
|
29
29
|
'us-west-1': [],
|
|
30
|
+
'ap-southeast-4': [],
|
|
31
|
+
'ap-southeast-5': [],
|
|
32
|
+
'eu-central-2': [],
|
|
33
|
+
};
|
|
34
|
+
const getBucketName = (region) => {
|
|
35
|
+
return `remotionlambda-binaries-${region}`;
|
|
30
36
|
};
|
|
31
|
-
const V5_RUNTIME = true;
|
|
32
37
|
const makeLayerPublic = async () => {
|
|
33
|
-
const runtimes = [
|
|
38
|
+
const runtimes = ['nodejs20.x'];
|
|
34
39
|
const layers = [
|
|
35
40
|
'fonts',
|
|
36
41
|
'chromium',
|
|
@@ -43,18 +48,12 @@ const makeLayerPublic = async () => {
|
|
|
43
48
|
const layerName = `remotion-binaries-${layer}-arm64`;
|
|
44
49
|
const { Version, LayerArn } = await (0, aws_clients_1.getLambdaClient)(region).send(new client_lambda_1.PublishLayerVersionCommand({
|
|
45
50
|
Content: {
|
|
46
|
-
S3Bucket:
|
|
47
|
-
S3Key: layer
|
|
48
|
-
? 'remotion-layer-emoji-v1-arm64.zip'
|
|
49
|
-
: V5_RUNTIME
|
|
50
|
-
? `remotion-layer-${layer}-v11-arm64.zip`
|
|
51
|
-
: `remotion-layer-${layer}-v10-arm64.zip`,
|
|
51
|
+
S3Bucket: getBucketName(region),
|
|
52
|
+
S3Key: `remotion-layer-${layer}-v12-arm64.zip`,
|
|
52
53
|
},
|
|
53
54
|
LayerName: layerName,
|
|
54
55
|
LicenseInfo: layer === 'chromium'
|
|
55
|
-
?
|
|
56
|
-
? 'Chromium 123.0.6312.86, compiled from source. Read Chromium License: https://chromium.googlesource.com/chromium/src/+/refs/heads/main/LICENSE'
|
|
57
|
-
: 'Chromium 114, compiled from source. Read Chromium License: https://chromium.googlesource.com/chromium/src/+/refs/heads/main/LICENSE'
|
|
56
|
+
? 'Chromium 123.0.6312.86, compiled from source. Read Chromium License: https://chromium.googlesource.com/chromium/src/+/refs/heads/main/LICENSE'
|
|
58
57
|
: layer === 'emoji-apple'
|
|
59
58
|
? 'Apple Emojis (https://github.com/samuelngs/apple-emoji-linux). For educational purposes only - Apple is a trademark of Apple Inc., registered in the U.S. and other countries.'
|
|
60
59
|
: layer === 'emoji-google'
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { LogLevel } from '@remotion/renderer';
|
|
2
2
|
import type { AwsRegion } from '../regions';
|
|
3
3
|
import type { RuntimePreference } from '../shared/get-layers';
|
|
4
|
-
export declare const createFunction: ({ createCloudWatchLogGroup, region, zipFile, functionName, accountId, memorySizeInMb, timeoutInSeconds, alreadyCreated, retentionInDays, ephemerealStorageInMb, customRoleArn, enableLambdaInsights,
|
|
4
|
+
export declare const createFunction: ({ createCloudWatchLogGroup, region, zipFile, functionName, accountId, memorySizeInMb, timeoutInSeconds, alreadyCreated, retentionInDays, ephemerealStorageInMb, customRoleArn, enableLambdaInsights, logLevel, vpcSubnetIds, vpcSecurityGroupIds, runtimePreference, }: {
|
|
5
5
|
createCloudWatchLogGroup: boolean;
|
|
6
6
|
region: AwsRegion;
|
|
7
7
|
zipFile: string;
|
|
@@ -14,7 +14,6 @@ export declare const createFunction: ({ createCloudWatchLogGroup, region, zipFil
|
|
|
14
14
|
ephemerealStorageInMb: number;
|
|
15
15
|
customRoleArn: string;
|
|
16
16
|
enableLambdaInsights: boolean;
|
|
17
|
-
enableV5Runtime: boolean;
|
|
18
17
|
logLevel: LogLevel;
|
|
19
18
|
vpcSubnetIds: string;
|
|
20
19
|
vpcSecurityGroupIds: string;
|
|
@@ -11,7 +11,7 @@ const aws_clients_1 = require("../shared/aws-clients");
|
|
|
11
11
|
const get_layers_1 = require("../shared/get-layers");
|
|
12
12
|
const lambda_insights_extensions_1 = require("../shared/lambda-insights-extensions");
|
|
13
13
|
const suggested_policy_1 = require("./iam-validation/suggested-policy");
|
|
14
|
-
const createFunction = async ({ createCloudWatchLogGroup, region, zipFile, functionName, accountId, memorySizeInMb, timeoutInSeconds, alreadyCreated, retentionInDays, ephemerealStorageInMb, customRoleArn, enableLambdaInsights,
|
|
14
|
+
const createFunction = async ({ createCloudWatchLogGroup, region, zipFile, functionName, accountId, memorySizeInMb, timeoutInSeconds, alreadyCreated, retentionInDays, ephemerealStorageInMb, customRoleArn, enableLambdaInsights, logLevel, vpcSubnetIds, vpcSecurityGroupIds, runtimePreference, }) => {
|
|
15
15
|
var _a;
|
|
16
16
|
if (createCloudWatchLogGroup) {
|
|
17
17
|
renderer_1.RenderInternals.Log.verbose({ indent: false, logLevel }, 'Creating CloudWatch group');
|
|
@@ -45,11 +45,7 @@ const createFunction = async ({ createCloudWatchLogGroup, region, zipFile, funct
|
|
|
45
45
|
const layers = (0, get_layers_1.getLayers)({
|
|
46
46
|
option: runtimePreference,
|
|
47
47
|
region,
|
|
48
|
-
enableV5Runtime,
|
|
49
48
|
});
|
|
50
|
-
if (enableV5Runtime) {
|
|
51
|
-
renderer_1.RenderInternals.Log.verbose({ indent: false, logLevel }, 'New V5 runtime enabled https://remotion.dev/docs/lambda/runtime#runtime-changes-in-remotion-50');
|
|
52
|
-
}
|
|
53
49
|
let vpcConfig;
|
|
54
50
|
if (vpcSubnetIds && vpcSecurityGroupIds) {
|
|
55
51
|
vpcConfig = {
|
|
@@ -58,6 +54,12 @@ const createFunction = async ({ createCloudWatchLogGroup, region, zipFile, funct
|
|
|
58
54
|
};
|
|
59
55
|
}
|
|
60
56
|
renderer_1.RenderInternals.Log.verbose({ indent: false, logLevel }, 'Deploying new Lambda function');
|
|
57
|
+
const insightsLayer = enableLambdaInsights
|
|
58
|
+
? lambda_insights_extensions_1.lambdaInsightsExtensions[region]
|
|
59
|
+
: null;
|
|
60
|
+
if (enableLambdaInsights && !insightsLayer) {
|
|
61
|
+
throw new Error(`Lambda Insights is not supported by AWS in region ${region}. Please disable Lambda Insights. See http://remotion.dev/docs/lambda/insights#unsupported-regions`);
|
|
62
|
+
}
|
|
61
63
|
const { FunctionName, FunctionArn } = await (0, aws_clients_1.getLambdaClient)(region).send(new client_lambda_1.CreateFunctionCommand({
|
|
62
64
|
Code: {
|
|
63
65
|
ZipFile: (0, node_fs_1.readFileSync)(zipFile),
|
|
@@ -65,13 +67,13 @@ const createFunction = async ({ createCloudWatchLogGroup, region, zipFile, funct
|
|
|
65
67
|
FunctionName: functionName,
|
|
66
68
|
Handler: 'index.handler',
|
|
67
69
|
Role: customRoleArn !== null && customRoleArn !== void 0 ? customRoleArn : defaultRoleName,
|
|
68
|
-
Runtime:
|
|
70
|
+
Runtime: 'nodejs20.x',
|
|
69
71
|
Description: 'Renders a Remotion video.',
|
|
70
72
|
MemorySize: memorySizeInMb,
|
|
71
73
|
Timeout: timeoutInSeconds,
|
|
72
74
|
Layers: layers
|
|
73
75
|
.map(({ layerArn, version }) => `${layerArn}:${version}`)
|
|
74
|
-
.concat(
|
|
76
|
+
.concat(insightsLayer ? [insightsLayer] : []),
|
|
75
77
|
Architectures: ['arm64'],
|
|
76
78
|
EphemeralStorage: {
|
|
77
79
|
Size: ephemerealStorageInMb,
|
|
@@ -119,9 +121,7 @@ const createFunction = async ({ createCloudWatchLogGroup, region, zipFile, funct
|
|
|
119
121
|
}
|
|
120
122
|
renderer_1.RenderInternals.Log.verbose({ indent: false, logLevel }, 'Function is now ready.');
|
|
121
123
|
renderer_1.RenderInternals.Log.verbose({ indent: false, logLevel }, 'Locking the runtime version of the function...');
|
|
122
|
-
const RuntimeVersionArn =
|
|
123
|
-
? `arn:aws:lambda:${region}::runtime:da57c20c4b965d5b75540f6865a35fc8030358e33ec44ecfed33e90901a27a72`
|
|
124
|
-
: `arn:aws:lambda:${region}::runtime:b97ad873eb5228db2e7d5727cd116734cc24c92ff1381739c4400c095404a2d3`;
|
|
124
|
+
const RuntimeVersionArn = `arn:aws:lambda:${region}::runtime:da57c20c4b965d5b75540f6865a35fc8030358e33ec44ecfed33e90901a27a72`;
|
|
125
125
|
try {
|
|
126
126
|
await (0, aws_clients_1.getLambdaClient)(region).send(new client_lambda_1.PutRuntimeManagementConfigCommand({
|
|
127
127
|
FunctionName,
|
|
@@ -3,11 +3,4 @@ export type DeleteFunctionInput = {
|
|
|
3
3
|
region: AwsRegion;
|
|
4
4
|
functionName: string;
|
|
5
5
|
};
|
|
6
|
-
/**
|
|
7
|
-
* @description Deletes a function from AWS Lambda.
|
|
8
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/deletefunction)
|
|
9
|
-
* @param params.region The region the function was deployed to.
|
|
10
|
-
* @param params.functionName The name of the function.
|
|
11
|
-
* @returns {Promise<void>} Nothing. Throws if the function failed to delete.
|
|
12
|
-
*/
|
|
13
6
|
export declare const deleteFunction: ({ region, functionName, }: DeleteFunctionInput) => Promise<void>;
|
|
@@ -3,12 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.deleteFunction = void 0;
|
|
4
4
|
const client_lambda_1 = require("@aws-sdk/client-lambda");
|
|
5
5
|
const aws_clients_1 = require("../shared/aws-clients");
|
|
6
|
-
|
|
7
|
-
* @description Deletes a function
|
|
6
|
+
/*
|
|
7
|
+
* @description Deletes a deployed Lambda function based on its name.
|
|
8
8
|
* @see [Documentation](https://remotion.dev/docs/lambda/deletefunction)
|
|
9
|
-
* @param params.region The region the function was deployed to.
|
|
10
|
-
* @param params.functionName The name of the function.
|
|
11
|
-
* @returns {Promise<void>} Nothing. Throws if the function failed to delete.
|
|
12
9
|
*/
|
|
13
10
|
const deleteFunction = async ({ region, functionName, }) => {
|
|
14
11
|
await (0, aws_clients_1.getLambdaClient)(region).send(new client_lambda_1.DeleteFunctionCommand({
|
|
@@ -15,14 +15,6 @@ export declare const internalDeleteRender: (input: DeleteRenderInput & {
|
|
|
15
15
|
}) => Promise<{
|
|
16
16
|
freedBytes: number;
|
|
17
17
|
}>;
|
|
18
|
-
/**
|
|
19
|
-
* @description Deletes a render artifact and it's metadata given it's renderId.
|
|
20
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/deleterender)
|
|
21
|
-
* @param params.region The AWS region in which the media resides.
|
|
22
|
-
* @param params.bucketName The `bucketName` that was specified during the render
|
|
23
|
-
* @param params.renderId The `renderId` that was obtained after triggering the render.
|
|
24
|
-
* @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
|
|
25
|
-
*/
|
|
26
18
|
export declare const deleteRender: (input: DeleteRenderInput) => Promise<{
|
|
27
19
|
freedBytes: number;
|
|
28
20
|
}>;
|
|
@@ -66,13 +66,9 @@ const internalDeleteRender = async (input) => {
|
|
|
66
66
|
};
|
|
67
67
|
};
|
|
68
68
|
exports.internalDeleteRender = internalDeleteRender;
|
|
69
|
-
|
|
70
|
-
* @description Deletes a
|
|
69
|
+
/*
|
|
70
|
+
* @description Deletes a rendered video, audio or still and its associated metadata.
|
|
71
71
|
* @see [Documentation](https://remotion.dev/docs/lambda/deleterender)
|
|
72
|
-
* @param params.region The AWS region in which the media resides.
|
|
73
|
-
* @param params.bucketName The `bucketName` that was specified during the render
|
|
74
|
-
* @param params.renderId The `renderId` that was obtained after triggering the render.
|
|
75
|
-
* @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
|
|
76
72
|
*/
|
|
77
73
|
const deleteRender = (input) => {
|
|
78
74
|
return (0, exports.internalDeleteRender)({
|
|
@@ -21,15 +21,5 @@ export type DeleteSiteOutput = {
|
|
|
21
21
|
export declare const internalDeleteSite: ({ bucketName, siteName, region, onAfterItemDeleted, providerSpecifics, forcePathStyle, }: DeleteSiteInput & {
|
|
22
22
|
providerSpecifics: ProviderSpecifics<AwsProvider>;
|
|
23
23
|
}) => Promise<DeleteSiteOutput>;
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
* @description Deletes a deployed site from your S3 bucket. The opposite of deploySite().
|
|
27
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/deletesite)
|
|
28
|
-
* @param params.bucketName The S3 bucket name where the site resides in.
|
|
29
|
-
* @param params.siteName The ID of the site that you want to delete.
|
|
30
|
-
* @param {AwsRegion} params.region The region in where the S3 bucket resides in.
|
|
31
|
-
* @param params.onAfterItemDeleted Function that gets called after each file that gets deleted, useful for showing progress.
|
|
32
|
-
* @returns {Promise<DeleteSiteOutput>} Object containing info about how much space was freed.
|
|
33
|
-
*/
|
|
34
24
|
export declare const deleteSite: (props: DeleteSiteOptionalInput) => Promise<DeleteSiteOutput>;
|
|
35
25
|
export {};
|
package/dist/api/delete-site.js
CHANGED
|
@@ -44,15 +44,9 @@ const internalDeleteSite = async ({ bucketName, siteName, region, onAfterItemDel
|
|
|
44
44
|
};
|
|
45
45
|
};
|
|
46
46
|
exports.internalDeleteSite = internalDeleteSite;
|
|
47
|
-
|
|
48
|
-
*
|
|
49
|
-
* @
|
|
50
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/deletesite)
|
|
51
|
-
* @param params.bucketName The S3 bucket name where the site resides in.
|
|
52
|
-
* @param params.siteName The ID of the site that you want to delete.
|
|
53
|
-
* @param {AwsRegion} params.region The region in where the S3 bucket resides in.
|
|
54
|
-
* @param params.onAfterItemDeleted Function that gets called after each file that gets deleted, useful for showing progress.
|
|
55
|
-
* @returns {Promise<DeleteSiteOutput>} Object containing info about how much space was freed.
|
|
47
|
+
/*
|
|
48
|
+
* @description Removes a Remotion project from your Cloud Storage bucket.
|
|
49
|
+
* @see [Documentation](https://remotion.dev/docs/cloudrun/deletesite)
|
|
56
50
|
*/
|
|
57
51
|
const deleteSite = (props) => {
|
|
58
52
|
var _a, _b;
|
|
@@ -14,7 +14,6 @@ type OptionalParameters = {
|
|
|
14
14
|
enableLambdaInsights: boolean;
|
|
15
15
|
indent: boolean;
|
|
16
16
|
logLevel: LogLevel;
|
|
17
|
-
enableV5Runtime: boolean;
|
|
18
17
|
vpcSubnetIds: string | undefined;
|
|
19
18
|
vpcSecurityGroupIds: string | undefined;
|
|
20
19
|
runtimePreference: RuntimePreference;
|
|
@@ -25,17 +24,7 @@ export type DeployFunctionOutput = {
|
|
|
25
24
|
alreadyExisted: boolean;
|
|
26
25
|
};
|
|
27
26
|
export declare const internalDeployFunction: (params: MandatoryParameters & OptionalParameters) => Promise<DeployFunctionOutput>;
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
* @param params.createCloudWatchLogGroup Whether you'd like to create a CloudWatch Log Group to store the logs for this function.
|
|
32
|
-
* @param params.cloudWatchLogRetentionPeriodInDays (optional) The number of days to retain the CloudWatch logs for this function. Default is 14 days.
|
|
33
|
-
* @param params.region The region you want to deploy your function to.
|
|
34
|
-
* @param params.timeoutInSeconds After how many seconds the lambda function should be killed if it does not end itself.
|
|
35
|
-
* @param params.memorySizeInMb How much memory should be allocated to the Lambda function.
|
|
36
|
-
* @param params.architecture The architecture Lambda should run on. One of x86_64 and x64
|
|
37
|
-
* @param params.diskSizeInMb The amount of storage the function should be allocated. The higher, the longer videos you can render. Default 512.
|
|
38
|
-
* @returns {Promise<DeployFunctionOutput>} An object that contains the `functionName` property
|
|
39
|
-
*/
|
|
40
|
-
export declare const deployFunction: ({ createCloudWatchLogGroup, memorySizeInMb, region, timeoutInSeconds, cloudWatchLogRetentionPeriodInDays, customRoleArn, enableLambdaInsights, indent, logLevel, enableV5Runtime, vpcSubnetIds, vpcSecurityGroupIds, runtimePreference, diskSizeInMb, }: DeployFunctionInput) => Promise<DeployFunctionOutput>;
|
|
27
|
+
export declare const deployFunction: ({ createCloudWatchLogGroup, memorySizeInMb, region, timeoutInSeconds, cloudWatchLogRetentionPeriodInDays, customRoleArn, enableLambdaInsights, indent, logLevel, enableV5Runtime, vpcSubnetIds, vpcSecurityGroupIds, runtimePreference, diskSizeInMb, }: DeployFunctionInput & {
|
|
28
|
+
enableV5Runtime?: boolean;
|
|
29
|
+
}) => Promise<DeployFunctionOutput>;
|
|
41
30
|
export {};
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.deployFunction = exports.internalDeployFunction = void 0;
|
|
4
4
|
const error_handling_1 = require("@remotion/renderer/error-handling");
|
|
5
|
-
const no_react_1 = require("remotion/no-react");
|
|
6
5
|
const version_1 = require("remotion/version");
|
|
7
6
|
const get_functions_1 = require("../api/get-functions");
|
|
8
7
|
const constants_1 = require("../shared/constants");
|
|
@@ -54,7 +53,6 @@ const internalDeployFunction = async (params) => {
|
|
|
54
53
|
ephemerealStorageInMb: params.diskSizeInMb,
|
|
55
54
|
customRoleArn: params.customRoleArn,
|
|
56
55
|
enableLambdaInsights: (_b = params.enableLambdaInsights) !== null && _b !== void 0 ? _b : false,
|
|
57
|
-
enableV5Runtime: params.enableV5Runtime,
|
|
58
56
|
logLevel: params.logLevel,
|
|
59
57
|
vpcSubnetIds: params.vpcSubnetIds,
|
|
60
58
|
vpcSecurityGroupIds: params.vpcSecurityGroupIds,
|
|
@@ -70,19 +68,14 @@ const internalDeployFunction = async (params) => {
|
|
|
70
68
|
};
|
|
71
69
|
exports.internalDeployFunction = internalDeployFunction;
|
|
72
70
|
const errorHandled = (0, error_handling_1.wrapWithErrorHandling)(exports.internalDeployFunction);
|
|
73
|
-
|
|
71
|
+
/*
|
|
74
72
|
* @description Creates an AWS Lambda function in your account that will be able to render a video in the cloud.
|
|
75
|
-
* @see [Documentation](https://
|
|
76
|
-
* @param params.createCloudWatchLogGroup Whether you'd like to create a CloudWatch Log Group to store the logs for this function.
|
|
77
|
-
* @param params.cloudWatchLogRetentionPeriodInDays (optional) The number of days to retain the CloudWatch logs for this function. Default is 14 days.
|
|
78
|
-
* @param params.region The region you want to deploy your function to.
|
|
79
|
-
* @param params.timeoutInSeconds After how many seconds the lambda function should be killed if it does not end itself.
|
|
80
|
-
* @param params.memorySizeInMb How much memory should be allocated to the Lambda function.
|
|
81
|
-
* @param params.architecture The architecture Lambda should run on. One of x86_64 and x64
|
|
82
|
-
* @param params.diskSizeInMb The amount of storage the function should be allocated. The higher, the longer videos you can render. Default 512.
|
|
83
|
-
* @returns {Promise<DeployFunctionOutput>} An object that contains the `functionName` property
|
|
73
|
+
* @see [Documentation](https://remotion.dev/docs/lambda/deployfunction)
|
|
84
74
|
*/
|
|
85
75
|
const deployFunction = ({ createCloudWatchLogGroup, memorySizeInMb, region, timeoutInSeconds, cloudWatchLogRetentionPeriodInDays, customRoleArn, enableLambdaInsights, indent, logLevel, enableV5Runtime, vpcSubnetIds, vpcSecurityGroupIds, runtimePreference, diskSizeInMb, }) => {
|
|
76
|
+
if (enableV5Runtime) {
|
|
77
|
+
console.warn('The `enableV5Runtime` option is now on by default. No need to specify it anymore.');
|
|
78
|
+
}
|
|
86
79
|
return errorHandled({
|
|
87
80
|
indent: indent !== null && indent !== void 0 ? indent : false,
|
|
88
81
|
logLevel: logLevel !== null && logLevel !== void 0 ? logLevel : 'info',
|
|
@@ -94,7 +87,6 @@ const deployFunction = ({ createCloudWatchLogGroup, memorySizeInMb, region, time
|
|
|
94
87
|
region,
|
|
95
88
|
timeoutInSeconds,
|
|
96
89
|
cloudWatchLogRetentionPeriodInDays,
|
|
97
|
-
enableV5Runtime: enableV5Runtime !== null && enableV5Runtime !== void 0 ? enableV5Runtime : no_react_1.NoReactInternals.ENABLE_V5_BREAKING_CHANGES,
|
|
98
90
|
vpcSubnetIds,
|
|
99
91
|
vpcSecurityGroupIds,
|
|
100
92
|
runtimePreference: runtimePreference !== null && runtimePreference !== void 0 ? runtimePreference : 'default',
|
|
@@ -97,15 +97,6 @@ export declare const internalDeploySite: (args_0: MandatoryParameters & {
|
|
|
97
97
|
untouchedFiles: number;
|
|
98
98
|
};
|
|
99
99
|
}>;
|
|
100
|
-
/**
|
|
101
|
-
* @description Deploys a Remotion project to an S3 bucket to prepare it for rendering on AWS Lambda.
|
|
102
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/deploysite)
|
|
103
|
-
* @param {AwsRegion} params.region The region in which the S3 bucket resides in.
|
|
104
|
-
* @param {string} params.entryPoint An absolute path to the entry file of your Remotion project.
|
|
105
|
-
* @param {string} params.bucketName The name of the bucket to deploy your project into.
|
|
106
|
-
* @param {string} params.siteName The name of the folder in which the project gets deployed to.
|
|
107
|
-
* @param {object} params.options Further options, see documentation page for this function.
|
|
108
|
-
*/
|
|
109
100
|
export declare const deploySite: (args: DeploySiteInput) => Promise<{
|
|
110
101
|
serveUrl: string;
|
|
111
102
|
siteName: string;
|
package/dist/api/deploy-site.js
CHANGED
|
@@ -120,14 +120,9 @@ const mandatoryDeploySite = async ({ bucketName, entryPoint, siteName, options,
|
|
|
120
120
|
};
|
|
121
121
|
};
|
|
122
122
|
exports.internalDeploySite = (0, error_handling_1.wrapWithErrorHandling)(mandatoryDeploySite);
|
|
123
|
-
|
|
124
|
-
* @description Deploys a Remotion project to
|
|
125
|
-
* @see [Documentation](https://remotion.dev/docs/
|
|
126
|
-
* @param {AwsRegion} params.region The region in which the S3 bucket resides in.
|
|
127
|
-
* @param {string} params.entryPoint An absolute path to the entry file of your Remotion project.
|
|
128
|
-
* @param {string} params.bucketName The name of the bucket to deploy your project into.
|
|
129
|
-
* @param {string} params.siteName The name of the folder in which the project gets deployed to.
|
|
130
|
-
* @param {object} params.options Further options, see documentation page for this function.
|
|
123
|
+
/*
|
|
124
|
+
* @description Deploys a Remotion project to a GCP storage bucket to prepare it for rendering on Cloud Run.
|
|
125
|
+
* @see [Documentation](https://remotion.dev/docs/cloudrun/deploysite)
|
|
131
126
|
*/
|
|
132
127
|
const deploySite = (args) => {
|
|
133
128
|
var _a, _b, _c, _d, _e, _f;
|
|
@@ -22,15 +22,4 @@ export declare const internalDownloadMedia: (input: DownloadMediaInput & {
|
|
|
22
22
|
providerSpecifics: ProviderSpecifics<AwsProvider>;
|
|
23
23
|
forcePathStyle: boolean;
|
|
24
24
|
}) => Promise<DownloadMediaOutput>;
|
|
25
|
-
/**
|
|
26
|
-
* @description Downloads a rendered video, audio or still to the disk of the machine this API is called from.
|
|
27
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/downloadmedia)
|
|
28
|
-
* @param params.region The AWS region in which the media resides.
|
|
29
|
-
* @param params.bucketName The `bucketName` that was specified during the render.
|
|
30
|
-
* @param params.renderId The `renderId` that was obtained after triggering the render.
|
|
31
|
-
* @param params.outPath Where to save the media.
|
|
32
|
-
* @param params.onProgress Progress callback function - see docs for details.
|
|
33
|
-
* @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
|
|
34
|
-
* @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
|
|
35
|
-
*/
|
|
36
25
|
export declare const downloadMedia: (input: DownloadMediaInput) => Promise<DownloadMediaOutput>;
|
|
@@ -47,16 +47,9 @@ const internalDownloadMedia = async (input) => {
|
|
|
47
47
|
};
|
|
48
48
|
};
|
|
49
49
|
exports.internalDownloadMedia = internalDownloadMedia;
|
|
50
|
-
|
|
50
|
+
/*
|
|
51
51
|
* @description Downloads a rendered video, audio or still to the disk of the machine this API is called from.
|
|
52
52
|
* @see [Documentation](https://remotion.dev/docs/lambda/downloadmedia)
|
|
53
|
-
* @param params.region The AWS region in which the media resides.
|
|
54
|
-
* @param params.bucketName The `bucketName` that was specified during the render.
|
|
55
|
-
* @param params.renderId The `renderId` that was obtained after triggering the render.
|
|
56
|
-
* @param params.outPath Where to save the media.
|
|
57
|
-
* @param params.onProgress Progress callback function - see docs for details.
|
|
58
|
-
* @param params.customCredentials If the file was saved to a foreign cloud, pass credentials for reading from it.
|
|
59
|
-
* @returns {Promise<RenderMediaOnLambdaOutput>} See documentation for detailed structure
|
|
60
53
|
*/
|
|
61
54
|
const downloadMedia = (input) => {
|
|
62
55
|
return (0, exports.internalDownloadMedia)({
|
|
@@ -13,11 +13,5 @@ export type EstimatePriceInput = {
|
|
|
13
13
|
diskSizeInMb: number;
|
|
14
14
|
lambdasInvoked: number;
|
|
15
15
|
} & Miliseconds;
|
|
16
|
-
/**
|
|
17
|
-
*
|
|
18
|
-
* @description Calculates the AWS costs incurred for AWS Lambda given the region, execution duration and memory size.
|
|
19
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/estimateprice)
|
|
20
|
-
* @returns {number} Price in USD
|
|
21
|
-
*/
|
|
22
16
|
export declare const estimatePrice: ({ region, memorySizeInMb, diskSizeInMb, lambdasInvoked, ...other }: EstimatePriceInput) => number;
|
|
23
17
|
export {};
|
|
@@ -6,11 +6,9 @@ const price_per_1_s_1 = require("../pricing/price-per-1-s");
|
|
|
6
6
|
const validate_aws_region_1 = require("../shared/validate-aws-region");
|
|
7
7
|
const validate_disk_size_in_mb_1 = require("../shared/validate-disk-size-in-mb");
|
|
8
8
|
const validate_memory_size_1 = require("../shared/validate-memory-size");
|
|
9
|
-
|
|
10
|
-
*
|
|
9
|
+
/*
|
|
11
10
|
* @description Calculates the AWS costs incurred for AWS Lambda given the region, execution duration and memory size.
|
|
12
11
|
* @see [Documentation](https://remotion.dev/docs/lambda/estimateprice)
|
|
13
|
-
* @returns {number} Price in USD
|
|
14
12
|
*/
|
|
15
13
|
const estimatePrice = ({ region, memorySizeInMb, diskSizeInMb, lambdasInvoked, ...other }) => {
|
|
16
14
|
(0, validate_memory_size_1.validateMemorySize)(memorySizeInMb);
|
|
@@ -26,13 +26,5 @@ export type GetAwsClientOutput<T extends keyof ServiceMapping> = {
|
|
|
26
26
|
client: ServiceMapping[T];
|
|
27
27
|
sdk: SdkMapping[T];
|
|
28
28
|
};
|
|
29
|
-
/**
|
|
30
|
-
* @description Gets the full AWS SDK and an instantiated client for an AWS service
|
|
31
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/getawsclient)
|
|
32
|
-
* @param {AwsRegion} params.region The region in which the S3 bucket resides in.
|
|
33
|
-
* @param {string} params.service One of `iam`, `s3`, `cloudwatch`, `iam` or `servicequotas`
|
|
34
|
-
* @param {CustomCredentials} params.customCredentials Pass endpoint and credentials if you want to connect to a different cloud for S3
|
|
35
|
-
* @returns {GetAwsClientOutput<T>} Returns `client` and `sdk` of a AWS service
|
|
36
|
-
*/
|
|
37
29
|
export declare const getAwsClient: <T extends keyof ServiceMapping>({ region, service, customCredentials, forcePathStyle, }: GetAwsClientInput<T>) => GetAwsClientOutput<T>;
|
|
38
30
|
export {};
|
|
@@ -31,13 +31,9 @@ const S3SDK = __importStar(require("@aws-sdk/client-s3"));
|
|
|
31
31
|
const ServiceQuotasSDK = __importStar(require("@aws-sdk/client-service-quotas"));
|
|
32
32
|
const StsSdk = __importStar(require("@aws-sdk/client-sts"));
|
|
33
33
|
const get_service_client_1 = require("../shared/get-service-client");
|
|
34
|
-
|
|
35
|
-
* @description
|
|
34
|
+
/*
|
|
35
|
+
* @description Exposes full access to the AWS SDK used by Remotion, allowing interaction with AWS infrastructure beyond provided functionalities.
|
|
36
36
|
* @see [Documentation](https://remotion.dev/docs/lambda/getawsclient)
|
|
37
|
-
* @param {AwsRegion} params.region The region in which the S3 bucket resides in.
|
|
38
|
-
* @param {string} params.service One of `iam`, `s3`, `cloudwatch`, `iam` or `servicequotas`
|
|
39
|
-
* @param {CustomCredentials} params.customCredentials Pass endpoint and credentials if you want to connect to a different cloud for S3
|
|
40
|
-
* @returns {GetAwsClientOutput<T>} Returns `client` and `sdk` of a AWS service
|
|
41
37
|
*/
|
|
42
38
|
const getAwsClient = ({ region, service, customCredentials, forcePathStyle, }) => {
|
|
43
39
|
return {
|
|
@@ -17,17 +17,4 @@ export type GetCompositionsOnLambdaInput = {
|
|
|
17
17
|
forcePathStyle?: boolean;
|
|
18
18
|
} & Partial<ToOptions<typeof BrowserSafeApis.optionsMap.getCompositionsOnLambda>>;
|
|
19
19
|
export type GetCompositionsOnLambdaOutput = VideoConfig[];
|
|
20
|
-
/**
|
|
21
|
-
* @description Returns the compositions from a serveUrl
|
|
22
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/getcompositionsonlambda)
|
|
23
|
-
* @param params.functionName The name of the Lambda function that should be used
|
|
24
|
-
* @param params.serveUrl The URL of the deployed project
|
|
25
|
-
* @param params.inputProps The input props that should be passed while the compositions are evaluated.
|
|
26
|
-
* @param params.envVariables Object containing environment variables to be inserted into the video environment
|
|
27
|
-
* @param params.region The AWS region in which the video should be rendered.
|
|
28
|
-
* @param params.logLevel The log level of the Lambda function
|
|
29
|
-
* @param params.timeoutInMilliseconds The timeout of the Lambda function
|
|
30
|
-
* @param params.chromiumOptions The options to pass to Chromium
|
|
31
|
-
* @returns The compositions
|
|
32
|
-
*/
|
|
33
20
|
export declare const getCompositionsOnLambda: ({ chromiumOptions, serveUrl, region, inputProps, functionName, envVariables, logLevel, timeoutInMilliseconds, forceBucketName: bucketName, dumpBrowserLogs, offthreadVideoCacheSizeInBytes, forcePathStyle, }: GetCompositionsOnLambdaInput) => Promise<GetCompositionsOnLambdaOutput>;
|
|
@@ -5,18 +5,9 @@ const client_1 = require("@remotion/serverless/client");
|
|
|
5
5
|
const version_1 = require("remotion/version");
|
|
6
6
|
const aws_implementation_1 = require("../functions/aws-implementation");
|
|
7
7
|
const call_lambda_1 = require("../shared/call-lambda");
|
|
8
|
-
|
|
9
|
-
* @description
|
|
8
|
+
/*
|
|
9
|
+
* @description Gets the compositions inside a Lambda function.
|
|
10
10
|
* @see [Documentation](https://remotion.dev/docs/lambda/getcompositionsonlambda)
|
|
11
|
-
* @param params.functionName The name of the Lambda function that should be used
|
|
12
|
-
* @param params.serveUrl The URL of the deployed project
|
|
13
|
-
* @param params.inputProps The input props that should be passed while the compositions are evaluated.
|
|
14
|
-
* @param params.envVariables Object containing environment variables to be inserted into the video environment
|
|
15
|
-
* @param params.region The AWS region in which the video should be rendered.
|
|
16
|
-
* @param params.logLevel The log level of the Lambda function
|
|
17
|
-
* @param params.timeoutInMilliseconds The timeout of the Lambda function
|
|
18
|
-
* @param params.chromiumOptions The options to pass to Chromium
|
|
19
|
-
* @returns The compositions
|
|
20
11
|
*/
|
|
21
12
|
const getCompositionsOnLambda = async ({ chromiumOptions, serveUrl, region, inputProps, functionName, envVariables, logLevel, timeoutInMilliseconds, forceBucketName: bucketName, dumpBrowserLogs, offthreadVideoCacheSizeInBytes, forcePathStyle, }) => {
|
|
22
13
|
var _a;
|
|
@@ -12,11 +12,4 @@ export type GetFunctionInfoInput = {
|
|
|
12
12
|
functionName: string;
|
|
13
13
|
logLevel?: LogLevel;
|
|
14
14
|
};
|
|
15
|
-
/**
|
|
16
|
-
* @description Given a region and function name, returns information about the function such as version, memory size and timeout.
|
|
17
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/getfunctioninfo)
|
|
18
|
-
* @param {AwsRegion} options.region The region in which the function resides in.
|
|
19
|
-
* @param {string} options.functionName The name of the function
|
|
20
|
-
* @return {Promise<FunctionInfo>} Promise resolving to information about the function.
|
|
21
|
-
*/
|
|
22
15
|
export declare const getFunctionInfo: ({ region, functionName, logLevel, }: GetFunctionInfoInput) => Promise<FunctionInfo>;
|
|
@@ -6,12 +6,9 @@ const aws_clients_1 = require("../shared/aws-clients");
|
|
|
6
6
|
const constants_1 = require("../shared/constants");
|
|
7
7
|
const get_function_version_1 = require("../shared/get-function-version");
|
|
8
8
|
const validate_aws_region_1 = require("../shared/validate-aws-region");
|
|
9
|
-
|
|
10
|
-
* @description
|
|
9
|
+
/*
|
|
10
|
+
* @description Gets information about a function given its name and region.
|
|
11
11
|
* @see [Documentation](https://remotion.dev/docs/lambda/getfunctioninfo)
|
|
12
|
-
* @param {AwsRegion} options.region The region in which the function resides in.
|
|
13
|
-
* @param {string} options.functionName The name of the function
|
|
14
|
-
* @return {Promise<FunctionInfo>} Promise resolving to information about the function.
|
|
15
12
|
*/
|
|
16
13
|
const getFunctionInfo = async ({ region, functionName, logLevel, }) => {
|
|
17
14
|
var _a, _b, _c, _d, _e;
|
|
@@ -6,11 +6,4 @@ export type GetFunctionsInput = {
|
|
|
6
6
|
compatibleOnly: boolean;
|
|
7
7
|
logLevel?: LogLevel;
|
|
8
8
|
};
|
|
9
|
-
/**
|
|
10
|
-
* @description Lists Remotion Lambda render functions deployed to AWS Lambda.
|
|
11
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/getfunctions)
|
|
12
|
-
* @param params.region The region of which the functions should be listed.
|
|
13
|
-
* @param params.compatibleOnly Whether only functions compatible with the installed version of Remotion Lambda should be returned.
|
|
14
|
-
* @returns {Promise<FunctionInfo[]>} An array with the objects containing information about the deployed functions.
|
|
15
|
-
*/
|
|
16
9
|
export declare const getFunctions: (params: GetFunctionsInput) => Promise<FunctionInfo[]>;
|
|
@@ -26,12 +26,9 @@ const getAllFunctions = async ({ existing, nextMarker, region, }) => {
|
|
|
26
26
|
}
|
|
27
27
|
return allLambdas;
|
|
28
28
|
};
|
|
29
|
-
|
|
30
|
-
* @description
|
|
29
|
+
/*
|
|
30
|
+
* @description Retrieves a list of functions that Remotion deployed to AWS Lambda in a certain region.
|
|
31
31
|
* @see [Documentation](https://remotion.dev/docs/lambda/getfunctions)
|
|
32
|
-
* @param params.region The region of which the functions should be listed.
|
|
33
|
-
* @param params.compatibleOnly Whether only functions compatible with the installed version of Remotion Lambda should be returned.
|
|
34
|
-
* @returns {Promise<FunctionInfo[]>} An array with the objects containing information about the deployed functions.
|
|
35
32
|
*/
|
|
36
33
|
const getFunctions = async (params) => {
|
|
37
34
|
const lambdas = await getAllFunctions({
|
|
@@ -1,9 +1,3 @@
|
|
|
1
1
|
import type { GetOrCreateBucketInput } from '@remotion/serverless/client';
|
|
2
2
|
import type { AwsProvider } from '../functions/aws-implementation';
|
|
3
|
-
/**
|
|
4
|
-
* @description Creates a bucket for Remotion Lambda in your S3 account. If one already exists, it will get returned instead.
|
|
5
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/getorcreatebucket)
|
|
6
|
-
* @param params.region The region in which you want your S3 bucket to reside in.
|
|
7
|
-
* @returns {Promise<GetOrCreateBucketOutput>} An object containing the `bucketName`.
|
|
8
|
-
*/
|
|
9
3
|
export declare const getOrCreateBucket: (options: GetOrCreateBucketInput<AwsProvider>) => Promise<import("@remotion/serverless/client").GetOrCreateBucketOutput>;
|
|
@@ -3,11 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.getOrCreateBucket = void 0;
|
|
4
4
|
const client_1 = require("@remotion/serverless/client");
|
|
5
5
|
const aws_implementation_1 = require("../functions/aws-implementation");
|
|
6
|
-
|
|
7
|
-
* @description Creates a bucket for Remotion
|
|
8
|
-
* @see [Documentation](https://remotion.dev/docs/
|
|
9
|
-
* @param params.region The region in which you want your S3 bucket to reside in.
|
|
10
|
-
* @returns {Promise<GetOrCreateBucketOutput>} An object containing the `bucketName`.
|
|
6
|
+
/*
|
|
7
|
+
* @description Creates a Cloud Storage bucket for Remotion Cloud Run in your GCP project. If one already exists, it will get returned instead.
|
|
8
|
+
* @see [Documentation](https://remotion.dev/docs/cloudrun/getorcreatebucket)
|
|
11
9
|
*/
|
|
12
10
|
const getOrCreateBucket = (options) => {
|
|
13
11
|
var _a, _b;
|
|
@@ -2,10 +2,5 @@ import type { AwsRegion } from '../regions';
|
|
|
2
2
|
type Options = {
|
|
3
3
|
enabledByDefaultOnly?: boolean;
|
|
4
4
|
};
|
|
5
|
-
/**
|
|
6
|
-
* @description Gets an array of all supported AWS regions of this release of Remotion Lambda.
|
|
7
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/getregions)
|
|
8
|
-
* @returns {AwsRegion[]} A list of AWS regions.
|
|
9
|
-
*/
|
|
10
5
|
export declare const getRegions: (options?: Options) => readonly AwsRegion[];
|
|
11
6
|
export {};
|
package/dist/api/get-regions.js
CHANGED
|
@@ -2,10 +2,9 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.getRegions = void 0;
|
|
4
4
|
const regions_1 = require("../regions");
|
|
5
|
-
|
|
6
|
-
* @description Gets an array of all supported
|
|
7
|
-
* @see [Documentation](https://remotion.dev/docs/
|
|
8
|
-
* @returns {AwsRegion[]} A list of AWS regions.
|
|
5
|
+
/*
|
|
6
|
+
* @description Gets an array of all supported GCP regions of this release of Remotion Cloud Run.
|
|
7
|
+
* @see [Documentation](https://remotion.dev/docs/cloudrun/getregions)
|
|
9
8
|
*/
|
|
10
9
|
const getRegions = (options) => {
|
|
11
10
|
var _a;
|
|
@@ -13,14 +13,4 @@ export type GetRenderProgressInput = {
|
|
|
13
13
|
forcePathStyle?: boolean;
|
|
14
14
|
skipLambdaInvocation?: boolean;
|
|
15
15
|
};
|
|
16
|
-
/**
|
|
17
|
-
* @description Gets the current status of a render originally triggered via renderMediaOnLambda().
|
|
18
|
-
* @see [Documentation](https://remotion.dev/docs/lambda/getrenderprogress)
|
|
19
|
-
* @param {string} params.functionName The name of the function used to trigger the render.
|
|
20
|
-
* @param {string} params.bucketName The name of the bucket that was used in the render.
|
|
21
|
-
* @param {string} params.renderId The ID of the render that was returned by `renderMediaOnLambda()`.
|
|
22
|
-
* @param {AwsRegion} params.region The region in which the render was triggered.
|
|
23
|
-
* @param {CustomCredentials} params.s3OutputProvider? Endpoint and credentials if the output file is stored outside of AWS.
|
|
24
|
-
* @returns {Promise<RenderProgress>} See documentation for this function to see all properties on the return object.
|
|
25
|
-
*/
|
|
26
16
|
export declare const getRenderProgress: (input: GetRenderProgressInput) => Promise<RenderProgress>;
|