1. Epic GamesDeveloper
  3. UAjaMediaSource

UAjaMediaSource

Media source for AJA streams.

API > API/Plugins > API/Plugins/AjaMedia

Media source for AJA streams.

   
Name UAjaMediaSource
Type class
Header File /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h
Include Path #include "AjaMediaSource.h"

Syntax

UCLASS (BlueprintType, HideCategories=(Platforms, Object),  
       prioritizeCategories=(AJA, Video, Audio, Ancillary, Synchronization, Debug),  
       Meta=(MediaIOCustomLayout="AJA"))  
class UAjaMediaSource : public UCaptureCardMediaSource

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAjaMediaSource()

 Default constructor. AjaMediaSource.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioChannel EAjaMediaAudioChannel Desired number of audio channel to capture. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Audio"
  • Meta=(EditCondition="bCaptureAudio")
AutoDetectableTimecodeFormat EMediaIOAutoDetectableTimecodeFormat Use the time code embedded in the input stream. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="AJA"
  • Meta=(DisplayName="Timecode Format")
bCaptureAncillary bool Capture Ancillary from the AJA source. It will decrease performance AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Ancillary"
bCaptureAudio bool Capture Audio from the AJA source. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Audio"
bCaptureVideo bool Capture Video from the AJA source. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Video"
bCaptureWithAutoCirculating bool Use a ring buffer to capture and transfer data. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="AJA"
bEncodeTimecodeInTexel bool Burn Frame Timecode in the input texture without any frame number clipping. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Debug"
  • Meta=(DisplayName="Burn Frame Timecode")
bLogDropFrame bool Log a warning when there's a drop frame. AjaMediaSource.h
  • EditAnywhere
  • Category="Debug"
bStopInputOnCardTimeout bool If this is disabled, input will keep going even if we hit a timeout when waiting for a vertical interrupt from the card. AjaMediaSource.h
  • EditAnywhere
  • Category="AJA"
ColorFormat EAjaMediaSourceColorFormat Native data format internally used by the device after being converted from SDI/HDMI signal. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Video"
  • Meta=(EditCondition="bCaptureVideo")
MaxNumAncillaryFrameBuffer int32 Maximum number of ancillary data frames to buffer. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • AdvancedDisplay
  • Category="Ancillary"
  • Meta=(EditCondition="bCaptureAncillary", ClampMin="1", ClampMax="32")
MaxNumAudioFrameBuffer int32 Maximum number of audio frames to buffer. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • AdvancedDisplay
  • Category="Audio"
  • Meta=(EditCondition="bCaptureAudio", ClampMin="1", ClampMax="32")
MaxNumVideoFrameBuffer int32 Maximum number of video frames to buffer. AjaMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • AdvancedDisplay
  • Category="Video"
  • Meta=(EditCondition="bCaptureVideo", ClampMin="1", ClampMax="32")
MediaConfiguration FMediaIOConfiguration The device, port and video settings that correspond to the input. AjaMediaSource.h
  • EditAnywhere
  • Category="AJA"
  • Meta=(DisplayName="Configuration")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   AjaMediaSource.h  

virtual FString GetDescriptionString()

   AjaMediaSource.h  

virtual void GetDetailsPanelInfoElements ( TArray< TTuple< FText, FText, FText > >& OutInfoElements
) const

   AjaMediaSource.h  

virtual bool GetMediaOption ( const FName& Key,
bool DefaultValue
) const

   AjaMediaSource.h  

virtual int64 GetMediaOption ( const FName& Key,
int64 DefaultValue
) const

   AjaMediaSource.h  

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

   AjaMediaSource.h  

virtual FString GetUrl()

   AjaMediaSource.h  

virtual bool HasMediaOption ( const FName& Key
) const

   AjaMediaSource.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   AjaMediaSource.h  

virtual void PostLoad()

   AjaMediaSource.h  

virtual bool SupportsFormatAutoDetection()

   AjaMediaSource.h  

virtual bool Validate()

   AjaMediaSource.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bIsSRGBInput_DEPRECATED bool Whether the video input is in sRGB color space. AjaMediaSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use ColorEncoding instead.")
TimecodeFormat_DEPRECATED EMediaIOTimecodeFormat Use the time code embedded in the input stream. AjaMediaSource.h
  • Meta=(DeprecatedProperty)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page