Audio Player

All Settings[]

All default values have been Bolded.

All Options

Option	Value	Description
Audio	Accent 1, Select an Audio	Determines the audio to be played when the device is activated.
Volume	1.0, 0.0 - 4.0	Sets the volume for the selected audio. This is a Linear setting so 2 = twice as loud, 0.5 is half as loud as source audio volume.
Visible in Game	On, Off	Determines whether the device will be visible during the game.
Fade in Distance	Instant, 1 Second - 100 Seconds	The time is take for the audio to reach full volume in seconds when the audio is triggered to play. 0 = Immediately.
Fade Out Distance	Instant, 1 Second - 100 Seconds	The time is take for the audio to reach zero volume in seconds when the audio is triggered to stop. 0 = Immediately.
Enabled During Phase	None, Always, Pre-Game, Gameplay Only, Create Only	Determines the game phases during which the device will be enabled, Pre-Game includes all phases prior to the Game starting (the waiting for players lobby on Featured Islands and the Game Start Countdown). A disabled Audio Player will not respond to requests to Play, and any player audio will stop when it is disabled.
Restart Audio when Activated	On, Off	If set, will restart any playing audio when activated. If not set, activated will be ignored if the audio is already playing.
Play on Hit	On, Off	Determines whether the device will play audio when hit by a player.
Can be Heard By	Everyone, Instigator Only, Registered Players Only, Non-Registered Players	The range from Attenuation Min Distance to Attenuation Falloff Distance over which the sound will go from set volume to silent.
Play Location	Device, Local Player, Registered Players, Instigated Player	Determines if the audio should be played from the device location or the location of any registered players.
Playback Speed	1.0, 0.12 - 4.0	Raises or lowers the pitch of the audio by changing the playback speed. 1 = No change, 2 = twice as fast, 0.5 = half speed
Mesh (Creative)	Speaker, Loudspeaker	Determines the mesh that can be used to override the default Audio Player mesh.
Mesh (UEFN)	None, Select a Static Mesh	Determines the mesh that can be used to override the default Audio Player mesh.
Enable Spatialization	On, Off	Enable audio panning based on the position relative to the listener (which is the camera by default).
Stereo Spread	0.0 - 5000.0	A scale at where the stelf greater than 0, we effectively create two speakers, a left and right speaker to play this sound from. This value is the distance between those speakers. The play location is half way between those speakers.reo spread, where 0 is the Attenuation Min Distance.
Enable Volume Attenuation	On, Off	Enable volume changes based on proximity to the listener (which is the camera by default).
Attenuation Function	Linear, Logarithmic	Defines how volume should change between the Attenuation Min Distance to Attenuation Falloff Distance.
Attenuation Min Distance	4M, 0M - 5000M	The range around the device in which the audio will remain at the value set in the Volume user option setting.
Attenuation Falloff Distance	32M, 0M - 5000M	The range from Attenuation Min Distance to Attenuation Falloff Distance over which the sound will go from set volume to silent.
Enable Attenuation Visuals	On, Off	If set, show the attenuation visuals.
Sync Player Audio	On, Off	Enables the audio to be synchronized across all devices. Recommended for longer sounds such as music and dialogue.
Auto Play - Create	On, Off	Will play automatically while Creating.
Auto Play - Waiting For Players	On, Off	Will play automatically during the pregame lobby.
Auto Play - Countdown	On, Off	Will play automatically during the Game Countdown
Auto Play - Gameplay	On, Off	Will play automatically while the game is in progress.
Auto Play - Round End	On, Off	Will play automatically at the end of each round.
Auto Play - Game End	On, Off	Will play automatically at the end of each game.

Functions and Events[]

Functions

Option	Description
Play When Receiving From	Plays the selected audio
Stop When Receiving From	Stop the selected audio.
Enable When Receiving From	Enables the device, allowing it to play audio when activated.
Disable When Receiving From	Disables the device, preventing it from being activated. (i.e. playing audio).
Register Player When Receiving From	Registers a player as a target for the speaker to play audio from when activated.
Unregister Player When Receiving From	Unregisters a player as a target for the speaker to play audio from when activated.
Unregister All Players When Receiving From	Removes all registered players as a target for the speaker to play audio from when activated.

No settings to display

audio_player_device class[]

using { /Fortnite.com/Devices }

Inheritance Hierarchy

Option	Description
creative_object	Base class for creative devices and props.
creative_device_base	Base class for creative_device.

This class has no data members.

Functions

Option	Parameters	Description
Enable		Enables this device. Allows this device to be triggered from other linked devices (i.e. triggers) and allow calls to Play to succeed.
Disable		Disables this device. No longer allows this device to be triggered from other linked devices (i.e. triggers) and will stop any currently playing audio.
Play	Agent:agent	Starts playing audio from this device for Agent. This can only be used when the device is set to be Heard by Instigator.
Play		Starts playing audio from this device.
Stop	Agent:agent	Stops any audio playing from this device for Agent. This can only be used when the device is set to be Heard by Instigator.
Stop		Stops any audio playing from this device.
Register	Agent:agent	Adds Agent as a target to play audio from when activated.
Unregister	Agent:agent	Removes Agent as a target to play audio from when activated.
UnregisterAll		Removes all previously registered agent's as valid targets to play audio from when activated.
Show		Shows this device in the world.
Hide		Hides this device from the world.