Files
UnrealEngineUWP/Engine/Source/Developer/CrashTracker/Public/Interfaces/ICrashTrackerModule.h
Max Preussner 3aece47882 Docs: Removed file comments and added missing code documentation
Please note that file comments had no purpose in nearly all cases and just added visual clutter. The two files that had meaningful file comments had their comments moved into the corresponding classes. There are still hundreds of file comments left in other files that will be removed over time.

Also cleaned up some random stuff along the way:
- relative paths to public headers within the same module are no longer necessary (automatically discovered by UBT now)
- header guards are deprecated, use #pragma once instead (all compilers support it now)
- space between multiple template brackets is no longer required (all compilers support >> now)
- NULL to nullptr, OVERRIDE to override
- spelling errors, whitespace, line breaks

[CL 2104067 by Max Preussner in Main branch]
2014-06-12 23:22:18 -04:00

81 lines
1.8 KiB
C++

// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
#pragma once
namespace EWriteUserCaptureVideoError
{
/**
* Enumerates video capture write error codes.
*/
enum Type
{
None,
/** The video capture instance was invalid. */
VideoCaptureInvalid,
/** Video capture is not running. */
CaptureNotRunning,
/** Failed to create destination directory for the video. */
FailedToCreateDirectory,
};
}
/**
* Interface for crash tracker modules.
*/
class ICrashTrackerModule
: public IModuleInterface
{
public:
/**
* Forces the crash tracker to complete capturing as if the program had crashed.
*/
virtual void ForceCompleteCapture() = 0;
/**
* Invalidates the current crash tracker frame being generated.
*/
virtual void InvalidateCrashTrackerFrame() = 0;
/**
* Checks if the crash tracker is currently enabled.
*/
virtual bool IsCurrentlyCapturing() const = 0;
/**
* Checks if the crash tracker is available.
*/
virtual bool IsVideoCaptureAvailable() const = 0;
/**
* Enables or disables crash tracking while in flight.
*/
virtual void SetCrashTrackingEnabled(bool bEnabled) = 0;
/**
* Updates the crash tracker, which may trigger the capture of a frame.
* Will also begin capturing if it hasn't begun already.
*/
virtual void Update(float DeltaSeconds) = 0;
/**
* Write the current crash tracker as a user video.
*
* @param OutFinalSaveName The path and name of the file the video was saved as.
* @return If the video was successfully written will return EWriteUserCaptureVideoError::None, otherwise returns an error code.
*/
virtual EWriteUserCaptureVideoError::Type WriteUserVideoNow( FString& OutFinalSaveName ) = 0;
public:
/**
* Virtual destructor.
*/
virtual ~ICrashTrackerModule( ) { }
};