Skip to main content

Editor.Assets.LicensedAudioTrack

Class

Licensed audio track asset with metadata and runtime source paths.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// Find LicensedAudioTrack assets and assign to an AudioComponent
const tracks = model.project.assetManager.assets.filter(
a => a.isOfType('LicensedAudioTrack')
) as Editor.Assets.LicensedAudioTrack[];

if (tracks.length > 0) {
const track = tracks[0];
console.log(`Track: ${track.trackName}, artist: ${track.artistName}, bundled: ${track.bundled}`);

// Create a scene object with an AudioComponent and assign the track
const obj = scene.createSceneObject('MusicPlayer');
const audio = obj.addComponent('AudioComponent');
audio.audioTrack = track;
audio.enableAutoplayLoop = true;
}

Extends

Properties

artistName

artistName: string

Name of the track's artist.


bundled

bundled: boolean

Whether the track is bundled with the project.


cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

AudioTrackAsset.cacheFile


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

AudioTrackAsset.fileMeta


id

readonly id: Uuid

The unique id of the entity.

Inherited from

AudioTrackAsset.id


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

AudioTrackAsset.meta


name

readonly name: string

The name of the asset.

Inherited from

AudioTrackAsset.name


runtimeSourceBeatsPath

readonly runtimeSourceBeatsPath: Path

Runtime path to the track's beats data.


runtimeSourceLyricsPath

readonly runtimeSourceLyricsPath: Path

Runtime path to the track's lyrics data.


runtimeSourcePath

readonly runtimeSourcePath: Path

Runtime path to the track's audio file.


trackId

trackId: string

Unique identifier of the audio track within the Snap licensed music catalog.


trackName

trackName: string

Display title of the licensed audio track.


type

readonly type: string

The entity's type.

Inherited from

AudioTrackAsset.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

AudioTrackAsset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

AudioTrackAsset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

AudioTrackAsset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

AudioTrackAsset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

AudioTrackAsset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

AudioTrackAsset.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

AudioTrackAsset.isSame