Media Encoder2027
Object

GenMusic

Scripting bridge for Generative Music job submission and result inspection

Methods

→ GenMusic

Creates a GenMusic object

static → Boolean

Trigger a Generative Music job for the given range on an audio track

sequence Object
targettrack Object
starttime Object
durationseconds Number
prompt String
beatsperminute Number
loop Boolean
static → Boolean

Trigger a Generative Music job using the video clip above the range as reference (Beta)

sequence Object
targettrack Object
starttime Object
durationseconds Number
prompt String
beatsperminute Number
loop Boolean
static → String

AI-enhance the prompt text (blocked: kGenMusic not yet in GenTypeHasPromptEnhance)

prompt String
expansionenabled Boolean
static → Number

Returns the active variation index (0-3) from TrackItemChainHistory

trackitem Object
static → String

Returns the channel format of the generated compound clip's audio (e.g. "Stereo")

trackitem Object
static → Boolean

Returns mLoop from the master clip's persisted MusicGenerationParams JSON

trackitem Object
static → Number

Returns the sample rate in Hz of the generated compound clip's audio

trackitem Object
static → Array

Scans the audio track at starttime for an online compound clip; returns it when generation is complete

sequence Object
targettrack Object
starttime Object
static → Number

Returns the total variation count from VariationGroupMetadata

trackitem Object
static → String

Generate a music prompt suggestion from a local video file path via Firefly |v3|prompts|suggest

videofilepath String
static → Boolean

Re-submit a Generative Music job targeting an existing compound clip

sequence Object
existingtrackitem Object
prompt String
beatsperminute Number
loop Boolean
static → Boolean

Swap the active variation (0-3) of the compound track item

sequence Object
trackitem Object
variationindex Number

Return 1

Methods that return a GenMusic.