Class TimecodeProvider

A class responsible of fetching a timecode from a source.

Inheritance
System.Object
UObject
TimecodeProvider
SystemTimeTimecodeProvider
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.Engine
Assembly: UE4DotNet.dll
Syntax
public class TimecodeProvider : UObject
Remarks

Note, FApp::GetTimecode and FApp::GetTimecodeFramerate should be used to retrieve the current system Timecode and Framerate.

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static TimecodeProvider DefaultObject { get; }
Property Value
Type Description
TimecodeProvider
| 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

GetFrameRate()

Return the frame rate.

Declaration
public FrameRate GetFrameRate()
Returns
Type Description
FrameRate
Remarks

Depending on the implementation, it may or may not be valid only when GetSynchronizationState() is Synchronized.

| Improve this Doc View Source

GetSynchronizationState()

The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate are valid.

Declaration
public ETimecodeProviderSynchronizationState GetSynchronizationState()
Returns
Type Description
ETimecodeProviderSynchronizationState
| Improve this Doc View Source

GetTimecode()

Return the Timecode at that moment.

Declaration
public Timecode GetTimecode()
Returns
Type Description
Timecode
Remarks

It may not be in sync with the current frame. Only valid when GetSynchronizationState() is Synchronized.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static TimecodeProvider New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
TimecodeProvider

Operators

| Improve this Doc View Source

Implicit(IntPtr to TimecodeProvider)

Convert from IntPtr to UObject

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