1. Epic GamesDeveloper
  3. FAudioVirtualLoop

FAudioVirtualLoop

Copyright Epic Games, Inc. All Rights Reserved.

API > API/Runtime > API/Runtime/Engine

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

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Overrides the update interval to the provided length
Public function FActiveSound & Returns the internally-managed active sound
Public function Const const FActiveSound &  
Public function Const float Returns the time the sound has been virtualized
Public function Const float Returns the wait interval being observed before next update
Public function Static bool 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page