Navigation
API > API/Plugins > API/Plugins/RemoteControlProtocolMIDI
MIDI protocol device identifier
| Name | FRemoteControlMIDIDevice |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControlProtocolMIDI/Source/RemoteControlProtocolMIDI/Public/RemoteControlProtocolMIDI.h |
| Include Path | #include "RemoteControlProtocolMIDI.h" |
Syntax
USTRUCT ()
struct FRemoteControlMIDIDevice
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor | RemoteControlProtocolMIDI.h | ||
FRemoteControlMIDIDevice
(
const int32 DeviceId |
Construct for the given DeviceId | RemoteControlProtocolMIDI.h | |
FRemoteControlMIDIDevice
(
const int32 DeviceId, |
Construct for the given DeviceId and DeviceName | RemoteControlProtocolMIDI.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDeviceIsAvailable | bool | If device available for use. | RemoteControlProtocolMIDI.h |
|
| DeviceId | int32 | User-specified Midi Device Id | RemoteControlProtocolMIDI.h |
|
| DeviceName | FName | Midi Device Name. If specified, takes priority over DeviceId. | RemoteControlProtocolMIDI.h |
|
| DeviceSelector | ERemoteControlMIDIDeviceSelector | Midi Device Selector | RemoteControlProtocolMIDI.h |
|
| ResolvedDeviceId | int32 | Midi Resolved Device Id. Distinct from the user specified Device Id. | RemoteControlProtocolMIDI.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 ResolveDeviceId
(
const TArray< FFoundMIDIDevice >& InFoundDevices |
Resolves the actual Midi Device Id given the FRemoteControlMIDIDevice configuration. | RemoteControlProtocolMIDI.h | |
void SetDevice
(
const int32 InDeviceId, |
Sets DeviceId and DeviceName, disables bUseProjectSettings and bUseUserDeviceId. | RemoteControlProtocolMIDI.h | |
void SetUseProjectSettings() |
Sets bUseProjectSettings = true, clears bUseUserDeviceId. | RemoteControlProtocolMIDI.h | |
void SetUserDeviceId() |
Sets bUseUserDeviceId = true, clears bUseProjectSettings. | RemoteControlProtocolMIDI.h | |
FText ToDisplayName() |
Creates a formatted string to display in the combobox | RemoteControlProtocolMIDI.h |