Direct Camera for Unreal
Direct Camera Unreal docs
Loading...
Searching...
No Matches
UCameraCaptureSettingsLibrary Class Reference

#include <CameraCaptureSettingsLibrary.h>

Public Member Functions

 DIRECTCAMERA_ALL_SETTINGS (DECLARE_GETTER_SETTER)

Static Public Member Functions

static bool OpenDirectCamera (UMediaPlayer *MediaPlayer, int ResolutionX, int ResolutionY, float Fps, UDirectCameraCameraTypeEnum CameraType, int CameraIndex)
static void DirectCameraGetResolution (UMediaPlayer *MediaPlayer, int32 &OutWidth, int32 &OutHeight, float &OutFps)
 Get the current camera resolution (width and height) and fps from the DirectCameraMediaPlayer.
static UDirectCameraCaptureSettingsGetCameraCaptureSettingsFromMediaPlayer (UMediaPlayer *MediaPlayer)
 Get camera capture settings from a DirectCameraMediaPlayer.
static bool FillCameraCaptureSettingsFromMediaPlayer (UMediaPlayer *MediaPlayer, UDirectCameraCaptureSettings *OutSettings)
static bool SetCameraCaptureSettingsOnMediaPlayer (UMediaPlayer *MediaPlayer, UDirectCameraCaptureSettings *Settings)
 Set camera capture settings on a DirectCameraMediaPlayer.
static FString Conv_UDirectCameraCaptureSettingsToString (UDirectCameraCaptureSettings *Settings)
 get camera capture settings as a string for logging
static float ConvertDioptersToMeters (float Diopters)
 Convert focus distance from diopters to meters.
static float ConvertMetersToDiopters (float Meters)
 Convert focus distance from meters to diopters.
*static DirectCameraWhiteBalanceMode GetWhiteBalance_Mode (UMediaPlayer *MediaPlayer)
 Get white balance mode.
static void SetWhiteBalance_Mode (UMediaPlayer *MediaPlayer, DirectCameraWhiteBalanceMode Value)
 Set white balance mode.
static DirectCameraFocusMode GetFocus_Mode (UMediaPlayer *MediaPlayer)
 Get focus mode.
static void SetFocus_Mode (UMediaPlayer *MediaPlayer, DirectCameraFocusMode Value)
 Set focus mode.
static DirectCameraExposureMode GetExposure_Mode (UMediaPlayer *MediaPlayer)
 Get exposure mode.
static void SetExposure_Mode (UMediaPlayer *MediaPlayer, DirectCameraExposureMode Value)
 Set exposure mode.
static DirectCameraFlashMode GetFlash_Mode (UMediaPlayer *MediaPlayer)
 Get flash mode.
static void SetFlash_Mode (UMediaPlayer *MediaPlayer, DirectCameraFlashMode Value)
 Set flash mode.
static DirectCameraAEMode GetAE_Mode (UMediaPlayer *MediaPlayer)
 Get auto exposure mode.
static void SetAE_Mode (UMediaPlayer *MediaPlayer, DirectCameraAEMode Value)
 Set auto exposure mode.
static DirectCameraAFMode GetAF_Mode (UMediaPlayer *MediaPlayer)
 Get auto focus mode.
static void SetAF_Mode (UMediaPlayer *MediaPlayer, DirectCameraAFMode Value)
 Set auto focus mode.
static DirectCameraStabilizationMode GetStabilization_Mode (UMediaPlayer *MediaPlayer)
 Get stabilization mode.
static void SetStabilization_Mode (UMediaPlayer *MediaPlayer, DirectCameraStabilizationMode Value)
 Set stabilization mode.
static float GetZoom (UMediaPlayer *MediaPlayer)
 Get zoom level.
static void SetZoom (UMediaPlayer *MediaPlayer, float Value)
 Set zoom level.
static FVector2D GetAE_Center (UMediaPlayer *MediaPlayer)
 Get auto exposure region center.
static void SetAE_Center (UMediaPlayer *MediaPlayer, FVector2D Value)
 Set auto exposure region center.
static FVector2D GetAF_Center (UMediaPlayer *MediaPlayer)
 Get auto focus region center.
static void SetAF_Center (UMediaPlayer *MediaPlayer, FVector2D Value)
 Set auto focus region center.
static bool GetAE_Lock (UMediaPlayer *MediaPlayer)
 Get auto exposure lock.
static void SetAE_Lock (UMediaPlayer *MediaPlayer, bool Value)
 Set auto exposure lock.
static bool GetAF_Lock (UMediaPlayer *MediaPlayer)
 Get auto focus lock.
static void SetAF_Lock (UMediaPlayer *MediaPlayer, bool Value)
 Set auto focus lock.
static bool GetWhiteBalance_Lock (UMediaPlayer *MediaPlayer)
 Get white balance lock.
static void SetWhiteBalance_Lock (UMediaPlayer *MediaPlayer, bool Value)
 Set white balance lock.
static int32 GetISO (UMediaPlayer *MediaPlayer)
 Get ISO value.
static void SetISO (UMediaPlayer *MediaPlayer, int32 Value)
 Set ISO value.
static float GetFixedExposureTime (UMediaPlayer *MediaPlayer)
 Get fixed exposure time (in seconds)
static void SetFixedExposureTime (UMediaPlayer *MediaPlayer, float Value)
 Set fixed exposure time (in seconds)
static float GetFixedFocusDistance (UMediaPlayer *MediaPlayer)
 Get Fixed Focus Distance (in diopters - use ConvertDioptersToMeters to convert to meters)
static void SetFixedFocusDistance (UMediaPlayer *MediaPlayer, float Value)
 Set Fixed Focus Distance (in diopters - use ConvertMetersToDiopters to convert from meters)
static float GetReadOnly_MinFocusDistance (UMediaPlayer *MediaPlayer)
 Get Read Only Minimum Focus Distance.
static void SetReadOnly_MinFocusDistance (UMediaPlayer *MediaPlayer, float Value)
 Set Read Only Minimum Focus Distance.
static float GetReadOnly_MinExposureTime (UMediaPlayer *MediaPlayer)
 Get Read Only Minimum Exposure Time.
static void SetReadOnly_MinExposureTime (UMediaPlayer *MediaPlayer, float Value)
 Set Read Only Minimum Exposure Time.
static float GetReadOnly_MaxExposureTime (UMediaPlayer *MediaPlayer)
 Get Read Only Maximum Exposure Time.
static void SetReadOnly_MaxExposureTime (UMediaPlayer *MediaPlayer, float Value)
 Set Read Only Maximum Exposure Time.

Public Attributes

__Type__ Get void Set MediaPlayer
__Type__ Get void Set __Type__ Value

Detailed Description

Blueprint Function Library for DirectCamera Capture Settings Provides easy access to camera settings functionality from Blueprints

Call these functions on a MediaPlayer that has a camera open. They will not do anything if the MediaPlayer is closed or has something else open.

Member Function Documentation

◆ Conv_UDirectCameraCaptureSettingsToString()

FString UCameraCaptureSettingsLibrary::Conv_UDirectCameraCaptureSettingsToString ( UDirectCameraCaptureSettings * Settings)
static

get camera capture settings as a string for logging

◆ ConvertDioptersToMeters()

float UCameraCaptureSettingsLibrary::ConvertDioptersToMeters ( float Diopters)
inlinestatic

Convert focus distance from diopters to meters.

1 diopter = 1 meter^-1, so meters = 1 / diopters

◆ ConvertMetersToDiopters()

float UCameraCaptureSettingsLibrary::ConvertMetersToDiopters ( float Meters)
inlinestatic

Convert focus distance from meters to diopters.

1 diopter = 1 meter^-1, so diopters = 1 / meters

0 meters = error, return 0 diopters

◆ DIRECTCAMERA_ALL_SETTINGS()

UCameraCaptureSettingsLibrary::DIRECTCAMERA_ALL_SETTINGS ( DECLARE_GETTER_SETTER )

◆ DirectCameraGetResolution()

void UCameraCaptureSettingsLibrary::DirectCameraGetResolution ( UMediaPlayer * MediaPlayer,
int32 & OutWidth,
int32 & OutHeight,
float & OutFps )
static

Get the current camera resolution (width and height) and fps from the DirectCameraMediaPlayer.

◆ FillCameraCaptureSettingsFromMediaPlayer()

bool UCameraCaptureSettingsLibrary::FillCameraCaptureSettingsFromMediaPlayer ( UMediaPlayer * MediaPlayer,
UDirectCameraCaptureSettings * OutSettings )
static

◆ GetAE_Center()

FVector2D UCameraCaptureSettingsLibrary::GetAE_Center ( UMediaPlayer * MediaPlayer)
static

Get auto exposure region center.

◆ GetAE_Lock()

bool UCameraCaptureSettingsLibrary::GetAE_Lock ( UMediaPlayer * MediaPlayer)
static

Get auto exposure lock.

◆ GetAE_Mode()

DirectCameraAEMode UCameraCaptureSettingsLibrary::GetAE_Mode ( UMediaPlayer * MediaPlayer)
static

Get auto exposure mode.

◆ GetAF_Center()

FVector2D UCameraCaptureSettingsLibrary::GetAF_Center ( UMediaPlayer * MediaPlayer)
static

Get auto focus region center.

◆ GetAF_Lock()

bool UCameraCaptureSettingsLibrary::GetAF_Lock ( UMediaPlayer * MediaPlayer)
static

Get auto focus lock.

◆ GetAF_Mode()

DirectCameraAFMode UCameraCaptureSettingsLibrary::GetAF_Mode ( UMediaPlayer * MediaPlayer)
static

Get auto focus mode.

◆ GetCameraCaptureSettingsFromMediaPlayer()

UDirectCameraCaptureSettings * UCameraCaptureSettingsLibrary::GetCameraCaptureSettingsFromMediaPlayer ( UMediaPlayer * MediaPlayer)
static

Get camera capture settings from a DirectCameraMediaPlayer.

◆ GetExposure_Mode()

DirectCameraExposureMode UCameraCaptureSettingsLibrary::GetExposure_Mode ( UMediaPlayer * MediaPlayer)
static

Get exposure mode.

◆ GetFixedExposureTime()

float UCameraCaptureSettingsLibrary::GetFixedExposureTime ( UMediaPlayer * MediaPlayer)
static

Get fixed exposure time (in seconds)

◆ GetFixedFocusDistance()

float UCameraCaptureSettingsLibrary::GetFixedFocusDistance ( UMediaPlayer * MediaPlayer)
static

Get Fixed Focus Distance (in diopters - use ConvertDioptersToMeters to convert to meters)

◆ GetFlash_Mode()

DirectCameraFlashMode UCameraCaptureSettingsLibrary::GetFlash_Mode ( UMediaPlayer * MediaPlayer)
static

Get flash mode.

◆ GetFocus_Mode()

DirectCameraFocusMode UCameraCaptureSettingsLibrary::GetFocus_Mode ( UMediaPlayer * MediaPlayer)
static

Get focus mode.

◆ GetISO()

int32 UCameraCaptureSettingsLibrary::GetISO ( UMediaPlayer * MediaPlayer)
static

Get ISO value.

◆ GetReadOnly_MaxExposureTime()

float UCameraCaptureSettingsLibrary::GetReadOnly_MaxExposureTime ( UMediaPlayer * MediaPlayer)
static

Get Read Only Maximum Exposure Time.

◆ GetReadOnly_MinExposureTime()

float UCameraCaptureSettingsLibrary::GetReadOnly_MinExposureTime ( UMediaPlayer * MediaPlayer)
static

Get Read Only Minimum Exposure Time.

◆ GetReadOnly_MinFocusDistance()

float UCameraCaptureSettingsLibrary::GetReadOnly_MinFocusDistance ( UMediaPlayer * MediaPlayer)
static

Get Read Only Minimum Focus Distance.

◆ GetStabilization_Mode()

DirectCameraStabilizationMode UCameraCaptureSettingsLibrary::GetStabilization_Mode ( UMediaPlayer * MediaPlayer)
static

Get stabilization mode.

◆ GetWhiteBalance_Lock()

bool UCameraCaptureSettingsLibrary::GetWhiteBalance_Lock ( UMediaPlayer * MediaPlayer)
static

Get white balance lock.

◆ GetWhiteBalance_Mode()

*static DirectCameraWhiteBalanceMode UCameraCaptureSettingsLibrary::GetWhiteBalance_Mode ( UMediaPlayer * MediaPlayer)
static

Get white balance mode.

◆ GetZoom()

float UCameraCaptureSettingsLibrary::GetZoom ( UMediaPlayer * MediaPlayer)
static

Get zoom level.

◆ OpenDirectCamera()

bool UCameraCaptureSettingsLibrary::OpenDirectCamera ( UMediaPlayer * MediaPlayer,
int ResolutionX,
int ResolutionY,
float Fps,
UDirectCameraCameraTypeEnum CameraType,
int CameraIndex )
static

◆ SetAE_Center()

void UCameraCaptureSettingsLibrary::SetAE_Center ( UMediaPlayer * MediaPlayer,
FVector2D Value )
static

Set auto exposure region center.

◆ SetAE_Lock()

void UCameraCaptureSettingsLibrary::SetAE_Lock ( UMediaPlayer * MediaPlayer,
bool Value )
static

Set auto exposure lock.

◆ SetAE_Mode()

void UCameraCaptureSettingsLibrary::SetAE_Mode ( UMediaPlayer * MediaPlayer,
DirectCameraAEMode Value )
static

Set auto exposure mode.

◆ SetAF_Center()

void UCameraCaptureSettingsLibrary::SetAF_Center ( UMediaPlayer * MediaPlayer,
FVector2D Value )
static

Set auto focus region center.

◆ SetAF_Lock()

void UCameraCaptureSettingsLibrary::SetAF_Lock ( UMediaPlayer * MediaPlayer,
bool Value )
static

Set auto focus lock.

◆ SetAF_Mode()

void UCameraCaptureSettingsLibrary::SetAF_Mode ( UMediaPlayer * MediaPlayer,
DirectCameraAFMode Value )
static

Set auto focus mode.

◆ SetCameraCaptureSettingsOnMediaPlayer()

bool UCameraCaptureSettingsLibrary::SetCameraCaptureSettingsOnMediaPlayer ( UMediaPlayer * MediaPlayer,
UDirectCameraCaptureSettings * Settings )
static

Set camera capture settings on a DirectCameraMediaPlayer.

◆ SetExposure_Mode()

void UCameraCaptureSettingsLibrary::SetExposure_Mode ( UMediaPlayer * MediaPlayer,
DirectCameraExposureMode Value )
static

Set exposure mode.

◆ SetFixedExposureTime()

void UCameraCaptureSettingsLibrary::SetFixedExposureTime ( UMediaPlayer * MediaPlayer,
float Value )
static

Set fixed exposure time (in seconds)

◆ SetFixedFocusDistance()

void UCameraCaptureSettingsLibrary::SetFixedFocusDistance ( UMediaPlayer * MediaPlayer,
float Value )
static

Set Fixed Focus Distance (in diopters - use ConvertMetersToDiopters to convert from meters)

◆ SetFlash_Mode()

void UCameraCaptureSettingsLibrary::SetFlash_Mode ( UMediaPlayer * MediaPlayer,
DirectCameraFlashMode Value )
static

Set flash mode.

◆ SetFocus_Mode()

void UCameraCaptureSettingsLibrary::SetFocus_Mode ( UMediaPlayer * MediaPlayer,
DirectCameraFocusMode Value )
static

Set focus mode.

◆ SetISO()

void UCameraCaptureSettingsLibrary::SetISO ( UMediaPlayer * MediaPlayer,
int32 Value )
static

Set ISO value.

◆ SetReadOnly_MaxExposureTime()

void UCameraCaptureSettingsLibrary::SetReadOnly_MaxExposureTime ( UMediaPlayer * MediaPlayer,
float Value )
static

Set Read Only Maximum Exposure Time.

◆ SetReadOnly_MinExposureTime()

void UCameraCaptureSettingsLibrary::SetReadOnly_MinExposureTime ( UMediaPlayer * MediaPlayer,
float Value )
static

Set Read Only Minimum Exposure Time.

◆ SetReadOnly_MinFocusDistance()

void UCameraCaptureSettingsLibrary::SetReadOnly_MinFocusDistance ( UMediaPlayer * MediaPlayer,
float Value )
static

Set Read Only Minimum Focus Distance.

◆ SetStabilization_Mode()

void UCameraCaptureSettingsLibrary::SetStabilization_Mode ( UMediaPlayer * MediaPlayer,
DirectCameraStabilizationMode Value )
static

Set stabilization mode.

◆ SetWhiteBalance_Lock()

void UCameraCaptureSettingsLibrary::SetWhiteBalance_Lock ( UMediaPlayer * MediaPlayer,
bool Value )
static

Set white balance lock.

◆ SetWhiteBalance_Mode()

void UCameraCaptureSettingsLibrary::SetWhiteBalance_Mode ( UMediaPlayer * MediaPlayer,
DirectCameraWhiteBalanceMode Value )
static

Set white balance mode.

◆ SetZoom()

void UCameraCaptureSettingsLibrary::SetZoom ( UMediaPlayer * MediaPlayer,
float Value )
static

Set zoom level.

Member Data Documentation

◆ MediaPlayer

__Type__ Get void Set UCameraCaptureSettingsLibrary::MediaPlayer

individual settings functions below here, made with the macro below these save you having to get a struct and set it back to the media player, you can just get/set each setting directly this is useful for blueprints where you want to change one setting at a time n.b. because unreal header tool doesn't support macro expansion in header files these are expanded below, and the macro is left here so I can re-expand if properties change

◆ Value

__Type__ Get void Set __Type__ UCameraCaptureSettingsLibrary::Value

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