UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ITimedDataInputChannel Class Referenceabstract

#include <ITimedDataInput.h>

Public Member Functions

virtual FText GetDisplayName () const =0
 
virtual ETimedDataInputState GetState () const =0
 
virtual FTimedDataChannelSampleTime GetOldestDataTime () const =0
 
virtual FTimedDataChannelSampleTime GetNewestDataTime () const =0
 
virtual TArray< FTimedDataChannelSampleTimeGetDataTimes () const =0
 
virtual int32 GetNumberOfSamples () const =0
 
virtual int32 GetDataBufferSize () const
 
virtual void SetDataBufferSize (int32 BufferSize)
 
virtual bool IsBufferStatsEnabled () const =0
 
virtual void SetBufferStatsEnabled (bool bEnable)=0
 
virtual int32 GetBufferUnderflowStat () const =0
 
virtual int32 GetBufferOverflowStat () const =0
 
virtual int32 GetFrameDroppedStat () const =0
 
virtual void GetLastEvaluationData (FTimedDataInputEvaluationData &OutEvaluationData) const =0
 
virtual void ResetBufferStats ()=0
 

Detailed Description

Interface for data tracked produced by an input.

Member Function Documentation

◆ GetBufferOverflowStat()

virtual int32 ITimedDataInputChannel::GetBufferOverflowStat ( ) const
pure virtual

Return buffer overflow count detected by this input

◆ GetBufferUnderflowStat()

virtual int32 ITimedDataInputChannel::GetBufferUnderflowStat ( ) const
pure virtual

Return buffer underflow count detected by this input

◆ GetDataBufferSize()

virtual int32 ITimedDataInputChannel::GetDataBufferSize ( ) const
inlinevirtual

If the channel does support it, get the current maximum sample count of channel.

◆ GetDataTimes()

virtual TArray< FTimedDataChannelSampleTime > ITimedDataInputChannel::GetDataTimes ( ) const
pure virtual

Get the time of all the data samples available.

◆ GetDisplayName()

virtual FText ITimedDataInputChannel::GetDisplayName ( ) const
pure virtual

Get the channel's display name.

◆ GetFrameDroppedStat()

virtual int32 ITimedDataInputChannel::GetFrameDroppedStat ( ) const
pure virtual

Return frame dropped count detected by this input

◆ GetLastEvaluationData()

virtual void ITimedDataInputChannel::GetLastEvaluationData ( FTimedDataInputEvaluationData OutEvaluationData) const
pure virtual

Get data about last evaluation. Samples used, expected, number of samples.

◆ GetNewestDataTime()

virtual FTimedDataChannelSampleTime ITimedDataInputChannel::GetNewestDataTime ( ) const
pure virtual

Get the time of the newest data sample available.

◆ GetNumberOfSamples()

virtual int32 ITimedDataInputChannel::GetNumberOfSamples ( ) const
pure virtual

Get the number of data samples available.

◆ GetOldestDataTime()

virtual FTimedDataChannelSampleTime ITimedDataInputChannel::GetOldestDataTime ( ) const
pure virtual

Get the time of the oldest data sample available.

◆ GetState()

virtual ETimedDataInputState ITimedDataInputChannel::GetState ( ) const
pure virtual

Get the current state of the channel.

◆ IsBufferStatsEnabled()

virtual bool ITimedDataInputChannel::IsBufferStatsEnabled ( ) const
pure virtual

Is tracking of stats enabled for this input

◆ ResetBufferStats()

virtual void ITimedDataInputChannel::ResetBufferStats ( )
pure virtual

Resets internal stat counters

◆ SetBufferStatsEnabled()

virtual void ITimedDataInputChannel::SetBufferStatsEnabled ( bool  bEnable)
pure virtual

Enables or disables stats tracking for this input

◆ SetDataBufferSize()

virtual void ITimedDataInputChannel::SetDataBufferSize ( int32  BufferSize)
inlinevirtual

If the channel does support it, set the maximum sample count of the channel.


The documentation for this class was generated from the following file: