Instrument Player

The Instrument Player (I-PLAY) device provides a wide sound palette, incorporating acoustic instruments and other sounds that would be hard to simulate with a synthesizer.

Like the Drum Player, the Instrument Player is an audio generator that converts note data input into audio data using a bank of samples. It allows you to make big, quick changes to sound output by switching from one instrument to another.

Device Controls

Device Options

In Create mode, walk up to the device and press E to open the Customize panel. Some device options mirror the controls you can manipulate with the Patchwork tool. They are present so that you can use the event binding system to trigger changes to how those controls behave, although you can choose to change them here instead of using the knobs. The Allow Cable Access option can only be modified using the Customize panel.

VFX Preview

The VFX preview for the Instrument Player gives you a sense of the audio emitting from the device. Visuals change based on the selected sample.

Import and Play Custom Samples with UEFN

Using UEFN, you can import custom audio samples and create a Fusion patch to use as a custom instrument for this device!

This opens up a world of possibilities:

• Make your own instruments: you can map samples across a range of notes to create a full musical scale from a limited set of sounds. In this example video, audio files for six bass guitar notes were used to create a custom instrument that can play a full musical scale.

• Upload longer samples, like vocal clips or even full songs, starting the sample when a specific note is played. This allows the Instrument Player to function like an audio bank, triggering sounds when you play a certain note. In this video example, an audio file of a synthesizer melody is mapped to a single note, allowing for a longer imported recording to be synced to Patchwork audio.

Loading Samples

To load your own samples into the Instrument Player device:

1. Open Unreal Editor for Fortnite and select your project.

2. Inside your UEFN project, create an Audio folder in the Content Library.

   

3. Select your audio samples and drag them into the Audio folder, or right-click and select Import to, then choose your audio samples. They will appear as Sound Wave assets. Sound Wave assets can be created from .wav, .aif, .flac, and .ogg files.

   

4. Select all the Sound Wave assets, right-click on one of them and select Edit.

5. Change the Sound Asset Compression Type to PCM.

   

6. Select all the assets again, right-click on one of them and select Create Fusion Patch.

   

7. Configure the Fusion Patch settings for your custom instrument and click OK.

   

8. Select an Instrument Player device.

9. In the Details panel under Advanced, check the box for Custom Instrument, then assign the Fusion Patch you created.

   

When an Instrument Player uses a custom instrument, the Instrument Select carousel does not display.

Multiple Sound Wave Assets

You can add multiple Sound Wave assets to your Fusion Patch:

• When making a custom instrument, give each asset a Root Note as well as a Min/Max note range. If you do this, the Instrument Player will play your sound for all notes in the range, adjusting its pitch relative to the Root Note if needed.

• If you want to play a sound only at its original pitch, set its Min, Root, and Max Note to the same value.

Pro Tips

• When using the Instrument Player to trigger samples with single notes, make sure any Note Sequencers providing input have their Chromatic user option set to On. This will ensure that the Note Sequencer outputs all possible notes you might use to trigger your samples.

• Extend the sustain length of the note on the Note Sequencer so it plays for the full length of the sample. If needed, you can also extend the Length of the Note Sequencer grid or slow down its Step Rate for even longer sample durations.

• To make sure the Instrument Player's vibrato control works for a custom Fusion Patch, edit the LFO: 1 settings on the Fusion Patch. Set Target to Pitch and Is Enabled to True. If these are not set, the Vibrato control will have no effect.

Direct Event Binding

Following are the direct event binding options for this device.

Functions

A function listens for an event on a device then performs an action.

1. For any function, click the option, then Select Device to access and select from the Device dropdown menu.

2. Once you've selected a device, click Select Event and select the event that triggers this function.

3. If more than one device or event triggers a function, press the Add button to add a line and repeat these steps.

Events

Direct event binding uses events as transmitters. An event tells another device to perform a function.

1. For any event option, click the option, then Select Device to access and select from the Device dropdown menu.

2. Once you've selected a device, click Select Function to bind the event to a function for that device.

3. If more than one function is triggered by the event, press the Add button and repeat.

Using Instrument Player in Verse

You can use the code below to control a Instrument Player device in Verse. This code uses all features of the Instrument Player device API. Modify it to fit the needs of your experience.

using { /Fortnite.com/Devices }

using { /Verse.org/Simulation }

using { /UnrealEngine.com/Temporary/Diagnostics }

# A Verse-authored creative device that can be placed in a level

instrument_player_example := class(creative_device):

    @editable

    InstrumentPlayer:patchwork_instrument_player_device = patchwork_instrument_player_device{}

    # Runs when the device is started in a running game

    OnBegin<override>()<suspends>:void=

        

        Sleep(5.0)

        InstrumentPlayer.Disable()

        Print("Device Disabled")

        Sleep(5.0)

        InstrumentPlayer.Enable()

        Print("Device Enabled")

Copy full snippet

using { /Fortnite.com/Devices } using { /Verse.org/Simulation } using { /UnrealEngine.com/Temporary/Diagnostics } # A Verse-authored creative device that can be placed in a level instrument_player_example := class(creative_device): @editable InstrumentPlayer:patchwork_instrument_player_device = patchwork_instrument_player_device{} # Runs when the device is started in a running game OnBegin<override>()<suspends>:void= Sleep(5.0) InstrumentPlayer.Disable() Print("Device Disabled") Sleep(5.0) InstrumentPlayer.Enable() Print("Device Enabled")

To use this code in your UEFN experience, follow these steps.

1. Drag a Instrument Player device onto your island.

2. Create a new Verse device named instrument_player_example. To learn how to create a new device in Verse, see Create Your Own Device Using Verse.

3. Open Verse Explorer and double-click instrument_player_example.verse to open the script in Visual Studio Code.

4. Paste in the code above, compile, and drag the Verse-authored device onto your island.

5. Select your Verse device in the Outliner.

6. In the device's Details panel, assign the object reference for the InstrumentPlayer to the instrument player device on your island. You can use the eyedropper to pick the device in the viewport, or use the dropdown and search for the device.

7. Save your project and click Launch Session.

Instrument Player API

See the instrument_player_device API Reference for more information on using the instrument player device in Verse.

Patch Ideas

Try patching the Instrument Player into the Echo Effect or the Distortion Effect to add texture to your sound.

Patch the Instrument player into the Speaker to hear the result of the Patchwork chain.