1. Epic GamesDeveloper
  3. UAjaMediaSource

UAjaMediaSource

Media source for AJA streams.

Unreal Engine C++ API Reference > Plugins > AjaMedia

Inheritance Hierarchy

References

   
Module AjaMedia
Header /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h
Include #include "AjaMediaSource.h"

Syntax

UCLASS (BlueprintType, HideCategories=(Platforms, Object), Meta=(MediaIOCustomLayout="AJA"))  
class UAjaMediaSource : public UCaptureCardMediaSource

Remarks

Media source for AJA streams.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly EAjaMediaAudioChannel AudioChannel Desired number of audio channel to capture.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly EMediaIOAutoDetectableTimecodeFormat AutoDetectableTimecodeFormat Use the time code embedded in the input stream.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bCaptureAncillary Capture Ancillary from the AJA source. It will decrease performance
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bCaptureAudio Capture Audio from the AJA source.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bCaptureVideo Capture Video from the AJA source.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bCaptureWithAutoCirculating Use a ring buffer to capture and transfer data.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bEncodeTimecodeInTexel Burn Frame Timecode in the input texture without any frame number clipping.
Public variable UProperty Category, EditAnywhere bool bLogDropFrame Log a warning when there's a drop frame.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly EAjaMediaSourceColorFormat ColorFormat Native data format internally used by the device after being converted from SDI/HDMI signal.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly int32 MaxNumAncillaryFrameBuffer Maximum number of ancillary data frames to buffer.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly int32 MaxNumAudioFrameBuffer Maximum number of audio frames to buffer.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly int32 MaxNumVideoFrameBuffer Maximum number of video frames to buffer.
Public variable UProperty Category, EditAnywhere, Meta FMediaIOConfiguration MediaConfiguration The device, port and video settings that correspond to the input.

Constructors

No constructors are accessible with public or protected access.

Functions

  Type Name Description
Public function Virtual void  

Overridden from UCaptureCardMediaSource

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Public function Virtual void  

Overridden from UTimeSynchronizableMediaSource

  Type Name Description
Public function Virtual Const bool  

Overridden from UMediaSource

  Type Name Description
Public function Virtual Const bool

GetMediaOption ( const FName& Key,
bool DefaultValue
)

  
Public function Virtual Const int64

GetMediaOption ( const FName& Key,
int64 DefaultValue
)

  
Public function Virtual Const FString

GetMediaOption ( const FName& Key,
const FString& DefaultValue
)

  
Public function Virtual Const FString

GetUrl ()

 Get the media source's URL string (must be implemented in child classes).
Public function Virtual Const bool

HasMediaOption ( const FName& Key
)

  
Public function Virtual Const bool Validate the media source settings (must be implemented in child classes).

Deprecated Variables

  Type Name Description
Public variable UProperty Meta bool bIsSRGBInput_DEPRECATED Whether the video input is in sRGB color space.
Public variable UProperty Meta EMediaIOTimecodeFormat TimecodeFormat_DEPRECATED Use the time code embedded in the input stream.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page