Skip to main content

LensStudio:AssetLibrary.LicensedMusic

Class

Provides access to licensed music import functionality for adding music assets to a project.

Index

Example

// LicensedMusic provides a static method to import a MusicAsset
// into the project. You cannot construct LicensedMusic directly.
const { LicensedMusic } = await import('LensStudio:AssetLibrary');
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;

// importMusic(musicAsset, project) returns boolean
// MusicAsset is obtained from a music list service response.
// Here we show the call pattern:
const musicAsset = null as unknown as import('LensStudio:AssetLibrary').MusicAsset;
const success: boolean = LicensedMusic.importMusic(musicAsset, model.project);
console.log('Music import succeeded:', success);

Methods

importMusic()

static importMusic(musicAsset, project): boolean

Imports a licensed music asset into the specified project, returning true on success.

Parameters

ParameterType
musicAssetMusicAsset
projectProject

Returns

boolean