Navigation
Unreal Engine C++ API Reference > Plugins > BlackmagicMedia
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMediaSource
- UBaseMediaSource
- UTimeSynchronizableMediaSource
- UCaptureCardMediaSource
- UBlackmagicMediaSource
References
| Module | BlackmagicMedia |
| Header | /Engine/Plugins/Media/BlackmagicMedia/Source/BlackmagicMedia/Public/BlackmagicMediaSource.h |
| Include | #include "BlackmagicMediaSource.h" |
Syntax
UCLASS&40;BlueprintType, HideCategories&61;&40;Platforms, Object&41;, Meta&61;&40;MediaIOCustomLayout&61;"Blackmagic"&41;&41;
class UBlackmagicMediaSource : public UCaptureCardMediaSource
Remarks
Media source description for Blackmagic.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
EBlackmagicMediaAudioChannel | AudioChannels | Desired number of audio channel to capture. |
    |
EMediaIOAutoDetectableTimecodeFormat | AutoDetectableTimecodeFormat | Use the time code embedded in the input stream. |
    |
bool | bCaptureAudio | Capture Audio from the Blackmagic source. |
    |
bool | bCaptureVideo | Capture Video from the Blackmagic source. |
    |
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. |
    |
EBlackmagicMediaSourceColorFormat | ColorFormat | Native data format internally used by the device after being converted from SDI/HDMI signal. |
    |
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
| Type | Name | Description | |
|---|---|---|---|
 |
Default constructor. |
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 |