Skip to main content

LensStudio:AssetLibrary.MusicListSuccess

Class

Successful result of a music list request, containing the returned music assets.

Index

Properties

Example

// MusicListSuccess is the data payload inside a successful MusicListResponse.
// Read it from response.data — never construct directly.
const provider = this.pluginSystem.findInterface(
IAssetLibraryProvider.interfaceId
) as import('LensStudio:AssetLibrary').IAssetLibraryProvider;

const envSetting = new EnvironmentSetting();
envSetting.environment = Environment.Production;
envSetting.space = Space.Public;

const filter = new AssetFilter();
filter.searchText = 'chill';

const response = await provider.musicService.fetchAsync(
new AssetListRequest(envSetting, filter)
);

if (response.ok && response.data) {
const success = response.data; // MusicListSuccess
console.log('musicAssets count:', success.musicAssets.length);
for (const track of success.musicAssets.slice(0, 3)) {
console.log(' -', track.assetName, 'by', track.artistName);
}
}

Properties

musicAssets

readonly musicAssets: MusicAsset[]

Array of music assets returned from a successful music list request.