| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/MediaAssets/Public/MediaSoundComponent.h |
Include |
#include "MediaSoundComponent.h" |
class UMediaSoundComponent : public USynthComponent
Implements a sound component for playing a media player's audio output.
Name | Description | ||
---|---|---|---|
|
Channels |
Media sound channel type. |
|
|
DynamicRateAdjustment |
Dynamically adjust the sample rate if audio and media clock desynchronize. |
|
|
UMediaPlayer &#... |
MediaPlayer |
The media player asset associated with this component. |
|
float |
RateAdjustmentFactor |
Factor for calculating the sample rate adjustment. |
|
RateAdjustmentRange |
The allowed range of dynamic rate adjustment. |
Name | Description | |
---|---|---|
|
UMediaSoundComponent ( |
Create and initialize a new instance. |
Name | Description | |
---|---|---|
|
~UMediaSoundComponent() |
Virtual destructor. |
Name | Description | ||
---|---|---|---|
|
BP_GetAttenuationSettingsToApply ( |
Get the attenuation settings based on the current component settings. |
|
|
CollectAttenuationShapesForVisualization ( |
||
|
float |
GetEnvelopeValue() |
Retrieves the current amplitude envelope. |
|
UMediaPlayer... |
GetMediaPlayer() |
Get the media player that provides the audio samples. |
|
const FSound... |
GetSelectedAttenuationSettings() |
Get the attenuation settings based on the current component settings. |
|
GetSpectralData() |
Retrieves the spectral data if spectral analysis is enabled. |
|
|
SetDefaultMediaPlayer ( |
Set the component's default media player property. |
|
|
SetEnableEnvelopeFollowing ( |
Turns on amplitude envelope following the audio in the media sound component. |
|
|
SetEnableSpectralAnalysis ( |
Turns on spectral analysis of the audio generated in the media sound component. |
|
|
SetEnvelopeFollowingsettings |
Sets the envelope attack and release times (in ms). |
|
|
SetMediaPlayer ( |
Set the media player that provides the audio samples. |
|
|
SetSpectralAnalysisSettings ( |
Sets the settings to use for spectral analysis. |
|
|
UpdatePlayer() |
Name | Description | ||
---|---|---|---|
|
Activate ( |
Activates the SceneComponent, should be overridden by native child classes. |
|
|
Deactivate() |
Deactivates the SceneComponent. |
|
|
OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. |
|
|
OnUnregister() |
Called when a component is unregistered. |
|
|
TickComponent ( |
Function called every frame on this ActorComponent. |
Name | Description | ||
---|---|---|---|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
Name |
Description |
---|---|
DefaultMediaSoundClassObject |