WIwithchima
Videos

Set background music

Changed on

Sets the video's background music track. It loops over the whole video and is included in exports. Volume is 0-1 and defaults to 0.2. Omit sourceId and presetId to change only the current track's volume or name.

put/v1/videos/{id}/background-music

Request

Path parameters

idstring required

Unique video identifier

Example:vid_abc123def456

Request body

namestring

Optional display name for the track. Defaults to the preset's name when presetId is given.

presetIdstring

Preset ID of a curated Tella music track, from a default item of type music in GET /v1/library. Nothing to upload. Mutually exclusive with sourceId. Omit both to keep the current track and change only its volume or name.

sourceIdstring

Audio source ID from POST /v1/sources (kind: "audio"). Mutually exclusive with presetId. Omit both to keep the current track and change only its volume or name.

volumenumber

Track volume from 0 (silent) to 1 (full volume). Defaults to 0.2 for a new track, and to the current track's volume when neither sourceId nor presetId is given.

Example request

{
  "name": "Calm Product Tour",
  "presetId": "calm-product-tour",
  "sourceId": "su_abc123def456",
  "volume": 0.2
}

Response

Background music set

Example response

{
  "backgroundMusic": {
    "durationMs": 180036,
    "name": "Calm Product Tour",
    "url": "https://ucarecdn.com/example-track/",
    "volume": 0.2
  }
}

Changes

  • 5caf72ed8935Revision changes
    • info

      the request property default value 0.2 was removed

  • ac47c99c144fRevision changes
    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status