Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > AjaMedia > UAjaMediaSource

Light Theme

Dark Theme

UAjaMediaSource

Media source for AJA streams.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMediaSource

UBaseMediaSource

UTimeSynchronizableMediaSource

UAjaMediaSource

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Platforms, Object), Meta=(MediaIOCustomLayout="AJA"))
class UAjaMediaSource : public UTimeSynchronizableMediaSource

Remarks

Media source for AJA streams.

Variables

	Name	Description
EAjaMediaAudioC...	AudioChannel	Desired number of audio channel to capture.
bool	bCaptureAncillary	Capture Ancillary from the AJA source. It will decrease performance
bool	bCaptureAudio	Capture Audio from the AJA source.
bool	bCaptureVideo	Capture Video from the AJA source.
bool	bCaptureWithAutoCirculating	Use a ring buffer to capture and transfer data.
bool	bEncodeTimecodeInTexel	Burn Frame Timecode in the input texture without any frame number clipping.
bool	bIsSRGBInput	Whether the video input is in sRGB color space.
bool	bLogDropFrame	Log a warning when there's a drop frame.
EAjaMediaSource...	ColorFormat	Native data format internally used by the device after being converted from SDI/HDMI signal.
int32	MaxNumAncillaryFrameBuffer	Maximum number of ancillary data frames to buffer.
int32	MaxNumAudioFrameBuffer	Maximum number of audio frames to buffer.
int32	MaxNumVideoFrameBuffer	Maximum number of video frames to buffer.
FMediaIOConfigu...	MediaConfiguration	The device, port and video settings that correspond to the input.
EMediaIOTimecod...	TimecodeFormat	Use the time code embedded in the input stream.

Constructors

No constructors are accessible with public or protected access.

Overridden from UMediaSource

		Name	Description
	FString	GetUrl()	Get the media source's URL string (must be implemented in child classes).
	bool	Validate()	Validate the media source settings (must be implemented in child classes).

Overridden from UObject

		Name	Description
	bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.

Overridden from IMediaOptions

	Name	Description
bool	GetMediaOption ( const FName& Key, bool DefaultValue )	Get a Boolean media option.
int64	GetMediaOption ( const FName& Key, int64 DefaultValue )	Get a signed integer media option.
FString	GetMediaOption ( const FName& Key, const FString& DefaultValue )	Get a string media option.
bool	HasMediaOption ( const FName& Key )	Check whether the specified option is set.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss