Navigation
API > API/Plugins > API/Plugins/AjaMedia
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMediaSource
- UBaseMediaSource
- UTimeSynchronizableMediaSource
- UCaptureCardMediaSource
- UAjaMediaSource
References
| Module | AjaMedia |
| Header | /Engine/Plugins/Media/AjaMedia/Source/AjaMedia/Public/AjaMediaSource.h |
| Include | #include "AjaMediaSource.h" |
Syntax
UCLASS&40;BlueprintType, HideCategories&61;&40;Platforms, Object&41;, Meta&61;&40;MediaIOCustomLayout&61;"AJA"&41;&41;
class UAjaMediaSource : public UCaptureCardMediaSource
Remarks
Media source for AJA streams.
Variables
| Type | Name | Description | |
|---|---|---|---|
| EAjaMediaAudioChannel | AudioChannel | Desired number of audio channel to capture. | |
| EMediaIOAutoDetectableTimecodeFormat | AutoDetectableTimecodeFormat | Use the time code embedded in the input stream. | |
| 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 | bLogDropFrame | Log a warning when there's a drop frame. | |
| EAjaMediaSourceColorFormat | 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. | |
| FMediaIOConfiguration | MediaConfiguration | The device, port and video settings that correspond to the input. |
Constructors
No constructors are accessible with public or protected access.
Overridden from UTimeSynchronizableMediaSource
| Type | Name | Description | |
|---|---|---|---|
| bool |
Overridden from UMediaSource
| Type | 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
| Type | 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& PropertyChangedEvent |
This alternate version of PostEditChange is called when properties inside structs are modified. | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
Overridden from IMediaOptions
| Type | Name | Description | |
|---|---|---|---|
| bool | GetMediaOption
(
const FName& Key, |
Get a Boolean media option. | |
| int64 | GetMediaOption
(
const FName& Key, |
Get a signed integer media option. | |
| FString | GetMediaOption
(
const FName& Key, |
Get a string media option. | |
| bool | HasMediaOption
(
const FName& Key |
Check whether the specified option is set. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bIsSRGBInput_DEPRECATED | Whether the video input is in sRGB color space. | |
| EMediaIOTimecodeFormat | TimecodeFormat_DEPRECATED | Use AutoDetectableTimecodeFormat |