USoundSourceBus

A source bus is a type of [USoundBase](API\Runtime\Engine\Sound\USoundBase) and can be "played" like any sound.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SoundSourceBus.h

Include

#include "Sound/SoundSourceBus.h"

Syntax

class USoundSourceBus : public USoundWave

Remarks

A source bus is a type of USoundBase and can be "played" like any sound.

Variables

Name Description

Public variable

UAudioBus *

 

AudioBus

Audio bus to use to use as audio for this source bus.

Public variable

uint32: 1

 

bAutoDeactivateWhenSilent

Stop the source bus when the volume goes to zero.

Public variable

ESourceBusChann...

 

SourceBusChannels

How many channels to use for the source bus if the audio bus is not specified, otherwise it will use the audio bus object's channel count.

Public variable

float

 

SourceBusDuration

The duration (in seconds) to use for the source bus.

Constructors

Name Description

Public function

USoundSourceBus

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

Init()

Overridden from USoundBase

Name Description

Public function Virtual

float

 

GetDuration()

Returns the length of the sound

Public function Virtual Const

bool

 

IsPlayable()

Returns whether the sound base is set up in a playable manner

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss