Class UserDefinedCaptureProtocol

A blueprintable capture protocol that defines how to capture frames from the engine

Inheritance
System.Object
UObject
MovieSceneCaptureProtocolBase
MovieSceneImageCaptureProtocolBase
UserDefinedCaptureProtocol
UserDefinedImageCaptureProtocol
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.MovieSceneCapture
Assembly: UE4DotNet.dll
Syntax
public class UserDefinedCaptureProtocol : MovieSceneImageCaptureProtocolBase

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

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

StaticClass

Get UE4 Class

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

World

World pointer assigned on Setup

Declaration
public World World { get; }
Property Value
Type Description
World

Methods

| Improve this Doc View Source

BindToStream(Name, Byte)

Add a handler to the specified stream that will be called whenever it receives data.

Declaration
public void BindToStream(Name StreamName, byte Handler)
Parameters
Type Name Description
Name StreamName
System.Byte Handler
Remarks

Push data to a stream with either StartCapturingFinalPixels() or PushBufferToStream()

@param StreamName The name of the stream to bind this handler to. The handler will be invoked whenever pixels are received on that stream. @param Handler A delegate for handling the pixels received on this stream name

| Improve this Doc View Source

GenerateFilename(FrameMetrics)

Generate a filename for the current frame

Declaration
public string GenerateFilename(FrameMetrics InFrameMetrics)
Parameters
Type Name Description
FrameMetrics InFrameMetrics
Returns
Type Description
System.String
| Improve this Doc View Source

GetCurrentFrameMetrics()

Access this protocol's current frame metrics

Declaration
public FrameMetrics GetCurrentFrameMetrics()
Returns
Type Description
FrameMetrics
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

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

PushBufferToStream(Texture, Name)

  • Capture the specified texture buffer using this protocol's settings
  • @
Declaration
public void PushBufferToStream(Texture Buffer, Name StreamName)
Parameters
Type Name Description
Texture Buffer
Name StreamName
Remarks

param Buffer The desired buffer to save

  • @param StreamName The name of the stream to push the buffer onto (e.g. a composition pass name). Bind to the stream with BindStreamHandler.
| Improve this Doc View Source

ResolveBuffer(Texture, Name, Byte)

  • Resolve the specified buffer and pass it directly to the specified handler when done (does not pass to any bound streams)
  • @
Declaration
public void ResolveBuffer(Texture Buffer, Name BufferName, byte Handler)
Parameters
Type Name Description
Texture Buffer
Name BufferName
System.Byte Handler
Remarks

param Buffer The desired buffer to save

  • @param BufferName The name of this buffer that is passed to the resulting handler (e.g. a composition pass name).
  • @param Handler A delegate for handling the pixels received on this stream name
| Improve this Doc View Source

StartCapturingFinalPixels(Name)

Instruct this protocol to start capturing LDR final pixels (including slate widgets and burn-ins) @

Declaration
public void StartCapturingFinalPixels(Name StreamName)
Parameters
Type Name Description
Name StreamName
Remarks

param StreamName The name of the stream to send final pixels to. Bind to streams with BindStreamHandler.

| Improve this Doc View Source

StopCapturingFinalPixels()

Instruct this protocol to stop capturing LDR final pixels

Declaration
public void StopCapturingFinalPixels()

Events

| Improve this Doc View Source

OnBeginFinalize

Called when this protocol is going to be shut down - should not capture any more frames

Declaration
public event UserDefinedCaptureProtocol.OnBeginFinalize_delegate OnBeginFinalize
Event Type
Type Description
UserDefinedCaptureProtocol.OnBeginFinalize_delegate
| Improve this Doc View Source

OnCanFinalize

Called to check whether this protocol has finished any pending tasks, and can now be shut down

Declaration
public event UserDefinedCaptureProtocol.OnCanFinalize_delegate OnCanFinalize
Event Type
Type Description
UserDefinedCaptureProtocol.OnCanFinalize_delegate
| Improve this Doc View Source

OnCaptureFrame

Called when this protocol should capture the current frame

Declaration
public event UserDefinedCaptureProtocol.OnCaptureFrame_delegate OnCaptureFrame
Event Type
Type Description
UserDefinedCaptureProtocol.OnCaptureFrame_delegate
| Improve this Doc View Source

OnFinalize

Called to complete finalization of this protocol

Declaration
public event UserDefinedCaptureProtocol.OnFinalize_delegate OnFinalize
Event Type
Type Description
UserDefinedCaptureProtocol.OnFinalize_delegate
| Improve this Doc View Source

OnPauseCapture

Called when this protocol should temporarily stop capturing frames

Declaration
public event UserDefinedCaptureProtocol.OnPauseCapture_delegate OnPauseCapture
Event Type
Type Description
UserDefinedCaptureProtocol.OnPauseCapture_delegate
| Improve this Doc View Source

OnPreTick

Called before the capture process itself is ticked, before each frame is set up for capture

Declaration
public event UserDefinedCaptureProtocol.OnPreTick_delegate OnPreTick
Event Type
Type Description
UserDefinedCaptureProtocol.OnPreTick_delegate
Remarks

Useful for any pre-frame set up or resetting the previous frame's state

| Improve this Doc View Source

OnSetup

Called once at the start of the capture process, but before any warmup frames @

Declaration
public event UserDefinedCaptureProtocol.OnSetup_delegate OnSetup
Event Type
Type Description
UserDefinedCaptureProtocol.OnSetup_delegate
Remarks

return true if this protocol set up successfully, false otherwise

| Improve this Doc View Source

OnStartCapture

Called when this protocol should start capturing frames

Declaration
public event UserDefinedCaptureProtocol.OnStartCapture_delegate OnStartCapture
Event Type
Type Description
UserDefinedCaptureProtocol.OnStartCapture_delegate
| Improve this Doc View Source

OnTick

Called after the capture process itself is ticked, after the frame is set up for capture, but before most actors have ticked

Declaration
public event UserDefinedCaptureProtocol.OnTick_delegate OnTick
Event Type
Type Description
UserDefinedCaptureProtocol.OnTick_delegate
| Improve this Doc View Source

OnWarmUp

Called when the capture process is warming up. Protocols may transition from either an initialized, or capturing state to warm-up

Declaration
public event UserDefinedCaptureProtocol.OnWarmUp_delegate OnWarmUp
Event Type
Type Description
UserDefinedCaptureProtocol.OnWarmUp_delegate

Operators

| Improve this Doc View Source

Implicit(IntPtr to UserDefinedCaptureProtocol)

Convert from IntPtr to UObject

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