ITimedDataInput Class Reference

#include <ITimedDataInput.h>

Public Member Functions
virtual	~ITimedDataInput ()
virtual FText	GetDisplayName () const =0
virtual TArray< ITimedDataInputChannel * >	GetChannels () const =0
virtual ETimedDataInputEvaluationType	GetEvaluationType () const =0
virtual void	SetEvaluationType (ETimedDataInputEvaluationType Evaluation)=0
virtual double	GetEvaluationOffsetInSeconds () const =0
virtual void	SetEvaluationOffsetInSeconds (double Offset)=0
virtual FFrameRate	GetFrameRate () const =0
virtual bool	IsDataBufferSizeControlledByInput () const =0
virtual int32	GetDataBufferSize () const
virtual void	SetDataBufferSize (int32 BufferSize)
virtual void	AddChannel (ITimedDataInputChannel *Channel)=0
virtual void	RemoveChannel (ITimedDataInputChannel *Channel)=0
virtual bool	SupportsSubFrames () const
TIMEMANAGEMENT_API double	ConvertSecondOffsetInFrameOffset (double Seconds) const
TIMEMANAGEMENT_API double	ConvertFrameOffsetInSecondOffset (double Frames) const

Static Public Member Functions
static TIMEMANAGEMENT_API double	ConvertSecondOffsetInFrameOffset (double Seconds, FFrameRate Rate)
static TIMEMANAGEMENT_API double	ConvertFrameOffsetInSecondOffset (double Frames, FFrameRate Rate)

Static Public Attributes
static TIMEMANAGEMENT_API FFrameRate	UnknownFrameRate = FFrameRate(-1, -1)

Detailed Description

Interface for data sources that can be synchronized with time

Constructor & Destructor Documentation

~ITimedDataInput()

virtual ITimedDataInput::~ITimedDataInput ( )

inlinevirtual

Member Function Documentation

AddChannel()

virtual void ITimedDataInput::AddChannel ( ITimedDataInputChannel *  Channel )

pure virtual

Add a channel belonging to this input

ConvertFrameOffsetInSecondOffset() [1/2]

double ITimedDataInput::ConvertFrameOffsetInSecondOffset

(

double

Frames

)

const

Convert frame offset to second offset using this input's framerate.

ConvertFrameOffsetInSecondOffset() [2/2]

double ITimedDataInput::ConvertFrameOffsetInSecondOffset ( double  Frames, FFrameRate  Rate  )

static

ConvertSecondOffsetInFrameOffset() [1/2]

double ITimedDataInput::ConvertSecondOffsetInFrameOffset

(

double

Seconds

)

const

Convert second offset to frame offset using this input's framerate.

ConvertSecondOffsetInFrameOffset() [2/2]

double ITimedDataInput::ConvertSecondOffsetInFrameOffset ( double  Seconds, FFrameRate  Rate  )

static

GetChannels()

virtual TArray< ITimedDataInputChannel * > ITimedDataInput::GetChannels ( ) const

pure virtual

Get a list of the channel this input has.

GetDataBufferSize()

virtual int32 ITimedDataInput::GetDataBufferSize ( ) const

inlinevirtual

If the input does supported it, get the size of the buffer used by the input.

GetDisplayName()

virtual FText ITimedDataInput::GetDisplayName ( ) const

pure virtual

Get the name used when displayed.

GetEvaluationOffsetInSeconds()

virtual double ITimedDataInput::GetEvaluationOffsetInSeconds ( ) const

pure virtual

Get the offset in seconds used at evaluation.

GetEvaluationType()

virtual ETimedDataInputEvaluationType ITimedDataInput::GetEvaluationType ( ) const

pure virtual

Get how the input is evaluated.

GetFrameRate()

virtual FFrameRate ITimedDataInput::GetFrameRate ( ) const

pure virtual

Get the frame rate at which the samples are produced.

IsDataBufferSizeControlledByInput()

virtual bool ITimedDataInput::IsDataBufferSizeControlledByInput ( ) const

pure virtual

Does channel from this input support a different buffer size than it's input.

RemoveChannel()

virtual void ITimedDataInput::RemoveChannel ( ITimedDataInputChannel *  Channel )

pure virtual

Remove channel from the input

SetDataBufferSize()

virtual void ITimedDataInput::SetDataBufferSize ( int32  BufferSize )

inlinevirtual

If the input does supported it, set the size of the buffer used by the input.

SetEvaluationOffsetInSeconds()

virtual void ITimedDataInput::SetEvaluationOffsetInSeconds ( double  Offset )

pure virtual

Set the offset in seconds used at evaluation.

SetEvaluationType()

virtual void ITimedDataInput::SetEvaluationType ( ETimedDataInputEvaluationType  Evaluation )

pure virtual

Set how the input is evaluated.

SupportsSubFrames()

virtual bool ITimedDataInput::SupportsSubFrames ( ) const

inlinevirtual

Whether this input supports sub frames.

Member Data Documentation

UnknownFrameRate

FFrameRate ITimedDataInput::UnknownFrameRate = FFrameRate(-1, -1)

static

---

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

• Engine/Source/Runtime/TimeManagement/Public/ITimedDataInput.h
• Engine/Source/Runtime/TimeManagement/Private/ITimedDataInput.cpp