api
Summary
namespace little_endian_io
namespace midirecoder
class _Marker
Marker Textual Meta Event A event that 'marks a point in time for a MIDI sequence.'
class AAudioManager
Quantized Event based Audio Player
class AAudioUnit
It helps simple audio playback functionality.
class AEventManager
class AInstrumentBase
Instrument have an owner synthesizer.
class AMUTACharacterBase
CharacterBase : Contains Basic Character functions Contents specific
class AMUTACustomizableCharacter
Customizable Character - designed to allow changing the skeletal mesh using an index-based approach
class APlayablePiano
class ASingleNote
Simple Note for visualize to rhythm game type falling note
class ChannelAftertouch
Channel Aftertouch Channel Event A event that can 'apply pressure to a MIDI channel, similar to applying pressure to electronic keyboard keys.'
class ChannelEvent
Abstract Channel MIDI Event
class Controller
Controller Channel Event A event that can 'affect a controller, such as a slider, knob, or switch.'
class CopyrightNotice
Copyright Notice Textual Meta Event A event that 'places a copyright notice in a MIDI file.'
class CuePoint
Cue Point Textual Meta Message A event that 'denotes a cue in a MIDI file, usually to signify the beginning of an action'
class EndOfTrack
End Of Track Meta Event A event that 'denotes the end of a MIDI track.'
class FInstumentCoreModule
class FMetaverseCoreModule
class FMidiAssetEditorStyle
MIDI Asset Style helper : Editor Asset Class Helper
class FMidiProcessorWorker
class FMusicCoreModule
class FMUTAAssetEditorModule
class FMUTAOnlineSearchSettings
class FMUTAOnlineSearchSettingsBase
class FMUTAOnlineSessionSettings
class FMUTASDKModule
class FVisualizationCoreModule
class GenericMetaEvent
Generic Meta Event Class that holds unrecognized MIDI events
class ICharacterCustom
Character Customize Interface (index based - mesh , color)
class IChatting
Chatting Module Interface , It's used for find all Actor had ChatComponent.
class IEmote
Define Emote functionality
class IEventObserver
class IFriend
Following unreal framework online subsystem functionality. Invite, Addlist, AddBlacklist etc.
class IFXVisualizer
class InstrumentName
Intrument Name Textual Meta Event A event that 'shows the name of the instrument used in the current track.'
class InstumentCore
class IPartyPlay
class IPlayableInst
Playable Instrument Interface : Defined midi event type playable instrument (i.e. not cosmetic type prop)
class IQuartzClockPlay
Define Quartz Clock based audio play contents ex : beat , bar type quantization event or need to in-time play
class KeySignature
Key Signature Meta Event A event that 'specifies the key signature and scale of a MIDI file.'
class Lyrics
Lyrics Textual Meta Event A event that 'shows the lyrics of a song at a particular time in the MIDI sequence.'
class MetaEvent
Abstract Meta MIDI Event A abstract event for 'messages that contains information about the MIDI sequence and that are not to be sent over MIDI ports.'
class MetaEvent::MetaEventData
class MetaverseCore
class MetronomeTick
An event specifically for MidiProcessor to broadcast metronome ticks so that observers need not rely on time conversions or measure tracking
class MidiApi
class MidiChannelPrefix
MIDI Channel Prefix Meta Event A event that 'specifies a MIDI channel so that meta messages that follow are specific to a channel.'
class MidiEvent
abstract base class for midi events A event that 'is a piece of data sent to a MIDI device to prompt it to do something at a certain time.'
class MidiEventListener
class MidiFile
class MidiInApi
class MidiInDummy
class MidiOutApi
class MidiOutDummy
class MidiProcessor
Copyright 2011 Alex Leffelman.
class MidiTrack
class MidiUtil
class MusicCore
class MUTAAssetEditor
class MUTALogger
class MUTASDK
class NoteAfterTouch
Note After Touch A event that can 'apply pressure to a note playing, similar to applying pressure to electronic keyboard keys.'
class NoteOff
Note Off Channel Event A event that can 'release a note and stop playing it.'
class NoteOn
Note On Channel Event A event that can 'play a note and start sounding it.'
class PitchBend
Pitch Bend Channel Event A event that can 'change a channel pitch up or down.'
class ProgramChange
Program Change Channel Event A event that can 'assign a program to a MIDI channel, such as an instrument, patch, or preset.;
class RtMidi
An abstract base class for realtime MIDI input/output.
class RtMidiError
Exception handling class for RtMidi. The RtMidiError class is quite simple but it does allow errors to be "caught" by RtMidiError::Type. See the RtMidi documentation to know which methods can throw an RtMidiError.
class RtMidiIn
A realtime MIDI input class. This class provides a common, platform-independent API for realtime MIDI input. It allows access to a single MIDI input port. Incoming MIDI messages are either saved to a queue for retrieval using the getMessage() function or immediately passed to a user-specified callback function. Create multiple instances of this class to connect to more than one MIDI device at the same time. With the OS-X, Linux ALSA, and JACK MIDI APIs, it is also possible to open a virtual input port to which other MIDI software clients can connect. by Gary P. Scavone, 2003-2017.
class RtMidiOut
A realtime MIDI output class. This class provides a common, platform-independent API for MIDI output. It allows one to probe available MIDI output ports, to connect to one such port, and to send MIDI bytes immediately over the connection. Create multiple instances of this class to connect to more than one MIDI device at the same time. With the OS-X, Linux ALSA and JACK MIDI APIs, it is also possible to open a virtual port to which other MIDI software clients can connect. by Gary P. Scavone, 2003-2017.
class SequenceNumber
Sequence Number Meta Event A event that 'defines the number of a sequence in type 0 and 1 MIDI files, or the pattern number in type 2 MIDI files.'
class SequencerSpecificEvent
Sequencer Specific Meta Event A event that 'carries information that is specific to a MIDI sequencer produced by a certain MIDI manufacturer.'
class SmpteOffset
SMPTE Offset Meta Event A event that 'specifies an offset for the starting point of a MIDI track from the start of a sequence in terms of SMPTE time.' (hours:minutes:seconds:frames:subframes)
class SystemExclusiveEvent
System Exclusive MIDI Event SysEx events may not be properly handled by this library.
class Tempo
Tempo Meta Event A event that 'sets the tempo of a MIDI sequence in terms of microseconds per quarter note.
class Text
Text Textual Meta Event A event that 'defines some text to be carried within a MIDI file.'
class TextualMetaEvent
Abstract Textual Meta Event A abstract event for 'messages that contains 'text based' information about the MIDI sequence and that are not to be sent over MIDI ports.'
class TimeSignature
Time Signature Meta Event A Event that 'defines the musical time signature of a MIDI sequence.'
class TrackName
Track Name Textual Meta Event A event that 'defines either the name of a MIDI sequence (when in MIDI type 0 or MIDI type 2 files, or when in the first track of a MIDI type 1 file), or the name of a MIDI track (when in other tracks of a MIDI type 1 file).'
class UAudioTypes
class UCharacterCustom
class UCharacterCustomDataAsset
class UChatEvent
class UChatting
class UEmote
class UEmoteDataAsset
class UEndEvent
class UEventBase
Defined DataTable Based Event Type,
class UEventObserver
class UFriend
class UFunctionEvent
class UFXVisualizer
class UGridRoomCreator
SceneCreate : Setup Room Theme and Instrument in logical grid map (Simple Room Create example)
class UInputActionEvent
class UInstrumentType
class UMidiAssetFactory
class UMidiInterfaceUtil
class UMidiRecorder
Unreal Adaptor class of midi recorder library
class UMidiTypes
class UMUTAHostSessionRequest
class UMUTAPrimaryDataAsset
class UMUTASearchSessionRequest
class UMUTASessionSearchResult
A result object returned from the online system that describes a joinable game session
class UMUTASessionSubsystem
class UMUTASessionTypes
class UPartyPlay
class UPlayableInst
class UQuartzClockPlay
class USampleTankService
SampleTank API Service Object : Helps get songform sample (4 measures) Currently Server implemented legacy CMS based API
class USequencerType
Just using Type Definition
class USessionTestWidget
class USoundUtils
SoundFont based Synthesizer(midi event) and dynamic sound asset from midi file
class USoundWaveDynamicMidi
class UWebSocketInstance
Websocket service example using GameInstance Do not use solely. this is for testing websocket make sure that convert this class to subsystem class rather then gameinstance.
class UWebSocketRPC
Websocket RPC Example Class Websocket JSON base RPC, for specific presentation RPCTask is defined in RPC JSONBody , Context of RPCTask : Generated FString Type
class VariableLengthInt
Variable Length Integer
class VisualizationCore
struct FAudioUnitSaveInfo
struct FChatMessage
struct FCustomizeAssetData
Customizable Asset Mesh Data , It's not same to asset DB entities Especially, It's useful to make local DataTable
struct FEventTableStruct
struct FMidiClockEvent
struct FMidiDevice
struct FMidiEvent
struct FMusicBlockInfo
Information of Song-form style block (Duration : 4-8 measures). Especially using step sequencer experience
struct FOnlineResultInformation
Detailed information about the online error. Effectively a wrapper for FOnlineError.
struct FSampleTankUserInfo
struct FSequenceStep
struct FStepScript
struct FStepSequenceBoard
struct FSubEventTableStruct
struct FUserSessionStatus
struct membuf
struct MidiInApi::MidiMessage
struct MidiInApi::MidiQueue
struct MML_LITE
struct MidiInApi::RtMidiInData
struct tml_message
struct tml_stream
struct tsf_stream
namespace little_endian_io
little_endian_ioSummary
public template<>
void write_word(std::stringstream & outs,Word value,unsigned size)
Members
public template<>
void write_word(std::stringstream & outs,Word value,unsigned size)
namespace midirecoder
midirecoderSummary
enum Quantize
class midirecoder::MidiFile
class midirecoder::MidiIO
class midirecoder::MidiTrack
class midirecoder::Note
Members
enum Quantize
Whole
Half
Half3
Quarter
Quarter3
Eighth
Eighth3
Sixteenth
Sixteenth3
Thirty2nd
class midirecoder::MidiFile
midirecoder::MidiFileSummary
public inline MidiFile()
public void format(bool new_type)
Set midi file format 0 or 1.
public void read(const std::vector< unsigned char > & data)
Read from buffer.
public void write(const int div,const std::string & path)
Write file at given path.
Members
public inline MidiFile()
public void format(bool new_type)
Set midi file format 0 or 1.
Parameters
new_type: True if 0, false if 1.
public void read(const std::vector< unsigned char > & data)
Read from buffer.
Parameters
data: Byte buffer.
public void write(const int div,const std::string & path)
Write file at given path.
Parameters
div: Ticks per beat to use. Default is 480.path: Path to save the file.
class midirecoder::MidiIO
midirecoder::MidiIOSummary
public inline MidiIO()
public void division(int new_div)
Manually set ticks per beat.
public int division() const
Get ticks per beat. Default is 480.
public void tempo(double ms)
Set tempo from millisecond.
public void tempo(int new_tempo)
Set tempo manually.
public int tempo() const
Get tempo. Default is 120.
public void new_key(int root,bool minor)
Manually set new key.
public void read(double deltatime,std::vector< unsigned char > * message)
Read from byte buffer.
public void buffer_to_sequence(const int index)
public void track_to_sequence(const MidiTrack & track,const int index)
Convert track outside of the project to the sequence.
public void file_to_sequence()
Convert internal file to sequence.
public void analyze()
Analyze key from the sequence. Requires track_to_sequence() or file_to_sequence() prior to this function.
public void quantize(int period)
Quantize sequence with giver period.
public void sequence_to_file()
Convert analyzed and quantized sequence into internal midi file buffer.
public void save(const std::string & path)
Save the midi file in given path.
Members
public inline MidiIO()
public void division(int new_div)
Manually set ticks per beat.
Parameters
new_div: New ticks per beat.
public int division() const
Get ticks per beat. Default is 480.
Returns
Ticks per beat in integer.
public void tempo(double ms)
Set tempo from millisecond.
Parameters
msTime in millisecond. Can be used for tap tempo.
public void tempo(int new_tempo)
Set tempo manually.
Parameters
new_tempo: New tempo in bpm.
public int tempo() const
Get tempo. Default is 120.
Returns
BPM in integer.
public void new_key(int root,bool minor)
Manually set new key.
Parameters
root: Sharp if positive, flat if negative.minor: true if minor, false if major.
public void read(double deltatime,std::vector< unsigned char > * message)
Read from byte buffer.
Parameters
deltatime: time in second.message: midi message buffer in byte.userData: nullptr. Don't touch it.
public void buffer_to_sequence(const int index)
public void track_to_sequence(const MidiTrack & track,const int index)
Convert track outside of the project to the sequence.
Parameters
`` track external track for data.
`` index destination track number.
public void file_to_sequence()
Convert internal file to sequence.
public void analyze()
Analyze key from the sequence. Requires track_to_sequence() or file_to_sequence() prior to this function.
public void quantize(int period)
Quantize sequence with giver period.
Parameters
period: Integer value of quantization period. Quantize enum can be used.
public void sequence_to_file()
Convert analyzed and quantized sequence into internal midi file buffer.
public void save(const std::string & path)
Save the midi file in given path.
Parameters
path: Path to save file in std::string.
class midirecoder::MidiTrack
midirecoder::MidiTrackSummary
public inline MidiTrack()
public void record(bool is_enable)
Set state of the track.
public bool record() const
Get state of the track.
public void delta(int time)
Write delta time data.
public void note_on(int time,int channel,int note,int velocity)
Write note on event.
public void note_off(int time,int channel,int note,int velocity)
Write note off event.
public void program_change(int time,int channel,int program)
Write program change event.
public void control_change(int time,int channel,int controller,int value)
Write control change event.
public void tempo(int time,int bpm)
Write new bpm in given time.
public void key(int time,int key,bool is_minor)
Write key bpm in given time.
public void end_of_track()
Write end of track event. Recommended to use when the file won't be changed.
public void read(const std::vector< unsigned char > & data)
Read midi track events from buffer.
Members
public inline MidiTrack()
public void record(bool is_enable)
Set state of the track.
Parameters
is_enable: True to record, false to not.
public bool record() const
Get state of the track.
Returns
True to record, false to not.
public void delta(int time)
Write delta time data.
Parameters
time: Delta time in tick.
public void note_on(int time,int channel,int note,int velocity)
Write note on event.
Parameters
time: Delta time in tick.channel: Midi channel.note: Midi note number.velocity: Midi velocity.
public void note_off(int time,int channel,int note,int velocity)
Write note off event.
Parameters
time: Delta time in tick.channel: Midi channel.note: Midi note number.velocity: Midi velocity.
public void program_change(int time,int channel,int program)
Write program change event.
Parameters
time: Delta time in tick.channel: Midi channel.program: Midi program number.
public void control_change(int time,int channel,int controller,int value)
Write control change event.
Parameters
time: Delta time in tick.channel: Midi channel.controller: Midi control number.value: Midi control data.
public void tempo(int time,int bpm)
Write new bpm in given time.
Parameters
time: Delta time in tick.bpm: Tempo in bpm to write.
public void key(int time,int key,bool is_minor)
Write key bpm in given time.
Parameters
time: Delta time in tick.key: Sharp if positive, flat if negative.is_minor: true if minor, false if major.
public void end_of_track()
Write end of track event. Recommended to use when the file won't be changed.
public void read(const std::vector< unsigned char > & data)
Read midi track events from buffer.
Parameters
dataByte buffer.
class midirecoder::Note
midirecoder::NoteSummary
public inline Note(int note_num,int channel,int velocity,std::weak_ptr< Note > last,int delta,int length)
Create a note. Not recommended to use separately.
public int note() const
public int channel() const
public int velocity() const
public int delta() const
public void delta(int new_delta)
public int length() const
public void length(int new_length)
public bool compare(Note & another) const
public bool is_null() const
Members
public inline Note(int note_num,int channel,int velocity,std::weak_ptr< Note > last,int delta,int length)
Create a note. Not recommended to use separately.
Parameters
note_num: Midi note number.channel: Midi channel number.velocity: Midi velocity number.last: Linked note that is ended before the start of the note.delta: Delta time between the end of the last note and the start of the note.length: Length of the note.
public int note() const
public int channel() const
public int velocity() const
public int delta() const
public void delta(int new_delta)
public int length() const
public void length(int new_length)
public bool compare(Note & another) const
public bool is_null() const
class _Marker
_MarkerMarker Textual Meta Event A event that 'marks a point in time for a MIDI sequence.'
Summary
public _Marker()
public _Marker(string marker)
public _Marker(long tick,long delta,string marker)
public void setMarkerName(string name)
public string getMarkerName()
Members
public _Marker()
public _Marker(string marker)
public _Marker(long tick,long delta,string marker)
public void setMarkerName(string name)
public string getMarkerName()
class AAudioManager
AAudioManagerQuantized Event based Audio Player
Summary
public FQuartzBoundaryEventBP QuartzBoundaryEventBP
public AAudioManager()
public virtual void Tick(float DeltaTime)
public virtual void CreateQuartzClock()
Create QuartzClock (it's event clock) and Register event delegate
public virtual void StartQuartzClock()
Start Clock
public virtual void StopQuartzClock()
Stop Clock
public virtual void ResetQuartzTransport()
Reset Clock
public virtual void ResumeQuartzClock()
Resume Clock
public virtual void HandleQuartzEvent()
Quartz Event handle (user custom event logic)
public virtual void InitQuarzClockSetting(float BPM,EQuartzTimeSignatureQuantization BeatType,int32 BeatNumber)
Set Quantized Event type of clock
public virtual void SetBPM(float BPM,const FQuartzQuantizationBoundary & Boundary)
Set BPM Event of clock (note : it'll use for general standard clock event)
public virtual void SetTimeSignature(const FQuartzTimeSignature & TimeSignature)
Set musical timesignature (like 4/4)
public virtual void SubscribeQuartzEvent()
public virtual void CreateBindQuartzEvent()
public virtual void OnMetronomeEvent(FName ClockName,EQuartzCommandQuantization QuantizationType,int32 NumBars,int32 Beat,float BeatFraction)
public virtual void OnQuartzCommandEvent(const EQuartzCommandDelegateSubType & EventType,FName Name)
protected FQuartzClockSettings QuartzClockSettings
protected TObjectPtr< UQuartzClockHandle > QuarzClockHandle
protected FQuartzQuantizationBoundary QuantizationBoundary
protected FOnQuartzCommandEventBP QuartzCommandEventBP
protected FOnQuartzMetronomeEventBP QuartzMetronomeEventBP
protected FName OwningClockName
protected virtual void BeginPlay()
Members
public FQuartzBoundaryEventBP QuartzBoundaryEventBP
public AAudioManager()
public virtual void Tick(float DeltaTime)
public virtual void CreateQuartzClock()
Create QuartzClock (it's event clock) and Register event delegate
public virtual void StartQuartzClock()
Start Clock
public virtual void StopQuartzClock()
Stop Clock
public virtual void ResetQuartzTransport()
Reset Clock
public virtual void ResumeQuartzClock()
Resume Clock
public virtual void HandleQuartzEvent()
Quartz Event handle (user custom event logic)
public virtual void InitQuarzClockSetting(float BPM,EQuartzTimeSignatureQuantization BeatType,int32 BeatNumber)
Set Quantized Event type of clock
Parameters
BPMBeatTypeBeatNumber
public virtual void SetBPM(float BPM,const FQuartzQuantizationBoundary & Boundary)
Set BPM Event of clock (note : it'll use for general standard clock event)
Parameters
BPMBoundary
public virtual void SetTimeSignature(const FQuartzTimeSignature & TimeSignature)
Set musical timesignature (like 4/4)
Parameters
[TimeSignature](#class_time_signature)
public virtual void SubscribeQuartzEvent()
public virtual void CreateBindQuartzEvent()
public virtual void OnMetronomeEvent(FName ClockName,EQuartzCommandQuantization QuantizationType,int32 NumBars,int32 Beat,float BeatFraction)
public virtual void OnQuartzCommandEvent(const EQuartzCommandDelegateSubType & EventType,FName Name)
protected FQuartzClockSettings QuartzClockSettings
protected TObjectPtr< UQuartzClockHandle > QuarzClockHandle
protected FQuartzQuantizationBoundary QuantizationBoundary
protected FOnQuartzCommandEventBP QuartzCommandEventBP
protected FOnQuartzMetronomeEventBP QuartzMetronomeEventBP
protected FName OwningClockName
protected virtual void BeginPlay()
class AAudioUnit
AAudioUnitIt helps simple audio playback functionality.
Summary
public FAudioUnitSaveInfo AudioUnitSaveInfo
public TObjectPtr< USceneComponent > SceneComponent
public TObjectPtr< UAudioComponent > AudioComponent
public TObjectPtr< USoundWave > SoundSource
public TObjectPtr< UMetaSoundSource > MetaSoundSource
public bool bUseMetaSoundInterface
public AAudioUnit()
public virtual void PlayAudio()
Simple play without fade in/out
public virtual void StopAudio()
Simple Stop without fade in/out
public virtual void Tick(float DeltaTime)
public inline void SetInfo(const FAudioUnitSaveInfo & AudioInfo)
protected virtual void BeginPlay()
Members
public FAudioUnitSaveInfo AudioUnitSaveInfo
public TObjectPtr< USceneComponent > SceneComponent
public TObjectPtr< UAudioComponent > AudioComponent
public TObjectPtr< USoundWave > SoundSource
public TObjectPtr< UMetaSoundSource > MetaSoundSource
public bool bUseMetaSoundInterface
public AAudioUnit()
public virtual void PlayAudio()
Simple play without fade in/out
public virtual void StopAudio()
Simple Stop without fade in/out
public virtual void Tick(float DeltaTime)
public inline void SetInfo(const FAudioUnitSaveInfo & AudioInfo)
protected virtual void BeginPlay()
class AEventManager
AEventManagerSummary
public FOnEventConstruct EventConstructFinish
public AEventManager()
public virtual void Tick(float DeltaTime)
public void SetEventDataTable(UDataTable * InputEventTable,UDataTable * InputSubEventTable,UDataTable * InputScriptTable)
public bool CheckEventAvailable(int32 EventID)
public FText FindEventScriptString(int32 MessageID)
public void ConstructEventsFromMessageMap()
public void ConstructEventQueueFromTable()
public void SendEventStringToMessageManager(FString InputMessageStr)
protected TArray< UEventBase* >EventQueue
protected TObjectPtr< UDataTable > EventTable
protected TObjectPtr< UDataTable > EventScriptTable
protected TObjectPtr< UDataTable > SubEventTable
protected TMap< int32, FString > EventScriptMap
protected TArray< int32 > ScriptIDArray
protected int32 CurrentEventID
protected TMap< int32, bool > EventOnOffCheck
protected virtual void BeginPlay()
protected int32 FindEventScriptID(int32 EventID)
Members
public FOnEventConstruct EventConstructFinish
public AEventManager()
public virtual void Tick(float DeltaTime)
public void SetEventDataTable(UDataTable * InputEventTable,UDataTable * InputSubEventTable,UDataTable * InputScriptTable)
public bool CheckEventAvailable(int32 EventID)
public FText FindEventScriptString(int32 MessageID)
public void ConstructEventsFromMessageMap()
public void ConstructEventQueueFromTable()
public void SendEventStringToMessageManager(FString InputMessageStr)
protected TArray< UEventBase* >EventQueue
protected TObjectPtr< UDataTable > EventTable
protected TObjectPtr< UDataTable > EventScriptTable
protected TObjectPtr< UDataTable > SubEventTable
protected TMap< int32, FString > EventScriptMap
protected TArray< int32 > ScriptIDArray
protected int32 CurrentEventID
protected TMap< int32, bool > EventOnOffCheck
protected virtual void BeginPlay()
protected int32 FindEventScriptID(int32 EventID)
class AInstrumentBase
AInstrumentBaseInstrument have an owner synthesizer.
Summary
public AInstrumentBase()
public virtual void Tick(float DeltaTime)
public virtual void InitSynthesizer(const FString & SoundfontPath)
public virtual void PlayMidiEvent(const FMidiEvent & MidiEvent)
public virtual void OpenSynthesizer()
public virtual void CloseSynthesizer()
public inline void SetSoundFontPath(const FString & SoundFontFullPath)
protected bool bIsSynthesizerReady
protected EInstrumentType InstrumentType
protected TObjectPtr< USoundWave > SynthesizerWave
protected TObjectPtr< USkeletalMeshComponent > InstrumentBody
protected TObjectPtr< UAudioComponent > AudioComponent
protected FTimerHandle FunctionTimer
protected FString SoundFontPath
protected virtual void BeginPlay()
protected virtual void EndPlay(const EEndPlayReason::Type EndPlayReason)
Members
public AInstrumentBase()
public virtual void Tick(float DeltaTime)
public virtual void InitSynthesizer(const FString & SoundfontPath)
public virtual void PlayMidiEvent(const FMidiEvent & MidiEvent)
public virtual void OpenSynthesizer()
public virtual void CloseSynthesizer()
public inline void SetSoundFontPath(const FString & SoundFontFullPath)
protected bool bIsSynthesizerReady
protected EInstrumentType InstrumentType
protected TObjectPtr< USoundWave > SynthesizerWave
protected TObjectPtr< USkeletalMeshComponent > InstrumentBody
protected TObjectPtr< UAudioComponent > AudioComponent
protected FTimerHandle FunctionTimer
protected FString SoundFontPath
protected virtual void BeginPlay()
protected virtual void EndPlay(const EEndPlayReason::Type EndPlayReason)
class AMUTACharacterBase
AMUTACharacterBaseCharacterBase : Contains Basic Character functions Contents specific
Summary
public AMUTACharacterBase()
public virtual void Tick(float DeltaTime)
public virtual void SetupPlayerInputComponent(class UInputComponent * PlayerInputComponent)
public inline FORCEINLINE USpringArmComponent * GetCameraBoom() const
Returns CameraBoom subobject
public inline FORCEINLINE UCameraComponent * GetFollowCamera() const
Returns FollowCamera subobject
protected USpringArmComponent * CameraBoom
Camera boom positioning the camera behind the character
protected UCameraComponent * FollowCamera
Follow camera
protected UInputMappingContext * DefaultMappingContext
MappingContext
protected UInputAction * JumpAction
Jump Input Action
protected UInputAction * MoveAction
Move Input Action
protected UInputAction * LookAction
Look Input Action
protected virtual void BeginPlay()
protected void Move(const FInputActionValue & Value)
Called for movement input
protected void Look(const FInputActionValue & Value)
Called for looking input
Members
public AMUTACharacterBase()
public virtual void Tick(float DeltaTime)
public virtual void SetupPlayerInputComponent(class UInputComponent * PlayerInputComponent)
public inline FORCEINLINE USpringArmComponent * GetCameraBoom() const
Returns CameraBoom subobject
public inline FORCEINLINE UCameraComponent * GetFollowCamera() const
Returns FollowCamera subobject
protected USpringArmComponent * CameraBoom
Camera boom positioning the camera behind the character
protected UCameraComponent * FollowCamera
Follow camera
protected UInputMappingContext * DefaultMappingContext
MappingContext
protected UInputAction * JumpAction
Jump Input Action
protected UInputAction * MoveAction
Move Input Action
protected UInputAction * LookAction
Look Input Action
protected virtual void BeginPlay()
protected void Move(const FInputActionValue & Value)
Called for movement input
protected void Look(const FInputActionValue & Value)
Called for looking input
class AMUTACustomizableCharacter
AMUTACustomizableCharacterCustomizable Character - designed to allow changing the skeletal mesh using an index-based approach
Summary
public AMUTACustomizableCharacter()
public virtual void Tick(float DeltaTime)
public virtual void SetupPlayerInputComponent(class UInputComponent * PlayerInputComponent)
public virtual void SetCharacterAssetCustom(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 MeshIdx,int32 ColorIdx)
Get DataAsset and change Mesh and color from index base
public virtual void SetCharacterAssetColor(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 ColorIdx)
public virtual void PlayEmoteAnimation(EEmoteCategory Emote)
select Emote state defined EmoteInterface and play emote animation
protected TObjectPtr< UAnimBlueprint > CharacterAnim
protected TMap< EEmoteCategory, TSubclassOf< UAnimationAsset > > AnimationMap
protected EEmoteCategory UserEmoteState
protected TObjectPtr< UCharacterCustomDataAsset>CharCustomizeAssetData
protected TObjectPtr< USkeletalMeshComponent > Head
protected TObjectPtr< USkeletalMeshComponent > Eye
protected TObjectPtr< USkeletalMeshComponent > EyeBrow
protected TObjectPtr< USkeletalMeshComponent > Mouth
protected TObjectPtr< USkeletalMeshComponent > Hair
protected TObjectPtr< USkeletalMeshComponent > Legs
protected TObjectPtr< USkeletalMeshComponent > Arms
protected TObjectPtr< USkeletalMeshComponent > Cloth
protected TObjectPtr< USkeletalMeshComponent > Pants
protected TObjectPtr< USkeletalMeshComponent > Shoes
protected TObjectPtr< USkeletalMeshComponent > HandAccessory
protected TObjectPtr< UMaterialInstanceDynamic > BodyMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > EyeMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > HairMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > MouthMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > ClothMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > PantsMaterialDynamic
protected virtual void BeginPlay()
Members
public AMUTACustomizableCharacter()
public virtual void Tick(float DeltaTime)
public virtual void SetupPlayerInputComponent(class UInputComponent * PlayerInputComponent)
public virtual void SetCharacterAssetCustom(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 MeshIdx,int32 ColorIdx)
Get DataAsset and change Mesh and color from index base
Parameters
AssetIdPart Asset ID - need to check Asset Data tableCharacterAssetPartSpecific Part for check validationMeshIdxColorIdxColor Index of material
public virtual void SetCharacterAssetColor(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 ColorIdx)
public virtual void PlayEmoteAnimation(EEmoteCategory Emote)
select Emote state defined EmoteInterface and play emote animation
Parameters
Emoteemote animation, it reference from CharacterAnims (TMap)
protected TObjectPtr< UAnimBlueprint > CharacterAnim
protected TMap< EEmoteCategory, TSubclassOf< UAnimationAsset > > AnimationMap
protected EEmoteCategory UserEmoteState
protected TObjectPtr< UCharacterCustomDataAsset>CharCustomizeAssetData
protected TObjectPtr< USkeletalMeshComponent > Head
protected TObjectPtr< USkeletalMeshComponent > Eye
protected TObjectPtr< USkeletalMeshComponent > EyeBrow
protected TObjectPtr< USkeletalMeshComponent > Mouth
protected TObjectPtr< USkeletalMeshComponent > Hair
protected TObjectPtr< USkeletalMeshComponent > Legs
protected TObjectPtr< USkeletalMeshComponent > Arms
protected TObjectPtr< USkeletalMeshComponent > Cloth
protected TObjectPtr< USkeletalMeshComponent > Pants
protected TObjectPtr< USkeletalMeshComponent > Shoes
protected TObjectPtr< USkeletalMeshComponent > HandAccessory
protected TObjectPtr< UMaterialInstanceDynamic > BodyMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > EyeMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > HairMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > MouthMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > ClothMaterialDynamic
protected TObjectPtr< UMaterialInstanceDynamic > PantsMaterialDynamic
protected virtual void BeginPlay()
class APlayablePiano
APlayablePianoSummary
public APlayablePiano()
public virtual void Tick(float DeltaTime)
public virtual void PlayInstNote(const FMidiEvent & MidiEvent)
#### Parameters
public virtual void PlayAnimation(const FMidiEvent & MidiEvent)
#### Parameters
public virtual void ShowPlayVisualization(const FString & FX_Id)
#### Parameters
public inline virtual UMidiPlayComponent * GetPlayComponent()
Please don't use this, will return nullptr
protected uint8 bHasOwner
protected virtual void BeginPlay()
Members
public APlayablePiano()
public virtual void Tick(float DeltaTime)
public virtual void PlayInstNote(const FMidiEvent & MidiEvent)
Parameters
[MidiEvent](#class_midi_event)
public virtual void PlayAnimation(const FMidiEvent & MidiEvent)
Parameters
[MidiEvent](#class_midi_event)
public virtual void ShowPlayVisualization(const FString & FX_Id)
Parameters
FX_Id
public inline virtual UMidiPlayComponent * GetPlayComponent()
Please don't use this, will return nullptr
Returns
protected uint8 bHasOwner
protected virtual void BeginPlay()
class ASingleNote
ASingleNoteSimple Note for visualize to rhythm game type falling note
Summary
public TObjectPtr< UStaticMeshComponent > NoteMesh
public ASingleNote()
public virtual void Tick(float DeltaTime)
public void SetNoteSpeedMode(const float Speed)
protected TObjectPtr< UProjectileMovementComponent > ProjectileMovementComponent
protected virtual void BeginPlay()
Members
public TObjectPtr< UStaticMeshComponent > NoteMesh
public ASingleNote()
public virtual void Tick(float DeltaTime)
public void SetNoteSpeedMode(const float Speed)
protected TObjectPtr< UProjectileMovementComponent > ProjectileMovementComponent
protected virtual void BeginPlay()
class ChannelAftertouch
ChannelAftertouchChannel Aftertouch Channel Event A event that can 'apply pressure to a MIDI channel, similar to applying pressure to electronic keyboard keys.'
Summary
public ChannelAftertouch(long tick,int channel,int amount)
public ChannelAftertouch(long tick,long delta,int channel,int amount)
public int getAmount()
public void setAmount(int p)
Members
public ChannelAftertouch(long tick,int channel,int amount)
public ChannelAftertouch(long tick,long delta,int channel,int amount)
public int getAmount()
public void setAmount(int p)
class ChannelEvent
ChannelEventAbstract Channel MIDI Event
Summary
public void setChannel(int c)
public int getChannel()
public int getValue1()
public int getValue2()
public virtual int compareTo(MidiEvent * other)
public virtual bool requiresStatusByte(MidiEvent * prevEvent)
public virtual void writeToFile(ostream & output,bool writeType)
protected int mChannel
protected int mValue1
protected int mValue2
protected ChannelEvent(long tick,int type,int channel,int param1,int param2)
protected ChannelEvent(long tick,long delta,int type,int channel,int param1,int param2)
protected ~ChannelEvent()
protected virtual int getEventSize()
Members
public void setChannel(int c)
public int getChannel()
public int getValue1()
public int getValue2()
public virtual int compareTo(MidiEvent * other)
public virtual bool requiresStatusByte(MidiEvent * prevEvent)
public virtual void writeToFile(ostream & output,bool writeType)
protected int mChannel
protected int mValue1
protected int mValue2
protected ChannelEvent(long tick,int type,int channel,int param1,int param2)
protected ChannelEvent(long tick,long delta,int type,int channel,int param1,int param2)
protected ~ChannelEvent()
protected virtual int getEventSize()
class Controller
ControllerController Channel Event A event that can 'affect a controller, such as a slider, knob, or switch.'
Summary
public Controller(long tick,int channel,int controllerType,int value)
public Controller(long tick,long delta,int channel,int controllerType,int value)
public int getControllerType()
public int getValue()
public void setControllerType(int t)
public void setValue(int v)
Members
public Controller(long tick,int channel,int controllerType,int value)
public Controller(long tick,long delta,int channel,int controllerType,int value)
public int getControllerType()
public int getValue()
public void setControllerType(int t)
public void setValue(int v)
class CopyrightNotice
CopyrightNoticeCopyright Notice Textual Meta Event A event that 'places a copyright notice in a MIDI file.'
Summary
public CopyrightNotice(long tick,long delta,string text)
public void setNotice(string t)
public string getNotice()
Members
public CopyrightNotice(long tick,long delta,string text)
public void setNotice(string t)
public string getNotice()
class CuePoint
CuePointCue Point Textual Meta Message A event that 'denotes a cue in a MIDI file, usually to signify the beginning of an action'
Summary
public CuePoint(long tick,long delta,string marker)
public void setCue(string name)
public string getCue()
Members
public CuePoint(long tick,long delta,string marker)
public void setCue(string name)
public string getCue()
class EndOfTrack
EndOfTrackEnd Of Track Meta Event A event that 'denotes the end of a MIDI track.'
Summary
public EndOfTrack(long tick,long delta)
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public EndOfTrack(long tick,long delta)
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class FInstumentCoreModule
FInstumentCoreModuleSummary
public virtual void StartupModule()
public virtual void ShutdownModule()
Members
public virtual void StartupModule()
public virtual void ShutdownModule()
class FMetaverseCoreModule
FMetaverseCoreModuleSummary
public virtual void StartupModule()
public virtual void ShutdownModule()
Members
public virtual void StartupModule()
public virtual void ShutdownModule()
class FMidiAssetEditorStyle
FMidiAssetEditorStyleMIDI Asset Style helper : Editor Asset Class Helper
Summary
Members
class FMidiProcessorWorker
FMidiProcessorWorkerSummary
public bool IsFinished() const
public FMidiProcessorWorker(MidiProcessor * IN_PC,bool UseGameTime)
public virtual ~FMidiProcessorWorker()
public virtual bool Init()
public virtual uint32 Run()
public virtual void Stop()
Members
public bool IsFinished() const
public FMidiProcessorWorker(MidiProcessor * IN_PC,bool UseGameTime)
public virtual ~FMidiProcessorWorker()
public virtual bool Init()
public virtual uint32 Run()
public virtual void Stop()
class FMusicCoreModule
FMusicCoreModuleSummary
public virtual void StartupModule()
public virtual void ShutdownModule()
Members
public virtual void StartupModule()
public virtual void ShutdownModule()
class FMUTAAssetEditorModule
FMUTAAssetEditorModuleSummary
public virtual void StartupModule()
public virtual void ShutdownModule()
public virtual bool SupportsDynamicReloading()
Members
public virtual void StartupModule()
public virtual void ShutdownModule()
public virtual bool SupportsDynamicReloading()
class FMUTAOnlineSearchSettings
FMUTAOnlineSearchSettingsSummary
public inline FMUTAOnlineSearchSettings(UMUTASearchSessionRequest * InSearchRequest)
public inline virtual ~FMUTAOnlineSearchSettings()
Members
public inline FMUTAOnlineSearchSettings(UMUTASearchSessionRequest * InSearchRequest)
public inline virtual ~FMUTAOnlineSearchSettings()
class FMUTAOnlineSearchSettingsBase
FMUTAOnlineSearchSettingsBaseSummary
public TObjectPtr< UMUTASearchSessionRequest>SearchRequest
public inline FMUTAOnlineSearchSettingsBase(UMUTASearchSessionRequest * InSearchRequest)
public inline virtual ~FMUTAOnlineSearchSettingsBase()
public inline virtual void AddReferencedObjects(FReferenceCollector & Collector)
public inline virtual FString GetReferencerName() const
Members
public TObjectPtr< UMUTASearchSessionRequest>SearchRequest
public inline FMUTAOnlineSearchSettingsBase(UMUTASearchSessionRequest * InSearchRequest)
public inline virtual ~FMUTAOnlineSearchSettingsBase()
public inline virtual void AddReferencedObjects(FReferenceCollector & Collector)
public inline virtual FString GetReferencerName() const
class FMUTAOnlineSessionSettings
FMUTAOnlineSessionSettingsSummary
public inline FMUTAOnlineSessionSettings(bool bIsLAN,bool bIsPresence,int32 MaxNumPlayers)
public inline virtual ~FMUTAOnlineSessionSettings()
Members
public inline FMUTAOnlineSessionSettings(bool bIsLAN,bool bIsPresence,int32 MaxNumPlayers)
public inline virtual ~FMUTAOnlineSessionSettings()
class FMUTASDKModule
FMUTASDKModuleSummary
public virtual void StartupModule()
IModuleInterface implementation
public virtual void ShutdownModule()
Members
public virtual void StartupModule()
IModuleInterface implementation
public virtual void ShutdownModule()
class FVisualizationCoreModule
FVisualizationCoreModuleSummary
public virtual void StartupModule()
public virtual void ShutdownModule()
Members
public virtual void StartupModule()
public virtual void ShutdownModule()
class GenericMetaEvent
GenericMetaEventGeneric Meta Event Class that holds unrecognized MIDI events
Summary
public GenericMetaEvent(long tick,long delta,MetaEventData & info)
public ~GenericMetaEvent()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public GenericMetaEvent(long tick,long delta,MetaEventData & info)
public ~GenericMetaEvent()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class ICharacterCustom
ICharacterCustomCharacter Customize Interface (index based - mesh , color)
Summary
public void SetCharacterAssetCustom(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 MeshIdx,int32 ColorIdx)
public void SetCharacterAssetColor(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 ColorIdx)
Members
public void SetCharacterAssetCustom(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 MeshIdx,int32 ColorIdx)
public void SetCharacterAssetColor(const FString & AssetId,ECharacterAssetPart CharacterAssetPart,int32 ColorIdx)
class IChatting
IChattingChatting Module Interface , It's used for find all Actor had ChatComponent.
Summary
public UChatComponent * GetChatComponent()
public FString GetCharacterName()
Members
public UChatComponent * GetChatComponent()
public FString GetCharacterName()
class IEmote
IEmoteDefine Emote functionality
Summary
public void PlayEmoteAnimation(EEmoteCategory Emote)
Members
public void PlayEmoteAnimation(EEmoteCategory Emote)
class IEventObserver
IEventObserverSummary
public void AddEvent()
public void QueueEvent()
public void EventCompleted()
Members
public void AddEvent()
public void QueueEvent()
public void EventCompleted()
class IFriend
IFriendFollowing unreal framework online subsystem functionality. Invite, Addlist, AddBlacklist etc.
Summary
public void CheckFriendStatus()
public void InviteFriend()
public void CheckFriendList()
public void CheckFriendBlackList()
public void AddFriendList()
public void AddFriendBlackList()
public void InviteToMyPlayGround()
Members
public void CheckFriendStatus()
public void InviteFriend()
public void CheckFriendList()
public void CheckFriendBlackList()
public void AddFriendList()
public void AddFriendBlackList()
public void InviteToMyPlayGround()
class IFXVisualizer
IFXVisualizerSummary
public void ShowVisualizer(EFXVisualizerType Type,const FString & EffectID)
public void PassFXAudioTimeParams(float BarDuration,float BPM)
Members
public void ShowVisualizer(EFXVisualizerType Type,const FString & EffectID)
public void PassFXAudioTimeParams(float BarDuration,float BPM)
class InstrumentName
InstrumentNameIntrument Name Textual Meta Event A event that 'shows the name of the instrument used in the current track.'
Summary
public InstrumentName(long tick,long delta,string name)
public void setName(string name)
public string getName()
Members
public InstrumentName(long tick,long delta,string name)
public void setName(string name)
public string getName()
class InstumentCore
InstumentCoreSummary
public inline InstumentCore(ReadOnlyTargetRules Target)
Members
public inline InstumentCore(ReadOnlyTargetRules Target)
class IPartyPlay
IPartyPlaySummary
public void JoinParty()
public void QuitParty()
public void CheckPartyStatus()
public void CheckPartyMemberStatus()
public void AllPartyMemberIsReady()
Members
public void JoinParty()
public void QuitParty()
public void CheckPartyStatus()
public void CheckPartyMemberStatus()
public void AllPartyMemberIsReady()
class IPlayableInst
IPlayableInstPlayable Instrument Interface : Defined midi event type playable instrument (i.e. not cosmetic type prop)
Summary
public void K2_PlayInstNote(const FMidiEvent & MidiEvent)
public void K2_PlayAnimation(const FMidiEvent & MidiEvent)
public void K2_ShowPlayVisualization(const FString & FX_Id)
public UMidiPlayComponent * K2_GetPlayComponent()
public void PlayInstNote(const FMidiEvent & MidiEvent)
public void PlayAnimation(const FMidiEvent & MidiEvent)
public void ShowPlayVisualization(const FString & FX_Id)
public UMidiPlayComponent * GetPlayComponent()
Members
public void K2_PlayInstNote(const FMidiEvent & MidiEvent)
public void K2_PlayAnimation(const FMidiEvent & MidiEvent)
public void K2_ShowPlayVisualization(const FString & FX_Id)
public UMidiPlayComponent * K2_GetPlayComponent()
public void PlayInstNote(const FMidiEvent & MidiEvent)
public void PlayAnimation(const FMidiEvent & MidiEvent)
public void ShowPlayVisualization(const FString & FX_Id)
public UMidiPlayComponent * GetPlayComponent()
class IQuartzClockPlay
IQuartzClockPlayDefine Quartz Clock based audio play contents ex : beat , bar type quantization event or need to in-time play
Summary
public void CreateQuartzClock()
public void StartQuartzClock()
public void StopQuartzClock()
public void ResetQuartzTransport()
public void ResumeQuartzClock()
public void HandleQuartzEvent()
public void SetTimeSignature(const FQuartzTimeSignature & TimeSignature)
public void SetBPM(float BPM,const FQuartzQuantizationBoundary & QuantizationBoundary)
Members
public void CreateQuartzClock()
public void StartQuartzClock()
public void StopQuartzClock()
public void ResetQuartzTransport()
public void ResumeQuartzClock()
public void HandleQuartzEvent()
public void SetTimeSignature(const FQuartzTimeSignature & TimeSignature)
public void SetBPM(float BPM,const FQuartzQuantizationBoundary & QuantizationBoundary)
class KeySignature
KeySignatureKey Signature Meta Event A event that 'specifies the key signature and scale of a MIDI file.'
Summary
public KeySignature(long tick,long delta,int key,int scale)
public void setKey(int key)
public int getKey()
public void setScale(int scale)
public int getScale()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public KeySignature(long tick,long delta,int key,int scale)
public void setKey(int key)
public int getKey()
public void setScale(int scale)
public int getScale()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class Lyrics
LyricsLyrics Textual Meta Event A event that 'shows the lyrics of a song at a particular time in the MIDI sequence.'
Summary
public Lyrics(long tick,long delta,string lyric)
public void setLyric(string t)
public string getLyric()
Members
public Lyrics(long tick,long delta,string lyric)
public void setLyric(string t)
public string getLyric()
class MetaEvent
MetaEventAbstract Meta MIDI Event A abstract event for 'messages that contains information about the MIDI sequence and that are not to be sent over MIDI ports.'
Summary
public virtual void writeToFile(ostream & output,bool writeType)
protected VariableLengthInt*mLength
protected MetaEvent(long tick,long delta,int type,VariableLengthInt * length)
protected virtual ~MetaEvent()
protected int getEventSize()
protected virtual void writeToFile(ostream & output)
Members
public virtual void writeToFile(ostream & output,bool writeType)
protected VariableLengthInt*mLength
protected MetaEvent(long tick,long delta,int type,VariableLengthInt * length)
protected virtual ~MetaEvent()
protected int getEventSize()
protected virtual void writeToFile(ostream & output)
class MetaEvent::MetaEventData
MetaEvent::MetaEventDataSummary
public int type
public VariableLengthInt*length
public char * data
public bool destroy
public inline MetaEventData(istream & input)
public inline ~MetaEventData()
Members
public int type
public VariableLengthInt*length
public char * data
public bool destroy
public inline MetaEventData(istream & input)
public inline ~MetaEventData()
class MetaverseCore
MetaverseCoreSummary
public inline MetaverseCore(ReadOnlyTargetRules Target)
Members
public inline MetaverseCore(ReadOnlyTargetRules Target)
class MetronomeTick
MetronomeTickAn event specifically for MidiProcessor to broadcast metronome ticks so that observers need not rely on time conversions or measure tracking
Summary
public MetronomeTick(TimeSignature * sig,int resolution)
public void setTimeSignature(TimeSignature * sig)
public bool update(double ticksElapsed)
public void setMetronomeFrequency(int meter)
public int getBeatNumber()
public int getMeasure()
public virtual std::string toString()
public virtual int compareTo(MidiEvent * o)
protected virtual int getEventSize()
protected virtual int getSize()
Members
public MetronomeTick(TimeSignature * sig,int resolution)
public void setTimeSignature(TimeSignature * sig)
public bool update(double ticksElapsed)
public void setMetronomeFrequency(int meter)
public int getBeatNumber()
public int getMeasure()
public virtual std::string toString()
public virtual int compareTo(MidiEvent * o)
protected virtual int getEventSize()
protected virtual int getSize()
class MidiApi
MidiApiSummary
public MidiApi()
public virtual ~MidiApi()
public RtMidi::Api getCurrentApi(void)
public void openPort(unsigned int portNumber,const std::string & portName)
public void openVirtualPort(const std::string & portName)
public void closePort(void)
public void setClientName(const std::string & clientName)
public void setPortName(const std::string & portName)
public unsigned int getPortCount(void)
public std::string getPortName(unsigned int portNumber)
public inline bool isPortOpen() const
public void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
public void error(RtMidiError::Type type,std::string errorString)
A basic error reporting function for RtMidi classes.
protected void * apiData_
protected bool connected_
protected std::string errorString_
protected RtMidiErrorCallback errorCallback_
protected bool firstErrorOccurred_
protected void * errorCallbackUserData_
protected void initialize(const std::string & clientName)
Members
public MidiApi()
public virtual ~MidiApi()
public RtMidi::Api getCurrentApi(void)
public void openPort(unsigned int portNumber,const std::string & portName)
public void openVirtualPort(const std::string & portName)
public void closePort(void)
public void setClientName(const std::string & clientName)
public void setPortName(const std::string & portName)
public unsigned int getPortCount(void)
public std::string getPortName(unsigned int portNumber)
public inline bool isPortOpen() const
public void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
public void error(RtMidiError::Type type,std::string errorString)
A basic error reporting function for RtMidi classes.
protected void * apiData_
protected bool connected_
protected std::string errorString_
protected RtMidiErrorCallback errorCallback_
protected bool firstErrorOccurred_
protected void * errorCallbackUserData_
protected void initialize(const std::string & clientName)
class MidiChannelPrefix
MidiChannelPrefixMIDI Channel Prefix Meta Event A event that 'specifies a MIDI channel so that meta messages that follow are specific to a channel.'
Summary
public MidiChannelPrefix(long tick,long delta,int channel)
public void setChannel(int c)
public int getChannel()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public MidiChannelPrefix(long tick,long delta,int channel)
public void setChannel(int c)
public int getChannel()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class MidiEvent
MidiEventabstract base class for midi events A event that 'is a piece of data sent to a MIDI device to prompt it to do something at a certain time.'
Summary
public MidiEvent(long tick,long delta)
public virtual ~MidiEvent()
public int getType()
public long getTick()
public long getDelta()
public void setDelta(long d)
public virtual int getSize()
public virtual bool requiresStatusByte(MidiEvent * prevEvent)
public virtual void writeToFile(ostream & output,bool writeType)
public int compareTo(MidiEvent * other)
public virtual string toString()
protected int mType
protected long mTick
protected VariableLengthInt*mDelta
protected int getEventSize()
Members
public MidiEvent(long tick,long delta)
public virtual ~MidiEvent()
public int getType()
public long getTick()
public long getDelta()
public void setDelta(long d)
public virtual int getSize()
public virtual bool requiresStatusByte(MidiEvent * prevEvent)
public virtual void writeToFile(ostream & output,bool writeType)
public int compareTo(MidiEvent * other)
public virtual string toString()
protected int mType
protected long mTick
protected VariableLengthInt*mDelta
protected int getEventSize()
class MidiEventListener
MidiEventListenerSummary
public void onStart(bool fromBeginning)
public void onEvent(MidiEvent * _event,long ms)
public void onStop(bool finished)
Members
public void onStart(bool fromBeginning)
public void onEvent(MidiEvent * _event,long ms)
public void onStop(bool finished)
class MidiFile
MidiFileSummary
public MidiFile()
public MidiFile(int resolution)
public MidiFile(int resolution,const vector< MidiTrack * > & tracks)
public MidiFile(istream & input)
public ~MidiFile()
public void setType(int type)
public int getType()
public int getTrackCount()
public void setResolution(int res)
public int getResolution()
public long getLengthInTicks()
public vector< MidiTrack* > &getTracks()
public void addTrack(MidiTrack * T)
public void addTrack(MidiTrack * T,int pos)
public void removeTrack(int pos)
public void writeToFile(ostream & output)
Members
public MidiFile()
public MidiFile(int resolution)
public MidiFile(int resolution,const vector< MidiTrack * > & tracks)
public MidiFile(istream & input)
public ~MidiFile()
public void setType(int type)
public int getType()
public int getTrackCount()
public void setResolution(int res)
public int getResolution()
public long getLengthInTicks()
public vector< MidiTrack* > &getTracks()
public void addTrack(MidiTrack * T)
public void addTrack(MidiTrack * T,int pos)
public void removeTrack(int pos)
public void writeToFile(ostream & output)
class MidiInApi
MidiInApiSummary
public MidiInApi(unsigned int queueSizeLimit)
public virtual ~MidiInApi(void)
public void setCallback(RtMidiIn::RtMidiCallback callback,void * userData)
public void cancelCallback(void)
public virtual void ignoreTypes(bool midiSysex,bool midiTime,bool midiSense)
public double getMessage(std::vector< unsigned char > * message)
protected RtMidiInData inputData_
Members
public MidiInApi(unsigned int queueSizeLimit)
public virtual ~MidiInApi(void)
public void setCallback(RtMidiIn::RtMidiCallback callback,void * userData)
public void cancelCallback(void)
public virtual void ignoreTypes(bool midiSysex,bool midiTime,bool midiSense)
public double getMessage(std::vector< unsigned char > * message)
protected RtMidiInData inputData_
class MidiInDummy
MidiInDummySummary
public inline MidiInDummy(const std::string &,unsigned int queueSizeLimit)
public inline virtual RtMidi::Api getCurrentApi(void)
public inline virtual void openPort(unsigned int,const std::string &)
public inline virtual void openVirtualPort(const std::string &)
public inline virtual void closePort(void)
public inline virtual void setClientName(const std::string &)
public inline virtual void setPortName(const std::string &)
public inline virtual unsigned int getPortCount(void)
public inline virtual std::string getPortName(unsigned int)
protected inline virtual void initialize(const std::string &)
Members
public inline MidiInDummy(const std::string &,unsigned int queueSizeLimit)
public inline virtual RtMidi::Api getCurrentApi(void)
public inline virtual void openPort(unsigned int,const std::string &)
public inline virtual void openVirtualPort(const std::string &)
public inline virtual void closePort(void)
public inline virtual void setClientName(const std::string &)
public inline virtual void setPortName(const std::string &)
public inline virtual unsigned int getPortCount(void)
public inline virtual std::string getPortName(unsigned int)
protected inline virtual void initialize(const std::string &)
class MidiOutApi
MidiOutApiSummary
public MidiOutApi(void)
public virtual ~MidiOutApi(void)
public void sendMessage(const unsigned char * message,size_t size)
Members
public MidiOutApi(void)
public virtual ~MidiOutApi(void)
public void sendMessage(const unsigned char * message,size_t size)
class MidiOutDummy
MidiOutDummySummary
public inline MidiOutDummy(const std::string &)
public inline virtual RtMidi::Api getCurrentApi(void)
public inline virtual void openPort(unsigned int,const std::string &)
public inline virtual void openVirtualPort(const std::string &)
public inline virtual void closePort(void)
public inline virtual void setClientName(const std::string &)
public inline virtual void setPortName(const std::string &)
public inline virtual unsigned int getPortCount(void)
public inline virtual std::string getPortName(unsigned int)
public inline virtual void sendMessage(const unsigned char *,size_t)
protected inline virtual void initialize(const std::string &)
Members
public inline MidiOutDummy(const std::string &)
public inline virtual RtMidi::Api getCurrentApi(void)
public inline virtual void openPort(unsigned int,const std::string &)
public inline virtual void openVirtualPort(const std::string &)
public inline virtual void closePort(void)
public inline virtual void setClientName(const std::string &)
public inline virtual void setPortName(const std::string &)
public inline virtual unsigned int getPortCount(void)
public inline virtual std::string getPortName(unsigned int)
public inline virtual void sendMessage(const unsigned char *,size_t)
protected inline virtual void initialize(const std::string &)
class MidiProcessor
MidiProcessorCopyright 2011 Alex Leffelman.
Loads and plays back a MIDI file
Summary
public double PlayRate
public int _trackID
public float(* milliFunction
public MidiProcessor()
public ~MidiProcessor()
public void load(MidiFile & file)
public void start(const double & deltaTime)
public void stop()
public void reset()
public bool isStarted()
public bool isRunning()
public void setListener(MidiEventListener * listener)
public void update(const double & deltaTime)
protected void dispatch(MidiEvent * _event)
Members
public double PlayRate
public int _trackID
public float(* milliFunction
public MidiProcessor()
public ~MidiProcessor()
public void load(MidiFile & file)
public void start(const double & deltaTime)
public void stop()
public void reset()
public bool isStarted()
public bool isRunning()
public void setListener(MidiEventListener * listener)
public void update(const double & deltaTime)
protected void dispatch(MidiEvent * _event)
class MidiTrack
MidiTrackSummary
public MidiTrack()
public MidiTrack(istream & input)
public ~MidiTrack()
public std::vector< MidiEvent* > &getEvents()
public int getEventCount()
public int getSize()
public long getLengthInTicks()
public void insertNote(int channel,int pitch,int velocity,long tick,long duration)
public void insertEvent(MidiEvent * newEvent)
public bool removeEvent(MidiEvent * E)
public void closeTrack()
public void dumpEvents()
public void writeToFile(ostream & output)
Members
public MidiTrack()
public MidiTrack(istream & input)
public ~MidiTrack()
public std::vector< MidiEvent* > &getEvents()
public int getEventCount()
public int getSize()
public long getLengthInTicks()
public void insertNote(int channel,int pitch,int velocity,long tick,long duration)
public void insertEvent(MidiEvent * newEvent)
public bool removeEvent(MidiEvent * E)
public void closeTrack()
public void dumpEvents()
public void writeToFile(ostream & output)
class MidiUtil
MidiUtilSummary
Members
class MusicCore
MusicCoreSummary
public inline MusicCore(TargetInfo Target)
Members
public inline MusicCore(TargetInfo Target)
class MUTAAssetEditor
MUTAAssetEditorSummary
public inline MUTAAssetEditor(TargetInfo Target)
Members
public inline MUTAAssetEditor(TargetInfo Target)
class MUTALogger
MUTALoggerSummary
Members
class MUTASDK
MUTASDKSummary
public inline MUTASDK(ReadOnlyTargetRules Target)
Members
public inline MUTASDK(ReadOnlyTargetRules Target)
class NoteAfterTouch
NoteAfterTouchNote After Touch A event that can 'apply pressure to a note playing, similar to applying pressure to electronic keyboard keys.'
Summary
public NoteAfterTouch(long tick,int channel,int note,int amount)
public NoteAfterTouch(long tick,long delta,int channel,int note,int amount)
public int getNoteValue()
public int getAmount()
public void setNoteValue(int p)
public void setAmount(int a)
Members
public NoteAfterTouch(long tick,int channel,int note,int amount)
public NoteAfterTouch(long tick,long delta,int channel,int note,int amount)
public int getNoteValue()
public int getAmount()
public void setNoteValue(int p)
public void setAmount(int a)
class NoteOff
NoteOffNote Off Channel Event A event that can 'release a note and stop playing it.'
Summary
public NoteOff(long tick,int channel,int note,int velocity)
public NoteOff(long tick,long delta,int channel,int note,int velocity)
public int getNoteValue()
public int getVelocity()
public void setNoteValue(int p)
public void setVelocity(int v)
Members
public NoteOff(long tick,int channel,int note,int velocity)
public NoteOff(long tick,long delta,int channel,int note,int velocity)
public int getNoteValue()
public int getVelocity()
public void setNoteValue(int p)
public void setVelocity(int v)
class NoteOn
NoteOnNote On Channel Event A event that can 'play a note and start sounding it.'
Summary
public NoteOn(long tick,int channel,int note,int velocity)
public NoteOn(long tick,long delta,int channel,int note,int velocity)
public int getNoteValue()
public int getVelocity()
public void setNoteValue(int p)
public void setVelocity(int v)
Members
public NoteOn(long tick,int channel,int note,int velocity)
public NoteOn(long tick,long delta,int channel,int note,int velocity)
public int getNoteValue()
public int getVelocity()
public void setNoteValue(int p)
public void setVelocity(int v)
class PitchBend
PitchBendPitch Bend Channel Event A event that can 'change a channel pitch up or down.'
Summary
public PitchBend(long tick,int channel,int lsb,int msb)
public PitchBend(long tick,long delta,int channel,int lsb,int msb)
public int getLeastSignificantBits()
public int getMostSignificantBits()
public int getBendAmount()
public void setLeastSignificantBits(int p)
public void setMostSignificantBits(int p)
public void setBendAmount(int amount)
Members
public PitchBend(long tick,int channel,int lsb,int msb)
public PitchBend(long tick,long delta,int channel,int lsb,int msb)
public int getLeastSignificantBits()
public int getMostSignificantBits()
public int getBendAmount()
public void setLeastSignificantBits(int p)
public void setMostSignificantBits(int p)
public void setBendAmount(int amount)
class ProgramChange
ProgramChangeProgram Change Channel Event A event that can 'assign a program to a MIDI channel, such as an instrument, patch, or preset.;
Summary
public ProgramChange(long tick,int channel,int program)
public ProgramChange(long tick,long delta,int channel,int program)
public int getProgramNumber()
public void setProgramNumber(int p)
enum MidiProgram
Members
public ProgramChange(long tick,int channel,int program)
public ProgramChange(long tick,long delta,int channel,int program)
public int getProgramNumber()
public void setProgramNumber(int p)
enum MidiProgram
ACOUSTIC_GRAND_PIANO
BRIGHT_ACOUSTIC_PIANO
ELECTRIC_GRAND_PIANO
HONKYTONK_PIANO
ELECTRIC_PIANO_1
ELECTRIC_PIANO_2
HARPSICHORD
CLAVINET
CELESTA
GLOCKENSPIEL
MUSIC_BOX
VIBRAPHONE
MARIMBA
XYLOPHONE
TUBULAR_BELLS
DULCIMER
DRAWBAR_ORGAN
PERCUSSIVE_ORGAN
ROCK_ORGAN
CHURCH_ORGAN
REED_ORGAN
ACCORDION
HARMONICA
TANGO_ACCORDION
ACOUSTIC_GUITAR_NYLON
ACOUSTIC_GUITAR_STEEL
ELECTRIC_GUITAR_JAZZ
ELECTRIC_GUITAR_CLEAN
ELECTRIC_GUITAR_MUTED
OVERDRIVEN_GUITAR
DISTORTION_GUITAR
GUITAR_HARMONICS
ACOUSTIC_BASS
ELECTRIC_BASS_FINGER
ELECTRIC_BASS_PICK
FRETLESS_BASS
SLAP_BASS_1
SLAP_BASS_2
SYNTH_BASS_1
SYNTH_BASS_2
VIOLIN
VIOLA
CELLO
CONTRABASS
TREMOLO_STRINGS
PIZZICATO_STRINGS
ORCHESTRAL_HARP
TIMPANI
STRING_ENSEMBLE_1
STRING_ENSEMBLE_2
SYNTH_STRINGS_1
SYNTH_STRINGS_2
CHOIR_AAHS
VOICE_OOHS
SYNTH_CHOIR
ORCHESTRA_HIT
TRUMPET
TROMBONE
TUBA
MUTED_TRUMPET
FRENCH_HORN
BRASS_SECTION
SYNTH_BRASS_1
SYNTH_BRASS_2
SOPRANO_SAX
ALTO_SAX
TENOR_SAX
BARITONE_SAX
OBOE
ENGLISH_HORN
BASSOON
CLARINET
PICCOLO
FLUTE
RECORDER
PAN_FLUTE
BLOWN_BOTTLE
SHAKUHACHI
WHISTLE
OCARINA
LEAD_1_SQUARE
LEAD_2_SAWTOOTH
LEAD_3_CALLIOPE
LEAD_4_CHIFF
LEAD_5_charANG
LEAD_6_VOICE
LEAD_7_FIFTHS
LEAD_8_BASS_AND_LEAD
PAD_1_NEW_AGE
PAD_2_WARM
PAD_3_POLYSYNTH
PAD_4_CHOIR
PAD_5_BOWED
PAD_6_METALLIC
PAD_7_HALO
PAD_8_SWEEP
FX_1_RAIN
FX_2_SOUNDTRACK
FX_3_CRYSTAL
FX_4_ATMOSPHERE
FX_5_BRIGHTNESS
FX_6_GOBLINS
FX_7_ECHOES
FX_8_SCIFI
SITAR
BANJO
SHAMISEN
KOTO
KALIMBA
BAGPIPE
FIDDLE
SHANAI
TINKLE_BELL
AGOGO
STEEL_DRUMS
WOODBLOCK
TAIKO_DRUM
MELODIC_TOM
SYNTH_DRUM
REVERSE_CYMBAL
GUITAR_FRET_NOISE
BREATH_NOISE
SEASHORE
BIRD_TWEET
TELEPHONE_RING
HELICOPTER
APPLAUSE
GUNSHOT
class RtMidi
RtMidiAn abstract base class for realtime MIDI input/output.
An abstract base class for realtime MIDI input/output. This class implements some common functionality for the realtime MIDI input/output subclasses RtMidiIn and RtMidiOut. RtMidi WWW site: http://music.mcgill.ca/~gary/rtmidi/RtMidi: realtime MIDI i/o C++ classes Copyright (c) 2003-2017 Gary P. Scavone Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. Any person wishing to distribute modifications to the Software is asked to send the modifications to the original developer so that they can be incorporated into the canonical version. This is, however, not a binding provision of this license. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This class implements some common functionality for the realtime MIDI input/output subclasses RtMidiIn and RtMidiOut.
RtMidi GitHub site: https://github.com/thestk/rtmidiRtMidi WWW site: http://www.music.mcgill.ca/~gary/rtmidi/
RtMidi: realtime MIDI i/o C++ classes Copyright (c) 2003-2019 Gary P. Scavone
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Any person wishing to distribute modifications to the Software is asked to send the modifications to the original developer so that they can be incorporated into the canonical version. This is, however, not a binding provision of this license.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Summary
public void openPort(unsigned int portNumber,const std::string & portName)
Pure virtual openPort() function.
public void openVirtualPort(const std::string & portName)
Pure virtual openVirtualPort() function.
public unsigned int getPortCount()
Pure virtual getPortCount() function.
public std::string getPortName(unsigned int portNumber)
Pure virtual getPortName() function.
public void closePort(void)
Pure virtual closePort() function.
public void setClientName(const std::string & clientName)
public void setPortName(const std::string & portName)
public bool isPortOpen(void) const
Returns true if a port is open and false if not.
public void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
Set an error callback function to be invoked when an error has occured.
protected MidiApi*rtapi_
protected RtMidi()
protected virtual ~RtMidi()
enum Api
MIDI API specifier arguments.
Members
public void openPort(unsigned int portNumber,const std::string & portName)
Pure virtual openPort() function.
public void openVirtualPort(const std::string & portName)
Pure virtual openVirtualPort() function.
public unsigned int getPortCount()
Pure virtual getPortCount() function.
public std::string getPortName(unsigned int portNumber)
Pure virtual getPortName() function.
public void closePort(void)
Pure virtual closePort() function.
public void setClientName(const std::string & clientName)
public void setPortName(const std::string & portName)
public bool isPortOpen(void) const
Returns true if a port is open and false if not.
Note that this only applies to connections made with the openPort() function, not to virtual ports.
public void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
Set an error callback function to be invoked when an error has occured.
The callback function will be called whenever an error has occured. It is best to set the error callback function before opening a port.
protected MidiApi*rtapi_
protected RtMidi()
protected virtual ~RtMidi()
enum Api
UNSPECIFIED
Search for a working compiled API.
MACOSX_CORE
Macintosh OS-X CoreMIDI API.
LINUX_ALSA
The Advanced Linux Sound Architecture API.
UNIX_JACK
The JACK Low-Latency MIDI Server API.
WINDOWS_MM
The Microsoft Multimedia MIDI API.
RTMIDI_DUMMY
A compilable but non-functional API.
MIDI API specifier arguments.
class RtMidiError
RtMidiErrorException handling class for RtMidi. The RtMidiError class is quite simple but it does allow errors to be "caught" by RtMidiError::Type. See the RtMidi documentation to know which methods can throw an RtMidiError.
Summary
public inline RtMidiError(const std::string & message,Type type)
The constructor.
public inline virtual ~RtMidiError(void)
The destructor.
public inline virtual void printMessage(void) const
Prints thrown error message to stderr.
public inline virtual const Type&getType(void) const
Returns the thrown error message type.
public inline virtual const std::string & getMessage(void) const
Returns the thrown error message string.
public inline virtual const char * what(void) const
Returns the thrown error message as a c-style string.
protected std::string message_
protected Type type_
enum Type
Defined RtMidiError types.
Members
public inline RtMidiError(const std::string & message,Type type)
The constructor.
public inline virtual ~RtMidiError(void)
The destructor.
public inline virtual void printMessage(void) const
Prints thrown error message to stderr.
public inline virtual const Type&getType(void) const
Returns the thrown error message type.
public inline virtual const std::string & getMessage(void) const
Returns the thrown error message string.
public inline virtual const char * what(void) const
Returns the thrown error message as a c-style string.
protected std::string message_
protected Type type_
enum Type
WARNING
A non-critical error.
DEBUG_WARNING
A non-critical error which might be useful for debugging.
UNSPECIFIED
The default, unspecified error type.
NO_DEVICES_FOUND
No devices found on system.
INVALID_DEVICE
An invalid device ID was specified.
MEMORY_ERROR
An error occured during memory allocation.
INVALID_PARAMETER
An invalid parameter was specified to a function.
INVALID_USE
The function was called incorrectly.
DRIVER_ERROR
A system driver error occured.
SYSTEM_ERROR
A system error occured.
THREAD_ERROR
A thread error occured.
Defined RtMidiError types.
class RtMidiIn
RtMidiInA realtime MIDI input class. This class provides a common, platform-independent API for realtime MIDI input. It allows access to a single MIDI input port. Incoming MIDI messages are either saved to a queue for retrieval using the getMessage() function or immediately passed to a user-specified callback function. Create multiple instances of this class to connect to more than one MIDI device at the same time. With the OS-X, Linux ALSA, and JACK MIDI APIs, it is also possible to open a virtual input port to which other MIDI software clients can connect. by Gary P. Scavone, 2003-2017.
Summary
public RtMidiIn(RtMidi::Api api,const std::string & clientName,unsigned int queueSizeLimit)
Default constructor that allows an optional api, client name and queue size.
public ~RtMidiIn(void)
If a MIDI connection is still open, it will be closed by the destructor.
public inline RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiIn.
public inline virtual void openPort(unsigned int portNumber,const std::string & portName)
Open a MIDI input connection given by enumeration number.
public inline virtual void openVirtualPort(const std::string & portName)
Create a virtual input port, with optional name, to allow software connections (OS X, JACK and ALSA only).
public inline void setCallback(RtMidiCallback callback,void * userData)
Set a callback function to be invoked for incoming MIDI messages.
public inline void cancelCallback()
Cancel use of the current callback function (if one exists).
public inline virtual void closePort(void)
Close an open MIDI connection (if one exists).
public inline virtual bool isPortOpen() const
Returns true if a port is open and false if not.
public inline virtual unsigned int getPortCount()
Return the number of available MIDI input ports.
public inline virtual std::string getPortName(unsigned int portNumber)
Return a string identifier for the specified MIDI input port number.
public inline void ignoreTypes(bool midiSysex,bool midiTime,bool midiSense)
Specify whether certain MIDI message types should be queued or ignored during input.
public inline double getMessage(std::vector< unsigned char > * message)
Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds.
public inline virtual void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
Set an error callback function to be invoked when an error has occured.
protected void openMidiApi(RtMidi::Api api,const std::string & clientName,unsigned int queueSizeLimit)
typedef RtMidiCallback
User callback function type definition.
Members
public RtMidiIn(RtMidi::Api api,const std::string & clientName,unsigned int queueSizeLimit)
Default constructor that allows an optional api, client name and queue size.
An exception will be thrown if a MIDI system initialization error occurs. The queue size defines the maximum number of messages that can be held in the MIDI queue (when not using a callback function). If the queue size limit is reached, incoming messages will be ignored. If no API argument is specified and multiple API support has been compiled, the default order of use is ALSA, JACK (Linux) and CORE, JACK (OS-X).
Parameters
apiAn optional API id can be specified.clientNameAn optional client name can be specified. This will be used to group the ports that are created by the application.queueSizeLimitAn optional size of the MIDI input queue can be specified.
public ~RtMidiIn(void)
If a MIDI connection is still open, it will be closed by the destructor.
public inline RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiIn.
public inline virtual void openPort(unsigned int portNumber,const std::string & portName)
Open a MIDI input connection given by enumeration number.
Parameters
portNumberAn optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened.portNameAn optional name for the application port that is used to connect to portId can be specified.
public inline virtual void openVirtualPort(const std::string & portName)
Create a virtual input port, with optional name, to allow software connections (OS X, JACK and ALSA only).
This function creates a virtual MIDI input port to which other software applications can connect. This type of functionality is currently only supported by the Macintosh OS-X, any JACK, and Linux ALSA APIs (the function returns an error for the other APIs).
Parameters
portNameAn optional name for the application port that is used to connect to portId can be specified.
public inline void setCallback(RtMidiCallback callback,void * userData)
Set a callback function to be invoked for incoming MIDI messages.
The callback function will be called whenever an incoming MIDI message is received. While not absolutely necessary, it is best to set the callback function before opening a MIDI port to avoid leaving some messages in the queue.
Parameters
callbackA callback function must be given.userDataOptionally, a pointer to additional data can be passed to the callback function whenever it is called.
public inline void cancelCallback()
Cancel use of the current callback function (if one exists).
Subsequent incoming MIDI messages will be written to the queue and can be retrieved with the getMessage function.
public inline virtual void closePort(void)
Close an open MIDI connection (if one exists).
public inline virtual bool isPortOpen() const
Returns true if a port is open and false if not.
Note that this only applies to connections made with the openPort() function, not to virtual ports.
public inline virtual unsigned int getPortCount()
Return the number of available MIDI input ports.
Returns
This function returns the number of MIDI ports of the selected API.
public inline virtual std::string getPortName(unsigned int portNumber)
Return a string identifier for the specified MIDI input port number.
Returns
The name of the port with the given Id is returned.
Parameters
Anempty string is returned if an invalid port specifier is provided. User code should assume a UTF-8 encoding.
public inline void ignoreTypes(bool midiSysex,bool midiTime,bool midiSense)
Specify whether certain MIDI message types should be queued or ignored during input.
By default, MIDI timing and active sensing messages are ignored during message input because of their relative high data rates. MIDI sysex messages are ignored by default as well. Variable values of "true" imply that the respective message type will be ignored.
public inline double getMessage(std::vector< unsigned char > * message)
Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds.
This function returns immediately whether a new message is available or not. A valid message is indicated by a non-zero vector size. An exception is thrown if an error occurs during message retrieval or an input connection was not previously established.
public inline virtual void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
Set an error callback function to be invoked when an error has occured.
The callback function will be called whenever an error has occured. It is best to set the error callback function before opening a port.
protected void openMidiApi(RtMidi::Api api,const std::string & clientName,unsigned int queueSizeLimit)
typedef RtMidiCallback
User callback function type definition.
class RtMidiOut
RtMidiOutA realtime MIDI output class. This class provides a common, platform-independent API for MIDI output. It allows one to probe available MIDI output ports, to connect to one such port, and to send MIDI bytes immediately over the connection. Create multiple instances of this class to connect to more than one MIDI device at the same time. With the OS-X, Linux ALSA and JACK MIDI APIs, it is also possible to open a virtual port to which other MIDI software clients can connect. by Gary P. Scavone, 2003-2017.
Summary
public RtMidiOut(RtMidi::Api api,const std::string & clientName)
Default constructor that allows an optional client name.
public ~RtMidiOut(void)
The destructor closes any open MIDI connections.
public inline RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiOut.
public inline virtual void openPort(unsigned int portNumber,const std::string & portName)
Open a MIDI output connection.
public inline virtual void closePort(void)
Close an open MIDI connection (if one exists).
public inline virtual bool isPortOpen() const
Returns true if a port is open and false if not.
public inline virtual void openVirtualPort(const std::string & portName)
Create a virtual output port, with optional name, to allow software connections (OS X, JACK and ALSA only).
public inline virtual unsigned int getPortCount(void)
Return the number of available MIDI output ports.
public inline virtual std::string getPortName(unsigned int portNumber)
Return a string identifier for the specified MIDI port type and number.
public inline void sendMessage(const std::vector< unsigned char > * message)
Immediately send a single message out an open MIDI output port.
public inline void sendMessage(const unsigned char * message,size_t size)
Immediately send a single message out an open MIDI output port.
public inline virtual void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
Set an error callback function to be invoked when an error has occured.
protected void openMidiApi(RtMidi::Api api,const std::string & clientName)
Members
public RtMidiOut(RtMidi::Api api,const std::string & clientName)
Default constructor that allows an optional client name.
An exception will be thrown if a MIDI system initialization error occurs. If no API argument is specified and multiple API support has been compiled, the default order of use is ALSA, JACK (Linux) and CORE, JACK (OS-X).
public ~RtMidiOut(void)
The destructor closes any open MIDI connections.
public inline RtMidi::Api getCurrentApi(void)
Returns the MIDI API specifier for the current instance of RtMidiOut.
public inline virtual void openPort(unsigned int portNumber,const std::string & portName)
Open a MIDI output connection.
An optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened. An exception is thrown if an error occurs while attempting to make the port connection.
public inline virtual void closePort(void)
Close an open MIDI connection (if one exists).
public inline virtual bool isPortOpen() const
Returns true if a port is open and false if not.
Note that this only applies to connections made with the openPort() function, not to virtual ports.
public inline virtual void openVirtualPort(const std::string & portName)
Create a virtual output port, with optional name, to allow software connections (OS X, JACK and ALSA only).
This function creates a virtual MIDI output port to which other software applications can connect. This type of functionality is currently only supported by the Macintosh OS-X, Linux ALSA and JACK APIs (the function does nothing with the other APIs). An exception is thrown if an error occurs while attempting to create the virtual port.
public inline virtual unsigned int getPortCount(void)
Return the number of available MIDI output ports.
public inline virtual std::string getPortName(unsigned int portNumber)
Return a string identifier for the specified MIDI port type and number.
Returns
The name of the port with the given Id is returned.
Parameters
Anempty string is returned if an invalid port specifier is provided. User code should assume a UTF-8 encoding.
public inline void sendMessage(const std::vector< unsigned char > * message)
Immediately send a single message out an open MIDI output port.
An exception is thrown if an error occurs during output or an output connection was not previously established.
public inline void sendMessage(const unsigned char * message,size_t size)
Immediately send a single message out an open MIDI output port.
An exception is thrown if an error occurs during output or an output connection was not previously established.
Parameters
messageA pointer to the MIDI message as raw bytessizeLength of the MIDI message in bytes
public inline virtual void setErrorCallback(RtMidiErrorCallback errorCallback,void * userData)
Set an error callback function to be invoked when an error has occured.
The callback function will be called whenever an error has occured. It is best to set the error callback function before opening a port.
protected void openMidiApi(RtMidi::Api api,const std::string & clientName)
class SequenceNumber
SequenceNumberSequence Number Meta Event A event that 'defines the number of a sequence in type 0 and 1 MIDI files, or the pattern number in type 2 MIDI files.'
Summary
public SequenceNumber(long tick,long delta,int number)
public int getMostSignificantBits()
public int getLeastSignificantBits()
public int getSequenceNumber()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public SequenceNumber(long tick,long delta,int number)
public int getMostSignificantBits()
public int getLeastSignificantBits()
public int getSequenceNumber()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class SequencerSpecificEvent
SequencerSpecificEventSequencer Specific Meta Event A event that 'carries information that is specific to a MIDI sequencer produced by a certain MIDI manufacturer.'
Summary
public SequencerSpecificEvent(long tick,long delta,string * data)
public ~SequencerSpecificEvent()
public void setData(string * data)
public string * getData()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public SequencerSpecificEvent(long tick,long delta,string * data)
public ~SequencerSpecificEvent()
public void setData(string * data)
public string * getData()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class SmpteOffset
SmpteOffsetSMPTE Offset Meta Event A event that 'specifies an offset for the starting point of a MIDI track from the start of a sequence in terms of SMPTE time.' (hours:minutes:seconds:frames:subframes)
Summary
public SmpteOffset(long tick,long delta,int fps,int hour,int min,int sec,int fr,int subfr)
public void setFrameRate(int fps)
public int getFrameRate()
public void setHours(int h)
public int getHours()
public void setMinutes(int m)
public int getMinutes()
public void setSeconds(int s)
public int getSeconds()
public void setFrames(int f)
public int getFrames()
public void setSubFrames(int s)
public int getSubFrames()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public SmpteOffset(long tick,long delta,int fps,int hour,int min,int sec,int fr,int subfr)
public void setFrameRate(int fps)
public int getFrameRate()
public void setHours(int h)
public int getHours()
public void setMinutes(int m)
public int getMinutes()
public void setSeconds(int s)
public int getSeconds()
public void setFrames(int f)
public int getFrames()
public void setSubFrames(int s)
public int getSubFrames()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class SystemExclusiveEvent
SystemExclusiveEventSystem Exclusive MIDI Event SysEx events may not be properly handled by this library.
Summary
public SystemExclusiveEvent(int type,long tick,string * data)
public SystemExclusiveEvent(int type,long tick,long delta,string * data)
public ~SystemExclusiveEvent()
public string * getData()
public void setData(string * data)
public virtual bool requiresStatusByte(MidiEvent * prevEvent)
public virtual void writeToFile(ostream & output,bool writeType)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public SystemExclusiveEvent(int type,long tick,string * data)
public SystemExclusiveEvent(int type,long tick,long delta,string * data)
public ~SystemExclusiveEvent()
public string * getData()
public void setData(string * data)
public virtual bool requiresStatusByte(MidiEvent * prevEvent)
public virtual void writeToFile(ostream & output,bool writeType)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class Tempo
TempoTempo Meta Event A event that 'sets the tempo of a MIDI sequence in terms of microseconds per quarter note.
Summary
public Tempo()
public Tempo(long tick,long delta,int mpqn)
public int getMpqn()
public float getBpm()
public void setMpqn(int m)
public void setBpm(float b)
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
Members
public Tempo()
public Tempo(long tick,long delta,int mpqn)
public int getMpqn()
public float getBpm()
public void setMpqn(int m)
public void setBpm(float b)
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
protected virtual int getEventSize()
class Text
TextText Textual Meta Event A event that 'defines some text to be carried within a MIDI file.'
Summary
public Text(long tick,long delta,string text)
public void setText(string t)
public string getText()
Members
public Text(long tick,long delta,string text)
public void setText(string t)
public string getText()
class TextualMetaEvent
TextualMetaEventAbstract Textual Meta Event A abstract event for 'messages that contains 'text based' information about the MIDI sequence and that are not to be sent over MIDI ports.'
Summary
public void setText(string t)
public string getText()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
public virtual string toString()
protected string mText
protected TextualMetaEvent(long tick,long delta,int type,string text)
protected ~TextualMetaEvent()
protected virtual int getEventSize()
Members
public void setText(string t)
public string getText()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
public virtual string toString()
protected string mText
protected TextualMetaEvent(long tick,long delta,int type,string text)
protected ~TextualMetaEvent()
protected virtual int getEventSize()
class TimeSignature
TimeSignatureTime Signature Meta Event A Event that 'defines the musical time signature of a MIDI sequence.'
Summary
public TimeSignature()
public TimeSignature(long tick,long delta,int num,int den,int meter,int div)
public void setTimeSignature(int num,int den,int meter,int div)
public int getNumerator()
public int getDenominatorValue()
public int getRealDenominator()
public int getMeter()
public int getDivision()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
public virtual string toString()
protected virtual int getEventSize()
Members
public TimeSignature()
public TimeSignature(long tick,long delta,int num,int den,int meter,int div)
public void setTimeSignature(int num,int den,int meter,int div)
public int getNumerator()
public int getDenominatorValue()
public int getRealDenominator()
public int getMeter()
public int getDivision()
public virtual void writeToFile(ostream & output)
public virtual int compareTo(MidiEvent * other)
public virtual string toString()
protected virtual int getEventSize()
class TrackName
TrackNameTrack Name Textual Meta Event A event that 'defines either the name of a MIDI sequence (when in MIDI type 0 or MIDI type 2 files, or when in the first track of a MIDI type 1 file), or the name of a MIDI track (when in other tracks of a MIDI type 1 file).'
Summary
public TrackName(long tick,long delta,string name)
public void setName(string name)
public string getTrackName()
Members
public TrackName(long tick,long delta,string name)
public void setName(string name)
public string getTrackName()
class UAudioTypes
UAudioTypesSummary
Members
class UCharacterCustom
UCharacterCustomSummary
Members
class UCharacterCustomDataAsset
UCharacterCustomDataAssetSummary
public FString AssetID
public int32 HeadMaxIdx
public int32 HeadColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > HeadMeshes
public int32 EyeMaxIdx
public int32 EyeColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > EyeMeshes
public int32 EyeBrowMaxIdx
public int32 EyeBrowColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > EyeBrowMeshes
public int32 MouthMaxIdx
public int32 MouthColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > MouthMeshes
public int32 HairMaxIdx
public int32 HairColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > HairMeshes
public int32 LegMaxIdx
public int32 LegColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > LegMeshes
public int32 ArmMaxIdx
public int32 ArmColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > ArmMeshes
public int32 ClothMaxIdx
public int32 ClothColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > ClothMeshes
public int32 PantsMaxIdx
public int32 PantsColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > PantsMeshes
public int32 ShoesMaxIdx
public int32 ShoesColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > ShoesMeshes
public int32 HandAccessoryMaxIdx
public int32 HandAccessoryColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > HandAccessoryMeshes
public int32 BackAccessoryMaxIdx
public int32 BackAccessoryColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > BackAccessoryMeshes
Members
public FString AssetID
public int32 HeadMaxIdx
public int32 HeadColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > HeadMeshes
public int32 EyeMaxIdx
public int32 EyeColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > EyeMeshes
public int32 EyeBrowMaxIdx
public int32 EyeBrowColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > EyeBrowMeshes
public int32 MouthMaxIdx
public int32 MouthColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > MouthMeshes
public int32 HairMaxIdx
public int32 HairColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > HairMeshes
public int32 LegMaxIdx
public int32 LegColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > LegMeshes
public int32 ArmMaxIdx
public int32 ArmColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > ArmMeshes
public int32 ClothMaxIdx
public int32 ClothColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > ClothMeshes
public int32 PantsMaxIdx
public int32 PantsColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > PantsMeshes
public int32 ShoesMaxIdx
public int32 ShoesColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > ShoesMeshes
public int32 HandAccessoryMaxIdx
public int32 HandAccessoryColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > HandAccessoryMeshes
public int32 BackAccessoryMaxIdx
public int32 BackAccessoryColorMaxIdx
public TArray< TSoftObjectPtr< USkeletalMesh > > BackAccessoryMeshes
class UChatEvent
UChatEventSummary
public EChatEventRole ChatEventRole
public FText ChatText
Members
public EChatEventRole ChatEventRole
public FText ChatText
class UChatting
UChattingSummary
Members
class UEmote
UEmoteSummary
Members
class UEmoteDataAsset
UEmoteDataAssetSummary
Members
class UEndEvent
UEndEventSummary
Members
class UEventBase
UEventBaseDefined DataTable Based Event Type,
Summary
public EEventType EventType
public bool bIsCompleted
public int32 EventID
public int32 EventMessageID
public int32 EventScriptID
public int32 EventIDNext
public int32 Step
Members
public EEventType EventType
public bool bIsCompleted
public int32 EventID
public int32 EventMessageID
public int32 EventScriptID
public int32 EventIDNext
public int32 Step
class UEventObserver
UEventObserverSummary
Members
class UFriend
UFriendSummary
Members
class UFunctionEvent
UFunctionEventSummary
public FName FunctionName
public TArray< FString > ParameterContext
Members
public FName FunctionName
public TArray< FString > ParameterContext
class UFXVisualizer
UFXVisualizerSummary
Members
class UGridRoomCreator
UGridRoomCreatorSceneCreate : Setup Room Theme and Instrument in logical grid map (Simple Room Create example)
Summary
protected int32 MapHeight
protected int32 MapWidth
protected TArray< int32 > RoomGridBaseMap
protected TArray< int32 > WallGridBaseMap
protected TArray< int32 > CurrentRoomGridMap
protected TArray< int32 > CurrentWallGridMap
protected TMap< int32, FVector > PositionMapRoom
protected TMap< int32, FVector > PositionMapWall
Members
protected int32 MapHeight
protected int32 MapWidth
protected TArray< int32 > RoomGridBaseMap
protected TArray< int32 > WallGridBaseMap
protected TArray< int32 > CurrentRoomGridMap
protected TArray< int32 > CurrentWallGridMap
protected TMap< int32, FVector > PositionMapRoom
protected TMap< int32, FVector > PositionMapWall
class UInputActionEvent
UInputActionEventSummary
public TMap< FString, int32 > RequiredChatInput
public UInputActionEvent()
Members
public TMap< FString, int32 > RequiredChatInput
public UInputActionEvent()
class UInstrumentType
UInstrumentTypeSummary
Members
class UMidiAssetFactory
UMidiAssetFactorySummary
public virtual UObject * FactoryCreateBinary(UClass * InClass,UObject * InParent,FName InName,EObjectFlags Flags,UObject * Context,const TCHAR * Type,const uint8 *& Buffer,const uint8 * BufferEnd,FFeedbackContext * Warn,bool & bOutOperationCanceled)
Members
public virtual UObject * FactoryCreateBinary(UClass * InClass,UObject * InParent,FName InName,EObjectFlags Flags,UObject * Context,const TCHAR * Type,const uint8 *& Buffer,const uint8 * BufferEnd,FFeedbackContext * Warn,bool & bOutOperationCanceled)
class UMidiInterfaceUtil
UMidiInterfaceUtilSummary
Members
class UMidiRecorder
UMidiRecorderUnreal Adaptor class of midi recorder library
Summary
public void Initialize()
public void OnDeviceMessageReceived(EMidiRecordertype EventType,int32 Channel,int32 Data1,int32 Data2,float Timestamp)
public void SaveMidiFiletoPath(const FString & SavePath)
public void InternalRecordMidi(const std::vector< unsigned char > & MidiEvent,double DeltaTime)
public void AddMidiNote(int32 TrackIdx,const FMidiEvent & MidiEvent)
Add Midi Note to a specific track
public void RequestAnalyzeMidiSequence()
public void RequestQuantizeMidiSequence(int32 period)
public void WriteMidiFile(const FString & FilePath)
protected midirecoder::MidiIO MidiRecorder
protected std::vector< midirecoder::MidiTrack>Tracks
protected midirecoder::MidiFile MidiFile
protected midirecoder::MidiTrack MidiTrack
protected int32 TimeStamp
protected double PreviousTimestamp
protected UMidiRecorder()
Members
public void Initialize()
public void OnDeviceMessageReceived(EMidiRecordertype EventType,int32 Channel,int32 Data1,int32 Data2,float Timestamp)
public void SaveMidiFiletoPath(const FString & SavePath)
public void InternalRecordMidi(const std::vector< unsigned char > & MidiEvent,double DeltaTime)
public void AddMidiNote(int32 TrackIdx,const FMidiEvent & MidiEvent)
Add Midi Note to a specific track
Parameters
TrackIdx[MidiEvent](#class_midi_event)MidiEvent : it's type using with network message too. (w/o after touch event)
public void RequestAnalyzeMidiSequence()
public void RequestQuantizeMidiSequence(int32 period)
public void WriteMidiFile(const FString & FilePath)
protected midirecoder::MidiIO MidiRecorder
protected std::vector< midirecoder::MidiTrack>Tracks
protected midirecoder::MidiFile MidiFile
protected midirecoder::MidiTrack MidiTrack
protected int32 TimeStamp
protected double PreviousTimestamp
protected UMidiRecorder()
class UMidiTypes
UMidiTypesSummary
Members
class UMUTAHostSessionRequest
UMUTAHostSessionRequestSummary
public EMUTASessionOnlineMode OnlineMode
Indicates if the session is a full online session or a different type
public bool bUseLobbies
True if this request should create a player-hosted lobbies if available
public FString ModeNameForAdvertisement
String used during matchmaking to specify what type of game mode this is
public FPrimaryAssetId MapID
@DEPRECATED : it's before 4 version concept , The map that will be loaded at the start of gameplay, this needs to be a valid Primary Asset top-level map
public FString MapURL
public TMap< FString, FString > ExtraArgs
Extra arguments passed as URL options to the game
public int32 MaxPlayerCount
Maximum players allowed per gameplay session
public virtual int32 GetMaxPlayers() const
UMUTAHostSessionRequest.
public virtual FString GetMapName() const
Returns the full URL (map) that will be used during gameplay
public inline virtual void SetMapURL(const FString & NewURL)
set the full URL that will be used during gameplay
public virtual FString ConstructTravelURL() const
Constructs the full URL that will be passed to ServerTravel
public virtual bool ValidateAndLogErrors(FText & OutError) const
Returns true if this request is valid, returns false and logs errors if it is not
Members
public EMUTASessionOnlineMode OnlineMode
Indicates if the session is a full online session or a different type
public bool bUseLobbies
True if this request should create a player-hosted lobbies if available
public FString ModeNameForAdvertisement
String used during matchmaking to specify what type of game mode this is
public FPrimaryAssetId MapID
@DEPRECATED : it's before 4 version concept , The map that will be loaded at the start of gameplay, this needs to be a valid Primary Asset top-level map
public FString MapURL
public TMap< FString, FString > ExtraArgs
Extra arguments passed as URL options to the game
public int32 MaxPlayerCount
Maximum players allowed per gameplay session
public virtual int32 GetMaxPlayers() const
UMUTAHostSessionRequest.
Returns the maximum players that should actually be used, could be overridden in child classes
public virtual FString GetMapName() const
Returns the full URL (map) that will be used during gameplay
public inline virtual void SetMapURL(const FString & NewURL)
set the full URL that will be used during gameplay
public virtual FString ConstructTravelURL() const
Constructs the full URL that will be passed to ServerTravel
public virtual bool ValidateAndLogErrors(FText & OutError) const
Returns true if this request is valid, returns false and logs errors if it is not
class UMUTAPrimaryDataAsset
UMUTAPrimaryDataAssetSummary
public FPrimaryAssetType AssetType
The type of asset, in this example this value HAS to be specified in the constructor for each type(unless its abstract).
public FSoftObjectPath MapPath
public TMap< FString, FString > ExtraArgs
Extra arguments passed as URL options to the game
public FText TileTitle
Primary title in the UI
public FText TileSubTitle
Secondary title
public FText TileDescription
Full description
public TObjectPtr< UTexture2D > TileIcon
Icon used in the UI
public TObjectPtr< UTexture2D > TitleTexture
Icon used in the UI
public int32 MaxPlayerCount
Max number of players for this session
public inline virtual FPrimaryAssetId GetPrimaryAssetId() const
public UMUTAHostSessionRequest*CreateHostingRequest(const UObject * WorldContextObject) const
Create a request object that is used to actually start a session with these settings
Members
public FPrimaryAssetType AssetType
The type of asset, in this example this value HAS to be specified in the constructor for each type(unless its abstract).
public FSoftObjectPath MapPath
public TMap< FString, FString > ExtraArgs
Extra arguments passed as URL options to the game
public FText TileTitle
Primary title in the UI
public FText TileSubTitle
Secondary title
public FText TileDescription
Full description
public TObjectPtr< UTexture2D > TileIcon
Icon used in the UI
public TObjectPtr< UTexture2D > TitleTexture
Icon used in the UI
public int32 MaxPlayerCount
Max number of players for this session
public inline virtual FPrimaryAssetId GetPrimaryAssetId() const
public UMUTAHostSessionRequest*CreateHostingRequest(const UObject * WorldContextObject) const
Create a request object that is used to actually start a session with these settings
class UMUTASearchSessionRequest
UMUTASearchSessionRequestSummary
public EMUTASessionOnlineMode OnlineMode
Indicates if this is looking for full online games or a different type like LAN
public bool bUseLobbies
True if this request should look for player-hosted lobbies if they are available, false will only search for registered server sessions
public TArray< TObjectPtr< UMUTASessionSearchResult> >Results
List of all found sessions, will be valid when OnSearchFinished is called
public FMUTA_FindSessionsFinished OnSearchFinished
Native Delegate called when a session search completes
public void NotifySearchFinished(bool bSucceeded,const FText & ErrorMessage)
Called by subsystem to execute finished delegates
Members
public EMUTASessionOnlineMode OnlineMode
Indicates if this is looking for full online games or a different type like LAN
public bool bUseLobbies
True if this request should look for player-hosted lobbies if they are available, false will only search for registered server sessions
public TArray< TObjectPtr< UMUTASessionSearchResult> >Results
List of all found sessions, will be valid when OnSearchFinished is called
public FMUTA_FindSessionsFinished OnSearchFinished
Native Delegate called when a session search completes
public void NotifySearchFinished(bool bSucceeded,const FText & ErrorMessage)
Called by subsystem to execute finished delegates
class UMUTASessionSearchResult
UMUTASessionSearchResultA result object returned from the online system that describes a joinable game session
Summary
public FOnlineSessionSearchResult Result
public FString GetDescription() const
Returns an internal description of the session, not meant to be human-readable
public void GetStringSetting(FName Key,FString & Value,bool & bFoundValue) const
Gets an arbitrary string setting, bFoundValue will be false if the setting does not exist
public void GetIntSetting(FName Key,int32 & Value,bool & bFoundValue) const
Gets an arbitrary integer setting, bFoundValue will be false if the setting does not exist
public int32 GetNumOpenPrivateConnections() const
The number of private connections that are available
public int32 GetNumOpenPublicConnections() const
The number of publicly available connections that are available
public int32 GetMaxPublicConnections() const
The maximum number of publicly available connections that could be available, including already filled connections
public int32 GetPingInMs() const
Ping to the search result, MAX_QUERY_PING is unreachable
Members
public FOnlineSessionSearchResult Result
public FString GetDescription() const
Returns an internal description of the session, not meant to be human-readable
public void GetStringSetting(FName Key,FString & Value,bool & bFoundValue) const
Gets an arbitrary string setting, bFoundValue will be false if the setting does not exist
public void GetIntSetting(FName Key,int32 & Value,bool & bFoundValue) const
Gets an arbitrary integer setting, bFoundValue will be false if the setting does not exist
public int32 GetNumOpenPrivateConnections() const
The number of private connections that are available
public int32 GetNumOpenPublicConnections() const
The number of publicly available connections that are available
public int32 GetMaxPublicConnections() const
The maximum number of publicly available connections that could be available, including already filled connections
public int32 GetPingInMs() const
Ping to the search result, MAX_QUERY_PING is unreachable
class UMUTASessionSubsystem
UMUTASessionSubsystemSummary
public FMUTASessionOnUserRequestedSession OnUserRequestedSessionEvent
Events.
public FMUTASessionOnUserRequestedSession_Dynamic K2_OnUserRequestedSessionEvent
Event broadcast when a local user has accepted an invite
public FMUTASessionOnJoinSessionComplete OnJoinSessionCompleteEvent
Native Delegate when a JoinSession call has completed
public FMUTASessionOnJoinSessionComplete_Dynamic K2_OnJoinSessionCompleteEvent
Event broadcast when a JoinSession call has completed
public FCommonSessionOnCreateSessionComplete OnCreateSessionCompleteEvent
Native Delegate when a CreateSession call has completed
public FCommonSessionOnCreateSessionComplete_Dynamic K2_OnCreateSessionCompleteEvent
Event broadcast when a CreateSession call has completed
public FMUTASessionOnSessionInformationChanged OnSessionInformationChangedEvent
Native Delegate when the presentable session information has changed
public FMUTASessionOnSessionInformationChanged_Dynamic K2_OnSessionInformationChangedEvent
Event broadcast when the presentable session information has changed
public FMUTASessionOnPreClientTravel OnPreClientTravelEvent
Native Delegate for modifying the connect URL prior to a client travel
public bool bUseLobbiesDefault
Sets the default value of bUseLobbies for session search and host requests
public UMUTASessionSubsystem()
public virtual void Initialize(FSubsystemCollectionBase & Collection)
public virtual void Deinitialize()
public virtual bool ShouldCreateSubsystem(UObject * Outer) const
public void OpenLobby()
public void CallOpenLevel(const FString & Address)
public void CallClientTravel(const FString & Address)
public void CreateSession(int32 MaxPlayers,const FString & MatchType)
public virtual UMUTAHostSessionRequest*CreateOnlineHostSessionRequest()
Creates a host session request with default options for online games, this can be modified after creation
public virtual UMUTASearchSessionRequest*CreateOnlineSearchSessionRequest()
Creates a session search object with default options to look for default online games, this can be modified after creation
public virtual void HostSession(APlayerController * HostingPlayer,UMUTAHostSessionRequest * Request)
Creates a new online game using the session request information, if successful this will start a hard map transfer
public virtual void QuickPlaySession(APlayerController * JoiningOrHostingPlayer,UMUTAHostSessionRequest * Request)
Starts a process to look for existing sessions or create a new one if no viable sessions are found
public virtual void JoinSession(APlayerController * JoiningPlayer,UMUTASessionSearchResult * Request)
Starts process to join an existing session, if successful this will connect to the specified server
public virtual void FindSessions(APlayerController * SearchingPlayer,UMUTASearchSessionRequest * Request)
Queries online system for the list of joinable sessions matching the search request
public virtual void CleanUpSessions()
Clean up any active sessions, called from cases like returning to the main menu
protected FString PendingTravelURL
The travel URL that will be used after session operations are complete
protected FOnlineResultInformation CreateSessionResult
Most recent result information for a session creation attempt, stored here to allow storing error codes for later
protected bool bWantToDestroyPendingSession
True if we want to cancel the session after it is created
protected bool bIsDedicatedServer
True if this is a dedicated server, which doesn't require a LocalPlayer to create a session
protected TSharedPtr< FMUTAOnlineSearchSettings>SearchSettings
Settings for the current search
protected TSharedPtr< FMUTAOnlineSessionSettings>HostSettings
Settings for the current host request
protected virtual TSharedRef< FMUTAOnlineSearchSettings>CreateQuickPlaySearchSettings(UMUTAHostSessionRequest * Request,UMUTASearchSessionRequest * QuickPlayRequest)
Called to fill in a session request from quick play host settings, can be overridden for game-specific behavior
protected virtual void HandleQuickPlaySearchFinished(bool bSucceeded,const FText & ErrorMessage,TWeakObjectPtr< APlayerController > JoiningOrHostingPlayer,TStrongObjectPtr< UMUTAHostSessionRequest > HostRequest)
Called when a quick play search finishes, can be overridden for game-specific behavior
protected virtual void TravelLocalSessionFailure(UWorld * World,ETravelFailure::Type FailureType,const FString & ReasonString)
Called when traveling to a session fails
protected virtual void OnCreateSessionComplete(FName SessionName,bool bWasSuccessful)
Called when a new session is either created or fails to be created
protected virtual void FinishSessionCreation(bool bWasSuccessful)
Called to finalize session creation
protected virtual void HandlePostLoadMap(UWorld * World)
Called after traveling to the new hosted session map
protected void CreateSessionInternal(int32 NumPublicConnections,const FString & MatchType)
protected void DestroySession()
protected void StartSession()
protected bool IsValidSessionInterface()
protected void BindOnlineDelegates()
protected void CreateOnlineSessionInternal(ULocalPlayer * LocalPlayer,UMUTAHostSessionRequest * Request)
protected void FindSessionsInternal(APlayerController * SearchingPlayer,const TSharedRef< FMUTAOnlineSearchSettings > & InSearchSettings)
protected void JoinSessionInternal(ULocalPlayer * LocalPlayer,UMUTASessionSearchResult * Request)
protected void InternalTravelToSession(const FName SessionName)
protected void NotifyUserRequestedSession(const FPlatformUserId & PlatformUserId,UMUTASessionSearchResult* RequestedSession,constFOnlineResultInformation & RequestedSessionResult)
protected void NotifyJoinSessionComplete(const FOnlineResultInformation & Result)
protected void NotifyCreateSessionComplete(const FOnlineResultInformation & Result)
protected void NotifySessionInformationUpdated(EMUTASessionInformationState SessionStatus,const FString & GameMode,const FString & MapName)
protected void SetCreateSessionError(const FText & ErrorText)
protected void HandleSessionFailure(const FUniqueNetId & NetId,ESessionFailure::Type FailureType)
protected void HandleSessionUserInviteAccepted(const bool bWasSuccessful,const int32 LocalUserIndex,FUniqueNetIdPtr AcceptingUserId,const FOnlineSessionSearchResult & SearchResult)
protected void OnStartSessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnRegisterLocalPlayerComplete_CreateSession(const FUniqueNetId & PlayerId,EOnJoinSessionCompleteResult::Type Result)
protected void OnUpdateSessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnEndSessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnDestroySessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnFindSessionsComplete(bool bWasSuccessful)
protected void OnJoinSessionComplete(FName SessionName,EOnJoinSessionCompleteResult::Type Result)
protected void OnRegisterJoiningLocalPlayerComplete(const FUniqueNetId & PlayerId,EOnJoinSessionCompleteResult::Type Result)
protected void FinishJoinSession(EOnJoinSessionCompleteResult::Type Result)
Members
public FMUTASessionOnUserRequestedSession OnUserRequestedSessionEvent
Events.
Native Delegate when a local user has accepted an invite
public FMUTASessionOnUserRequestedSession_Dynamic K2_OnUserRequestedSessionEvent
Event broadcast when a local user has accepted an invite
public FMUTASessionOnJoinSessionComplete OnJoinSessionCompleteEvent
Native Delegate when a JoinSession call has completed
public FMUTASessionOnJoinSessionComplete_Dynamic K2_OnJoinSessionCompleteEvent
Event broadcast when a JoinSession call has completed
public FCommonSessionOnCreateSessionComplete OnCreateSessionCompleteEvent
Native Delegate when a CreateSession call has completed
public FCommonSessionOnCreateSessionComplete_Dynamic K2_OnCreateSessionCompleteEvent
Event broadcast when a CreateSession call has completed
public FMUTASessionOnSessionInformationChanged OnSessionInformationChangedEvent
Native Delegate when the presentable session information has changed
public FMUTASessionOnSessionInformationChanged_Dynamic K2_OnSessionInformationChangedEvent
Event broadcast when the presentable session information has changed
public FMUTASessionOnPreClientTravel OnPreClientTravelEvent
Native Delegate for modifying the connect URL prior to a client travel
public bool bUseLobbiesDefault
Sets the default value of bUseLobbies for session search and host requests
public UMUTASessionSubsystem()
public virtual void Initialize(FSubsystemCollectionBase & Collection)
public virtual void Deinitialize()
public virtual bool ShouldCreateSubsystem(UObject * Outer) const
public void OpenLobby()
public void CallOpenLevel(const FString & Address)
public void CallClientTravel(const FString & Address)
public void CreateSession(int32 MaxPlayers,const FString & MatchType)
public virtual UMUTAHostSessionRequest*CreateOnlineHostSessionRequest()
Creates a host session request with default options for online games, this can be modified after creation
public virtual UMUTASearchSessionRequest*CreateOnlineSearchSessionRequest()
Creates a session search object with default options to look for default online games, this can be modified after creation
public virtual void HostSession(APlayerController * HostingPlayer,UMUTAHostSessionRequest * Request)
Creates a new online game using the session request information, if successful this will start a hard map transfer
public virtual void QuickPlaySession(APlayerController * JoiningOrHostingPlayer,UMUTAHostSessionRequest * Request)
Starts a process to look for existing sessions or create a new one if no viable sessions are found
public virtual void JoinSession(APlayerController * JoiningPlayer,UMUTASessionSearchResult * Request)
Starts process to join an existing session, if successful this will connect to the specified server
public virtual void FindSessions(APlayerController * SearchingPlayer,UMUTASearchSessionRequest * Request)
Queries online system for the list of joinable sessions matching the search request
public virtual void CleanUpSessions()
Clean up any active sessions, called from cases like returning to the main menu
protected FString PendingTravelURL
The travel URL that will be used after session operations are complete
protected FOnlineResultInformation CreateSessionResult
Most recent result information for a session creation attempt, stored here to allow storing error codes for later
protected bool bWantToDestroyPendingSession
True if we want to cancel the session after it is created
protected bool bIsDedicatedServer
True if this is a dedicated server, which doesn't require a LocalPlayer to create a session
protected TSharedPtr< FMUTAOnlineSearchSettings>SearchSettings
Settings for the current search
protected TSharedPtr< FMUTAOnlineSessionSettings>HostSettings
Settings for the current host request
protected virtual TSharedRef< FMUTAOnlineSearchSettings>CreateQuickPlaySearchSettings(UMUTAHostSessionRequest * Request,UMUTASearchSessionRequest * QuickPlayRequest)
Called to fill in a session request from quick play host settings, can be overridden for game-specific behavior
protected virtual void HandleQuickPlaySearchFinished(bool bSucceeded,const FText & ErrorMessage,TWeakObjectPtr< APlayerController > JoiningOrHostingPlayer,TStrongObjectPtr< UMUTAHostSessionRequest > HostRequest)
Called when a quick play search finishes, can be overridden for game-specific behavior
protected virtual void TravelLocalSessionFailure(UWorld * World,ETravelFailure::Type FailureType,const FString & ReasonString)
Called when traveling to a session fails
protected virtual void OnCreateSessionComplete(FName SessionName,bool bWasSuccessful)
Called when a new session is either created or fails to be created
protected virtual void FinishSessionCreation(bool bWasSuccessful)
Called to finalize session creation
protected virtual void HandlePostLoadMap(UWorld * World)
Called after traveling to the new hosted session map
protected void CreateSessionInternal(int32 NumPublicConnections,const FString & MatchType)
protected void DestroySession()
protected void StartSession()
protected bool IsValidSessionInterface()
protected void BindOnlineDelegates()
protected void CreateOnlineSessionInternal(ULocalPlayer * LocalPlayer,UMUTAHostSessionRequest * Request)
protected void FindSessionsInternal(APlayerController * SearchingPlayer,const TSharedRef< FMUTAOnlineSearchSettings > & InSearchSettings)
protected void JoinSessionInternal(ULocalPlayer * LocalPlayer,UMUTASessionSearchResult * Request)
protected void InternalTravelToSession(const FName SessionName)
protected void NotifyUserRequestedSession(const FPlatformUserId & PlatformUserId,UMUTASessionSearchResult* RequestedSession,constFOnlineResultInformation & RequestedSessionResult)
protected void NotifyJoinSessionComplete(const FOnlineResultInformation & Result)
protected void NotifyCreateSessionComplete(const FOnlineResultInformation & Result)
protected void NotifySessionInformationUpdated(EMUTASessionInformationState SessionStatus,const FString & GameMode,const FString & MapName)
protected void SetCreateSessionError(const FText & ErrorText)
protected void HandleSessionFailure(const FUniqueNetId & NetId,ESessionFailure::Type FailureType)
protected void HandleSessionUserInviteAccepted(const bool bWasSuccessful,const int32 LocalUserIndex,FUniqueNetIdPtr AcceptingUserId,const FOnlineSessionSearchResult & SearchResult)
protected void OnStartSessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnRegisterLocalPlayerComplete_CreateSession(const FUniqueNetId & PlayerId,EOnJoinSessionCompleteResult::Type Result)
protected void OnUpdateSessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnEndSessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnDestroySessionComplete(FName SessionName,bool bWasSuccessful)
protected void OnFindSessionsComplete(bool bWasSuccessful)
protected void OnJoinSessionComplete(FName SessionName,EOnJoinSessionCompleteResult::Type Result)
protected void OnRegisterJoiningLocalPlayerComplete(const FUniqueNetId & PlayerId,EOnJoinSessionCompleteResult::Type Result)
protected void FinishJoinSession(EOnJoinSessionCompleteResult::Type Result)
class UMUTASessionTypes
UMUTASessionTypesSummary
Members
class UPartyPlay
UPartyPlaySummary
Members
class UPlayableInst
UPlayableInstSummary
Members
class UQuartzClockPlay
UQuartzClockPlaySummary
Members
class USampleTankService
USampleTankServiceSampleTank API Service Object : Helps get songform sample (4 measures) Currently Server implemented legacy CMS based API
Summary
public void RequestSignUp()
Request SampleTank Service SignUp note : Currently not accepting general user registration. You should request account ID/Password for now
public void RequestLogin(bool bIsTokenLongExpirationPeriod)
Request Login and Set corrent token
public void QueryTokenValidation()
QueryTokenValidation
public void RequestSampleTankList(const FString & QueryString,const FString & SearchString)
Get List and Update to SampleList Array
public void RequestSampleDetailInfo(const FString & SampleID)
Request Indivisual sample information
public void UpdateSampleTankUserInfo(const FSampleTankUserInfo & UserInfoInput)
Set UserInfo , Should set before request any service api
public void OnRequestCompleteLogin(FHttpRequestPtr Request,FHttpResponsePtr Response,bool bSuccess)
public void OnRequestCompleteListSearch(FHttpRequestPtr Request,FHttpResponsePtr Response,bool bSuccess)
protected FOnSampleTankResponseReceived OnSampleTankResponseReceived
protected FString BaseURL
protected FSampleTankUserInfo UserInfo
protected FString ServiceToken
protected TArray< FString > SampleDownloadList
protected FString SearchName
Members
public void RequestSignUp()
Request SampleTank Service SignUp note : Currently not accepting general user registration. You should request account ID/Password for now
public void RequestLogin(bool bIsTokenLongExpirationPeriod)
Request Login and Set corrent token
Parameters
bIsTokenLongExpirationPeriod: true - 30days
public void QueryTokenValidation()
QueryTokenValidation
public void RequestSampleTankList(const FString & QueryString,const FString & SearchString)
Get List and Update to SampleList Array
Parameters
QueryString: String Type QueryString (e.g.: ?filter={"genre":"specific genre"}
public void RequestSampleDetailInfo(const FString & SampleID)
Request Indivisual sample information
Parameters
SampleID
public void UpdateSampleTankUserInfo(const FSampleTankUserInfo & UserInfoInput)
Set UserInfo , Should set before request any service api
Parameters
UserInfoInputSampleTank Service UserInfo
public void OnRequestCompleteLogin(FHttpRequestPtr Request,FHttpResponsePtr Response,bool bSuccess)
public void OnRequestCompleteListSearch(FHttpRequestPtr Request,FHttpResponsePtr Response,bool bSuccess)
protected FOnSampleTankResponseReceived OnSampleTankResponseReceived
protected FString BaseURL
protected FSampleTankUserInfo UserInfo
protected FString ServiceToken
protected TArray< FString > SampleDownloadList
protected FString SearchName
class USequencerType
USequencerTypeJust using Type Definition
Summary
Members
class USessionTestWidget
USessionTestWidgetSummary
public void MenuSetup(int32 NumberOfPublicConnections,FString TypeOfMatch,FString LobbyPath)
protected TObjectPtr< UButton > HostButton
protected TObjectPtr< UButton > JoinButton
protected TObjectPtr< UButton > FindButton
protected class UMUTASessionSubsystem*MultiplayerSessionsSubsystem
protected int32 NumPublicConnections
protected FString MatchType
protected FString PathToLobby
protected virtual bool Initialize()
protected virtual void NativeConstruct()
protected virtual void NativeDestruct()
protected void OnCreateSession(bool bWasSuccessful)
protected void OnFindSessions(const TArray< FOnlineSessionSearchResult > & SessionResults,bool bWasSuccessful)
protected void OnJoinSession(EOnJoinSessionCompleteResult::Type Result)
protected void OnDestroySession(bool bWasSuccessful)
protected void OnStartSession(bool bWasSuccessful)
protected void HostButtonClicked()
protected void JoinButtonClicked()
protected void MenuTearDown()
Members
public void MenuSetup(int32 NumberOfPublicConnections,FString TypeOfMatch,FString LobbyPath)
protected TObjectPtr< UButton > HostButton
protected TObjectPtr< UButton > JoinButton
protected TObjectPtr< UButton > FindButton
protected class UMUTASessionSubsystem*MultiplayerSessionsSubsystem
protected int32 NumPublicConnections
protected FString MatchType
protected FString PathToLobby
protected virtual bool Initialize()
protected virtual void NativeConstruct()
protected virtual void NativeDestruct()
protected void OnCreateSession(bool bWasSuccessful)
protected void OnFindSessions(const TArray< FOnlineSessionSearchResult > & SessionResults,bool bWasSuccessful)
protected void OnJoinSession(EOnJoinSessionCompleteResult::Type Result)
protected void OnDestroySession(bool bWasSuccessful)
protected void OnStartSession(bool bWasSuccessful)
protected void HostButtonClicked()
protected void JoinButtonClicked()
protected void MenuTearDown()
class USoundUtils
USoundUtilsSoundFont based Synthesizer(midi event) and dynamic sound asset from midi file
Summary
Members
class USoundWaveDynamicMidi
USoundWaveDynamicMidiSummary
public USoundWaveDynamicMidi(const FObjectInitializer & Initializer)
public void LoadFont(tsf * soundFont)
public virtual void Serialize(FArchive & Ar)
public virtual void GetAssetRegistryTags(TArray< FAssetRegistryTag > & OutTags) const
public virtual int32 GeneratePCMData(uint8 * PCMData,const int32 SamplesNeeded)
public virtual int32 GetResourceSizeForFormat(FName Format)
public virtual FByteBulkData * GetCompressedData(FName Format,const FPlatformAudioCookOverrides * CompressionOverrides)
public virtual void InitAudioResource(FByteBulkData & CompressedData)
public virtual bool InitAudioResource(FName Format)
public virtual void BeginDestroy()
public void QueueEvent(const FMidiEvent & e)
Members
public USoundWaveDynamicMidi(const FObjectInitializer & Initializer)
public void LoadFont(tsf * soundFont)
public virtual void Serialize(FArchive & Ar)
public virtual void GetAssetRegistryTags(TArray< FAssetRegistryTag > & OutTags) const
public virtual int32 GeneratePCMData(uint8 * PCMData,const int32 SamplesNeeded)
public virtual int32 GetResourceSizeForFormat(FName Format)
public virtual FByteBulkData * GetCompressedData(FName Format,const FPlatformAudioCookOverrides * CompressionOverrides)
public virtual void InitAudioResource(FByteBulkData & CompressedData)
public virtual bool InitAudioResource(FName Format)
public virtual void BeginDestroy()
public void QueueEvent(const FMidiEvent & e)
class UWebSocketInstance
UWebSocketInstanceWebsocket service example using GameInstance Do not use solely. this is for testing websocket make sure that convert this class to subsystem class rather then gameinstance.
Summary
public FString UniqueID
public bool CheckOwnUniqueID
public TSharedPtr< IWebSocket > WebSocket
public FMessageReceive MessageReceive
public FOnWebSocketStateEvent WebSocketStateEvent
public virtual void Init()
public virtual void Shutdown()
public void CreateWebSocketConnect(const FString ServerIP)
CreateWebSocketConnect Connect to WebSocket Server and BroadCast it's state
Members
public FString UniqueID
public bool CheckOwnUniqueID
public TSharedPtr< IWebSocket > WebSocket
public FMessageReceive MessageReceive
public FOnWebSocketStateEvent WebSocketStateEvent
public virtual void Init()
public virtual void Shutdown()
public void CreateWebSocketConnect(const FString ServerIP)
CreateWebSocketConnect Connect to WebSocket Server and BroadCast it's state
Parameters
ServerIPWebsocket server location IP
class UWebSocketRPC
UWebSocketRPCWebsocket RPC Example Class Websocket JSON base RPC, for specific presentation RPCTask is defined in RPC JSONBody , Context of RPCTask : Generated FString Type
Summary
public FOnRPCTaskEvt RPCTaskEvt
public UWebSocketRPC()
public void ExecuteRPCTask(ERPCType RequestRPC,FString Context)
public FString GeneratedRPCContext()
public void HandleRPCMessage(FString RPCMessage)
public void SendTestRPCMessage(FString SendMessage)
Send test message to websocket server, It will be return same message
public void PrintChat(FString Context)
public void SpawnActor(FString Context)
public void ChangeTheme(FString Context)
public void PlayMusic(FString Context)
public void UpdateParams(FString Context)
public void ShowUI(FString Context)
public void ChangeStep(FString Context)
public void SelectGenre(FString Context)
protected FString PrefixChat
protected FString PrefixChat_AI
protected FString PrefixChat_System
protected FString PrefixChat_User
protected FString PrefixSpawn
protected FString PrefixTheme
protected FString PrefixPlay
protected FString PrefixUpdate
protected FString PrefixShowUI
protected FString PrefixRPC
protected FString PrefixStep
protected FString PrefixGenre
protected ERPCType CurrentRPC
protected TMap< FString, ERPCType > RPCTypeConvertMap
Members
public FOnRPCTaskEvt RPCTaskEvt
public UWebSocketRPC()
public void ExecuteRPCTask(ERPCType RequestRPC,FString Context)
public FString GeneratedRPCContext()
public void HandleRPCMessage(FString RPCMessage)
public void SendTestRPCMessage(FString SendMessage)
Send test message to websocket server, It will be return same message
Parameters
SendMessage: you need to add RPC prefix manually
public void PrintChat(FString Context)
public void SpawnActor(FString Context)
public void ChangeTheme(FString Context)
public void PlayMusic(FString Context)
public void UpdateParams(FString Context)
public void ShowUI(FString Context)
public void ChangeStep(FString Context)
public void SelectGenre(FString Context)
protected FString PrefixChat
protected FString PrefixChat_AI
protected FString PrefixChat_System
protected FString PrefixChat_User
protected FString PrefixSpawn
protected FString PrefixTheme
protected FString PrefixPlay
protected FString PrefixUpdate
protected FString PrefixShowUI
protected FString PrefixRPC
protected FString PrefixStep
protected FString PrefixGenre
protected ERPCType CurrentRPC
protected TMap< FString, ERPCType > RPCTypeConvertMap
class VariableLengthInt
VariableLengthIntVariable Length Integer
Summary
public VariableLengthInt(int value)
public VariableLengthInt(istream & input)
public ~VariableLengthInt()
public void setValue(int value)
public int getValue()
public int getByteCount()
public char * getBytes()
public string toString()
Members
public VariableLengthInt(int value)
public VariableLengthInt(istream & input)
public ~VariableLengthInt()
public void setValue(int value)
public int getValue()
public int getByteCount()
public char * getBytes()
public string toString()
class VisualizationCore
VisualizationCoreSummary
public inline VisualizationCore(ReadOnlyTargetRules Target)
Members
public inline VisualizationCore(ReadOnlyTargetRules Target)
struct FAudioUnitSaveInfo
FAudioUnitSaveInfoSummary
public FString Genre
public FString Energy
public int32 Variation
public float BPM_Source
public float BPM_Base
public FString CodeProgression
public float ReverbWeight
public float PanningValue
Members
public FString Genre
public FString Energy
public int32 Variation
public float BPM_Source
public float BPM_Base
public FString CodeProgression
public float ReverbWeight
public float PanningValue
struct FChatMessage
FChatMessageSummary
public EChatMessageType MessageType
public FString ChatMessage
public FString ChatSenderName
Members
public EChatMessageType MessageType
public FString ChatMessage
public FString ChatSenderName
struct FCustomizeAssetData
FCustomizeAssetDataCustomizable Asset Mesh Data , It's not same to asset DB entities Especially, It's useful to make local DataTable
Summary
public FString AssetID
public ECharacterAssetPart AssetPart
public TObjectPtr< USkeletalMesh > Mesh
public FString Description
Members
public FString AssetID
public ECharacterAssetPart AssetPart
public TObjectPtr< USkeletalMesh > Mesh
public FString Description
struct FEventTableStruct
FEventTableStructSummary
public int32 ID
public FString Description
Members
public int32 ID
public FString Description
struct FMidiClockEvent
FMidiClockEventSummary
public EMidiClockTypeEnum Type
public int32 Data
public inline FMidiClockEvent()
Members
public EMidiClockTypeEnum Type
public int32 Data
public inline FMidiClockEvent()
struct FMidiDevice
FMidiDeviceSummary
public FString Name
public uint8 Port
public inline FMidiDevice()
public inline FMidiDevice(FString name,uint8 port)
Members
public FString Name
public uint8 Port
public inline FMidiDevice()
public inline FMidiDevice(FString name,uint8 port)
struct FMidiEvent
FMidiEventSummary
public EMidiTypeEnum Type
public uint8 Channel
public uint8 Data1
public uint8 Data2
public int32 Data3
public int32 ID
public int32 Tick
public inline FMidiEvent()
Members
public EMidiTypeEnum Type
public uint8 Channel
public uint8 Data1
public uint8 Data2
public int32 Data3
public int32 ID
public int32 Tick
public inline FMidiEvent()
struct FMusicBlockInfo
FMusicBlockInfoInformation of Song-form style block (Duration : 4-8 measures). Especially using step sequencer experience
Summary
public ESongGenre Genre
public int32 Number
public ESongFormEnergy Energy
public int32 Variation
public ESongInstrument Instrument
Members
public ESongGenre Genre
public int32 Number
public ESongFormEnergy Energy
public int32 Variation
public ESongInstrument Instrument
struct FOnlineResultInformation
FOnlineResultInformationDetailed information about the online error. Effectively a wrapper for FOnlineError.
Summary
public bool bWasSuccessful
Whether the operation was successful or not. If it was successful, the error fields of this struct will not contain extra information.
public FString ErrorId
The unique error id. Can be used to compare against specific handled errors.
public FText ErrorText
Error text to display to the user.
public void MUTASDK_API FromOnlineError(const FOnlineErrorType & InOnlineError)
Initialize this from an FOnlineErrorType
Members
public bool bWasSuccessful
Whether the operation was successful or not. If it was successful, the error fields of this struct will not contain extra information.
public FString ErrorId
The unique error id. Can be used to compare against specific handled errors.
public FText ErrorText
Error text to display to the user.
public void MUTASDK_API FromOnlineError(const FOnlineErrorType & InOnlineError)
Initialize this from an FOnlineErrorType
Parameters
InOnlineErrorthe online error to initialize from
struct FSampleTankUserInfo
FSampleTankUserInfoSummary
public FString Name
public FString UserId
public FString Password
public FString PhoneNumber
Members
public FString Name
public FString UserId
public FString Password
public FString PhoneNumber
struct FSequenceStep
FSequenceStepSummary
public int32 TrackNum
public int32 StepIndex
public FMusicBlockInfo MusicBlockInfo
public bool bIsOn
public inline FSequenceStep(int32 TrackIdx,int32 StepIdx,ESongFormEnergy Energy)
public inline FSequenceStep()
Members
public int32 TrackNum
public int32 StepIndex
public FMusicBlockInfo MusicBlockInfo
public bool bIsOn
public inline FSequenceStep(int32 TrackIdx,int32 StepIdx,ESongFormEnergy Energy)
public inline FSequenceStep()
struct FStepScript
FStepScriptSummary
public int32 ScriptID
public EAutocompStep Step
public FText Script
Members
public int32 ScriptID
public EAutocompStep Step
public FText Script
struct FStepSequenceBoard
FStepSequenceBoardSummary
public TArray< FSequenceStep>SequenceSteps
Members
public TArray< FSequenceStep>SequenceSteps
struct FSubEventTableStruct
FSubEventTableStructSummary
public int32 EventID
public int32 EventIDNext
public EEventType EventType
public EEventGenre EventGenre
public int32 Step
public int32 ScriptID
public FName FunctionName
public TArray< FString > FuncContext
public TArray< FString > ChatRequireText
public TArray< int32 > ChatNextEventIDs
Members
public int32 EventID
public int32 EventIDNext
public EEventType EventType
public EEventGenre EventGenre
public int32 Step
public int32 ScriptID
public FName FunctionName
public TArray< FString > FuncContext
public TArray< FString > ChatRequireText
public TArray< int32 > ChatNextEventIDs
struct FUserSessionStatus
FUserSessionStatusSummary
public bool bIsHost
public bool ReadyStatus
public int32 PlayerID
public FText Username
public UTexture2D * User_Avatar
Members
public bool bIsHost
public bool ReadyStatus
public int32 PlayerID
public FText Username
public UTexture2D * User_Avatar
struct membuf
membufSummary
public inline membuf(char * begin,char * end)
Members
public inline membuf(char * begin,char * end)
struct MidiInApi::MidiMessage
MidiInApi::MidiMessageSummary
public std::vector< unsigned char > bytes
public double timeStamp
Time in seconds elapsed since the previous message.
public inline MidiMessage()
Members
public std::vector< unsigned char > bytes
public double timeStamp
Time in seconds elapsed since the previous message.
public inline MidiMessage()
struct MidiInApi::MidiQueue
MidiInApi::MidiQueueSummary
public unsigned int front
public unsigned int back
public unsigned int ringSize
public MidiMessage*ring
public inline MidiQueue()
public bool push(const MidiMessage &)
public bool pop(std::vector< unsigned char > *,double *)
public unsigned int size(unsigned int * back,unsigned int * front)
Members
public unsigned int front
public unsigned int back
public unsigned int ringSize
public MidiMessage*ring
public inline MidiQueue()
public bool push(const MidiMessage &)
public bool pop(std::vector< unsigned char > *,double *)
public unsigned int size(unsigned int * back,unsigned int * front)
struct MML_LITE
MML_LITESummary
public int defaultLength
public unsigned int index
public unsigned int track
public float curPos
public unsigned int octave
public int tempo
public unsigned int volume
public string * source
public bool skipNext
public MidiTrack*_track
public vector< MidiTrack* >_tracks
public void addNote(int note,float speed,int * mod)
public void moveTime(float speed)
public int * parseModifiers()
public void parseNote()
public void parse(string data)
public void reset()
Members
public int defaultLength
public unsigned int index
public unsigned int track
public float curPos
public unsigned int octave
public int tempo
public unsigned int volume
public string * source
public bool skipNext
public MidiTrack*_track
public vector< MidiTrack* >_tracks
public void addNote(int note,float speed,int * mod)
public void moveTime(float speed)
public int * parseModifiers()
public void parseNote()
public void parse(string data)
public void reset()
struct MidiInApi::RtMidiInData
MidiInApi::RtMidiInDataSummary
public MidiQueue queue
public MidiMessage message
public unsigned char ignoreFlags
public bool doInput
public bool firstMessage
public void * apiData
public bool usingCallback
public RtMidiIn::RtMidiCallback userCallback
public void * userData
public bool continueSysex
public inline RtMidiInData()
Members
public MidiQueue queue
public MidiMessage message
public unsigned char ignoreFlags
public bool doInput
public bool firstMessage
public void * apiData
public bool usingCallback
public RtMidiIn::RtMidiCallback userCallback
public void * userData
public bool continueSysex
public inline RtMidiInData()
struct tml_message
tml_messageSummary
public unsigned int time
public unsigned char type
public unsigned char channel
public char key
public char control
public char program
public char channel_pressure
public char velocity
public char key_pressure
public char control_value
public unsigned short pitch_bend
public union tml_message ``
public struct tml_message*next
Members
public unsigned int time
public unsigned char type
public unsigned char channel
public char key
public char control
public char program
public char channel_pressure
public char velocity
public char key_pressure
public char control_value
public unsigned short pitch_bend
public union tml_message ``
public struct tml_message*next
struct tml_stream
tml_streamSummary
public void * data
public int(* read
Members
public void * data
public int(* read
struct tsf_stream
tsf_streamSummary
public void * data
public int(* read
public int(* skip
Members
public void * data
public int(* read
public int(* skip
Generated by Moxygen