Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- USoundBase
- USoundWave
- USoundSourceBus
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
| Type | Name | Description | |
|---|---|---|---|
 |
TObjectPtr< UAudioBus > | AudioBus | Audio bus to use as audio for this source bus. |
 |
uint32: 1 | bAutoDeactivateWhenSilent | Stop the source bus when the volume goes to zero. |
 |
ESourceBusChannels | 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. |
 |
float | SourceBusDuration | The duration (in seconds) to use for the source bus. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
USoundSourceBus
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Init () |
Overridden from USoundWave
| Type | Name | Description | |
|---|---|---|---|
  |
void | Begins caching platform data in the background. | |
  |
void | CachePlatformData
(
bool bAsyncCache |
Caches platform data for the sound. |
   |
bool | ||
  |
void | Blocks on async cache tasks and prepares platform data for use. | |
  |
void | SerializeCookedPlatformData
(
FArchive& Ar |
Serializes cooked platform data. |
Overridden from USoundBase
| Type | Name | Description | |
|---|---|---|---|
   |
float | GetDuration () |
Returns the length of the sound |
   |
bool | IsPlayable () |
Returns whether the sound base is set up in a playable manner |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginCacheForCookedPlatformData
(
const ITargetPlatform* TargetPlatform |
Override the SoundWave behavior so that we don't ask DDC for compressed data. |
  |
void | ClearCachedCookedPlatformData
(
const ITargetPlatform* TargetPlatform |
Clears cached cooked platform data for specific platform |
  |
bool | IsCachedCookedPlatformDataLoaded
(
const ITargetPlatform* TargetPlatform |
Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |