FAudioVirtualLoop

Copyright Epic Games, Inc. All Rights Reserved.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/AudioVirtualLoop.h

Include

#include "AudioVirtualLoop.h"

Syntax

struct FAudioVirtualLoop

Remarks

Class that tracks virtualized looping active sounds that are eligible to revive re-trigger as long as no stop request is received from the game thread.

Constructors

Name Description

Public function

FAudioVirtualLoop()

Functions

Name Description

Public function

void

 

CalculateUpdateInterval()

Overrides the update interval to the provided length

Public function

FActiveSound ...

 

GetActiveSound()

Returns the internally-managed active sound

Public function Const

const FActiv ...

 

GetActiveSound()

Public function Const

float

 

GetTimeVirtualized()

Returns the time the sound has been virtualized

Public function Const

float

 

GetUpdateInterval()

Returns the wait interval being observed before next update

Public function Static

bool

 

IsEnabled()

Whether the virtual loop system is enabled or not

Public function Static

bool

 

ShouldListenerMoveForceUpdate

(
    const FTransform & LastTransform,
    const FTransform & CurrentTransform
)

Check to see if listener move is far enough such that a check for virtual loop realization is necessary

Public function

bool

 

Update

(
    float DeltaTime,
    bool bForceUpdate
)

Updates the loop and checks if ready to play (or 'realize').

Public function

void

 

UpdateFocusData

(
    float DeltaTime
)

Takes aggregate update delta and updates focus so that realization check can test if ready to play.

Public function Static

bool

 

Virtualize

(
    const FActiveSound & InActiveSound,
    bool bDoRangeCheck,
    FAudioVirtualLoop & OutVirtualLoop
)

Checks if provided active sound is available to be virtualized.

Public function Static

bool

 

Virtualize

(
    const FActiveSound & InActiveSound,
    FAudioDevice & AudioDevice,
    bool bDoRangeCheck,
    FAudioVirtualLoop & OutVirtualLoop
)

Checks if provided active sound is available to be virtualized.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback