addAudioTrack

API reference for the addAudioTrack method.

Adds an audio track to the user's design.

To learn more, see Creating audio tracks.

import { addAudioTrack } from "@canva/design";
import { upload } from "@canva/asset";
(async () => {
// Upload an audio asset
const audio = await upload({
type: "AUDIO",
id: "uniqueIdGoesHere",
title: "Example audio",
mimeType: "audio/mp3",
durationMs: 86047,
url: "https://www.canva.dev/example-assets/audio-import/audio.mp3",
});
// Add the audio track to the user's design
await addAudioTrack({
ref: audio.ref,
});
})();
ts

Before an app that uses this method can be submitted for review, the canva:design:content:write permission must be enabled via the Developer Portal. To learn more, see Configuring permissions.

#optionsobject
Required

The options for adding an audio track to the user's design.

#options.refstring
Required

A unique identifier that points to an audio asset in Canva's backend.

Promise<void>