IMusicalAsset | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/MusicEnvironment

IMusicalAsset: The actual pure virtual definition of the interface. This is what derived classes will inherit from. It is an asset that has a FrameBasedMusicMap and can be played as music (returning a 'music handle' that becomes owned by the caller.)


Name	IMusicalAsset
Type	class
Header File	/Engine/Plugins/Runtime/MusicEnvironment/Source/MusicEnvironment/Public/MusicTypes/MusicalAsset.h
Include Path	#include "MusicTypes/MusicalAsset.h"

Syntax

class IMusicalAsset : public IMusicMapSource

Implements Interfaces

IMusicMapSource

Derived Classes

UHarmonixMusicAsset

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
virtual TScriptInterface< IMusicHandle > Play ( UObject* PlaybackContext, UAudioComponent* OnComponent, float FromSeconds, bool BecomeAuthoritativeClock, const FGameplayTag RegisterAsTaggedClock, bool IsAudition )		MusicTypes/MusicalAsset.h	BlueprintCallable Category="Music" Meta=(DefaultToSelf="PlaybackContext")
virtual TScriptInterface< IMusicHandle > PrepareToPlay ( UObject* PlaybackContext, UAudioComponent* OnComponent, float FromSeconds, bool BecomeAuthoritativeClock, const FGameplayTag RegisterAsTaggedClock, bool IsAudition )		MusicTypes/MusicalAsset.h	BlueprintCallable Category="Music" Meta=(DefaultToSelf="PlaybackContext")

Protected

Name	Remarks	Include Path	Unreal Specifiers
TScriptInterface< IMusicHandle > Play_Internal ( UObject* PlaybackContext, UAudioComponent* OnComponent, float FromSeconds, bool IsAudition )		MusicTypes/MusicalAsset.h
TScriptInterface< IMusicHandle > PrepareToPlay_Internal ( UObject* PlaybackContext, UAudioComponent* OnComponent, float FromSeconds, bool IsAudition )		MusicTypes/MusicalAsset.h