auto_write

Adds, changes or removes a sound effect of a motion design, saved as a new version. A new one takes a track id from the

Changed on

Adds, changes or removes a sound effect of a motion design, saved as a new version. A new one takes a track id from the store's sound library and the second it starts at; an existing one, named by its sfx_id, changes only the fields given: its sound, start, level, or how long it plays before fading out. No sound is made, so no credits are used.

post/api/v1/tools/set_design_sfx

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/set_design_sfx
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: creative:write)

Request body

design_idstring required

The motion design.

sfx_idstring

An existing sound effect, as the timeline lists it; leave out to add one.

removeboolean

true removes the sound effect named by sfx_id.

track_idstring

A track id from the library: the sound to play.

at_secondsnumber

Design second the sound starts at.

gain_dbnumber

Level in decibels; 0 plays it as it is.

play_secondsnumber nullable

Stop it after this many seconds, with a short fade. null plays it to its own end.

Response

Tool result

okboolean required
resultunknown required

Changes