Editor.Assets.LicensedAudioTrack
ClassLicensed audio track asset with metadata and runtime source paths.
Index
Properties
Methods
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
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
readonlyname:string
The name of the asset.
Inherited from
runtimeSourceBeatsPath
readonlyruntimeSourceBeatsPath:Path
Runtime path to the track's beats data.
runtimeSourceLyricsPath
readonlyruntimeSourceLyricsPath:Path
Runtime path to the track's lyrics data.
runtimeSourcePath
readonlyruntimeSourcePath: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
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
AudioTrackAsset.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
AudioTrackAsset.getOwnedEntities
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean