1. Epic GamesDeveloper
  3. IMusicHandle

IMusicHandle

[IMusicHandle](API\Plugins\MusicEnvironment\IMusicHandle): The actual pure virtual definition of the [UMusicHandle](API\Plugins\MusicEnvironment\UMusicHandle) interface.

API > API/Plugins > API/Plugins/MusicEnvironment

IMusicHandle: The actual pure virtual definition of the UMusicHandle interface. This is what derived classes will inherit from. AND... IMusicalAssets return TScriptInterface when they are asked to instantiate themselves. BUT NOTE... If a non-UCLASS or a non-USTRUCT asks an IMusicalAsset to instantiate itself there may not be anything holding a strong reference to the object the script interface is pointing to. More on this below.

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

Syntax

class IMusicHandle

Derived Classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
IsOnGlobalClockAuthorityStack bool   MusicTypes/MusicHandle.h  
RegisteredToTags FGameplayTagContainer   MusicTypes/MusicHandle.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BecomeGlobalMusicClockAuthority()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music|Clock"

virtual void BranchOnTransportState ( EMusicHanldeTransportState& Branches
) const

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"
  • Meta=(ExpandEnumAsExecs="Branches")

void Continue()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

virtual void GetCurrentBarBeat ( float& Bar,
float& BeatInBar,
EMusicHanldeClockValidity& Branches
)

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music|Clock"
  • Meta=(ExpandEnumAsExecs="Branches")
  MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music|Clock"

virtual EMusicHanldeTransportState GetTransportState()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

virtual bool IsReadyToPlay ( float FromSeconds
)

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

virtual bool IsUsingAsset ( const TScriptInterface< IMusicalAsset > Asset
) const

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

bool IsUsingAsset ( const UObject* Asset
) const

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

bool IsValid()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

virtual void Kill()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

void Pause()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

bool Play ( float FromSeconds
)

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

virtual void RegisterAsTaggedClock ( const FGameplayTag& Tag
)

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music|Clock"

virtual void RelinquishGlobalMusicClockAuthority()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music|Clock"

virtual void Stop()

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music"

void Tick ( float DeltaSeconds
)

   MusicTypes/MusicHandle.h  

virtual void UnregisterAsTaggedClock ( const FGameplayTag& Tag
)

   MusicTypes/MusicHandle.h
  • BlueprintCallable
  • Category="Music|Clock"

Protected

Name Remarks Include Path Unreal Specifiers

void Kill_Internal()

   MusicTypes/MusicHandle.h  

void Stop_Internal()

   MusicTypes/MusicHandle.h  

Operators

Name Remarks Include Path Unreal Specifiers

operator bool()

   MusicTypes/MusicHandle.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page