UMIDIDeviceController

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MIDIDevice

Header

/Engine/Plugins/Runtime/MIDIDevice/Source/MIDIDevice/Public/MIDIDeviceController.h

Include

#include "MIDIDeviceController.h"

Syntax

UCLASS(BlueprintType)
class UMIDIDeviceController : public UMIDIDeviceControllerBase

Variables

Name Description

Protected variable UProperty Category BlueprintReadOnly

int32

 

DeviceID

The unique ID of this device

Protected variable UProperty Category BlueprintReadOnly

FString

 

DeviceName

The name of this device. This name comes from the MIDI hardware, any might not be unique

Protected variable

int32

 

MIDIBufferSize

Size of the MIDI buffer in bytes

Public variable UProperty Category BlueprintAssignable

FOnMIDIEvent

 

OnMIDIEvent

Register with this to find out about incoming MIDI events from this device

Protected variable

void *

 

PMMIDIInputStream

The PortMidi stream used for MIDI input for this device

Destructors

Name Description

Public function Virtual

~UMIDIDeviceController()

Destructor that shuts down the device if it's still in use

Overridden from UMIDIDeviceControllerBase

Name Description

Public function Virtual Const

FString

 

GetDeviceName()

The name of this device. This name comes from the MIDI hardware, any might not be unique

Public function Virtual Const

int32

 

GetMIDIBufferSize()

Size of the MIDI buffer in bytes

Public function Virtual

void

 

ProcessIncomingMIDIEvents()

Called every frame by UMIDIDeviceManager to poll for new MIDI events and broadcast them out to subscribers of OnMIDIEvent.

Public function Virtual

void

 

ShutdownDevice()

Called during destruction to clean up this device. Don't call this directly.

Public function Virtual

void

 

StartupDevice

(
    const int32 InitDeviceID,
    const int32 InitMIDIBufferSize,
    bool& bOutWasSuccessful
)

Called from UMIDIDeviceManager after the controller is created to get it ready to use.