Class MediaSoundComponent

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

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
SynthComponent
MediaSoundComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.MediaAssets
Assembly: UE4DotNet.dll
Syntax
public class MediaSoundComponent : SynthComponent

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static MediaSoundComponent DefaultObject { get; }
Property Value
Type Description
MediaSoundComponent
| Improve this Doc View Source

DynamicRateAdjustment

Declaration
public bool DynamicRateAdjustment { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MediaPlayer

The media player asset associated with this component.

Declaration
public MediaPlayer MediaPlayer { get; set; }
Property Value
Type Description
MediaPlayer
Remarks

This property is meant for design-time convenience. To change the associated media player at run-time, use the SetMediaPlayer method.

@see SetMediaPlayer

| Improve this Doc View Source

RateAdjustmentFactor

Factor for calculating the sample rate adjustment.

Declaration
public float RateAdjustmentFactor { get; set; }
Property Value
Type Description
System.Single
Remarks

If dynamic rate adjustment is enabled, this number is multiplied with the drift between the audio and media clock (in 100ns ticks) to determine the adjustment. that is to be multiplied into the current playrate.

| Improve this Doc View Source

RateAdjustmentRange

The allowed range of dynamic rate adjustment.

Declaration
public FloatRange RateAdjustmentRange { get; set; }
Property Value
Type Description
FloatRange
Remarks

If dynamic rate adjustment is enabled, and the necessary adjustment falls outside of this range, audio samples will be dropped.

| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

BP_GetAttenuationSettingsToApply()

Get the attenuation settings based on the current component settings.

Declaration
public (SoundAttenuationSettings, bool) BP_GetAttenuationSettingsToApply()
Returns
Type Description
System.ValueTuple<SoundAttenuationSettings, System.Boolean>
Remarks

@param OutAttenuationSettings Will contain the attenuation settings, if available. @return true if attenuation settings were returned, false if attenuation is disabled.

| Improve this Doc View Source

GetMediaPlayer()

Get the media player that provides the audio samples.

Declaration
public MediaPlayer GetMediaPlayer()
Returns
Type Description
MediaPlayer
Remarks

@return The component's media player, or nullptr if not set. @see SetMediaPlayer

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static MediaSoundComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
MediaSoundComponent
| Improve this Doc View Source

SetMediaPlayer(MediaPlayer)

Set the media player that provides the audio samples.

Declaration
public void SetMediaPlayer(MediaPlayer NewMediaPlayer)
Parameters
Type Name Description
MediaPlayer NewMediaPlayer
Remarks

@param NewMediaPlayer The player to set. @see GetMediaPlayer

Operators

| Improve this Doc View Source

Implicit(IntPtr to MediaSoundComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator MediaSoundComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
MediaSoundComponent