1. Epic GamesDeveloper
  3. UMediaSoundComponent

UMediaSoundComponent

Implements a sound component for playing a media player's audio output.

API > API/Runtime > API/Runtime/MediaAssets

Inheritance Hierarchy

References

   
Module MediaAssets
Header /Engine/Source/Runtime/MediaAssets/Public/MediaSoundComponent.h
Include #include "MediaSoundComponent.h"

Syntax

class UMediaSoundComponent : public USynthComponent

Remarks

Implements a sound component for playing a media player's audio output.

Variables

  Type Name Description
Public variable EMediaSoundChannels Channels Media sound channel type.
Public variable bool DynamicRateAdjustment Dynamically adjust the sample rate if audio and media clock desynchronize.
Protected variable TObjectPtr< UMediaPlayer > MediaPlayer The media player asset associated with this component.
Public variable float RateAdjustmentFactor Factor for calculating the sample rate adjustment.
Public variable FFloatRange RateAdjustmentRange The allowed range of dynamic rate adjustment.

Constructors

  Type Name Description
Public function  

UMediaSoundComponent ( const FObjectInitializer& ObjectInitializer
)

 Create and initialize a new instance.

Destructors

  Type Name Description
Public function   Virtual destructor.

Functions

  Type Name Description
Public function void Adds a clock sink so this can be ticked without the world.
Public function bool Get the attenuation settings based on the current component settings.
Public function Const void  
Public function Const float Retrieves the current amplitude envelope.
Public function Const UMediaPlayer * Get the media player that provides the audio samples.
Public function TArray< FMediaSoundComponentSpectralData > Retrieves and normalizes the spectral data if spectral analysis is enabled.
Protected function Const const FSoundAttenuationSettings * Get the attenuation settings based on the current component settings.
Public function TArray< FMediaSoundComponentSpectralData > Retrieves the spectral data if spectral analysis is enabled.
Public function void Removes the clock sink.
Public function void

SetDefaultMediaPlayer ( UMediaPlayer* NewMediaPlayer
)

 Set the component's default media player property.
Public function void

SetEnableEnvelopeFollowing ( bool bInEnvelopeFollowing
)

 Turns on amplitude envelope following the audio in the media sound component.
Public function void

SetEnableSpectralAnalysis ( bool bInSpectralAnalysisEnabled
)

 Turns on spectral analysis of the audio generated in the media sound component.
Public function void

SetEnvelopeFollowingsettings ( int32 AttackTimeMsec,
int32 ReleaseTimeMsec
)

 Sets the envelope attack and release times (in ms).
Public function void

SetMediaPlayer ( UMediaPlayer* NewMediaPlayer
)

 Set the media player that provides the audio samples.
Public function void

SetSpectralAnalysisSettings ( TArray< float > InFrequenciesToAnalyze,
EMediaSoundComponentFFTSize InFFTSize
)

 Sets the settings to use for spectral analysis.
Public function void  

Overridden from USynthComponent

  Type Name Description
Protected function Virtual ISoundGeneratorPtr Implemented by the synth component to create a generator object instead of generating audio directly on the synth component.
Public function Virtual USoundClass *  
Protected function Virtual bool

Init ( int32& SampleRate
)

 Called when synth is created.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

Activate ( bool bReset
)

 Activates the SceneComponent, should be overridden by native child classes.
Public function Virtual void Deactivates the SceneComponent.
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page