README.md

Remotion video

Welcome to your TTS Remotion project!

Get Started

• Create Azure Account
• Create TTS service on Azure, set AZURE_TTS_KEY and AZURE_TTS_REGION.

  It may take some time until the subscription is active, in the meanwhile you might get "1006" errors even if the token is valid.

• Create AWS Account
• Setup S3 Bucket with public access
  • Configure bucket policy

    {
      "Version": "2008-10-17",
      "Statement": [
        {
          "Sid": "AllowPublicRead",
          "Effect": "Allow",
          "Principal": {
            "AWS": "*"
          },
          "Action": "s3:GetObject",
          "Resource": "arn:aws:s3:::<YOUR-BUCKET-NAME>/*"
        }
      ]
    }

  • Configure bucket CORS
    • Use it only as a template, we recommend you to edit "AllowedOrigins" entering your origin

    [
      {
        "AllowedHeaders": ["*"],
        "AllowedMethods": ["HEAD", "GET", "PUT", "POST", "DELETE"],
        "AllowedOrigins": ["*"],
        "ExposeHeaders": ["ETag", "x-amz-meta-custom-header"]
      }
    ]

• Copy .env.example to .env entering your secrets
  • ⚠️ Ensure your AWS credentials only allow reading and uploading to a specific S3 bucket s3:GetObject and s3:PutObject to not compromise your credentials if you deploy your Remotion project
• Use method synthesizeSpeech from src/TextToSpeech/tts.ts to convert Text to Audio. Using createS3Url() you can create a source for the <Audio /> component.

Example

Commands

Install Dependencies

npm install

Start Preview

npm run dev

Render video

npx remotion render

See docs for server-side rendering here.

Upgrade Remotion

npx remotion upgrade

Docs

Get started with Remotion by reading the fundamentals page.

Issues

Found an issue with Remotion? File an issue here.

License

Note that for some entities a company license is needed. Read the terms here.