1. Epic GamesDeveloper
  3. UBlackmagicMediaSource

UBlackmagicMediaSource

Media source description for Blackmagic.

API > API/Plugins > API/Plugins/BlackmagicMedia

Media source description for Blackmagic.

   
Name UBlackmagicMediaSource
Type class
Header File /Engine/Plugins/Media/BlackmagicMedia/Source/BlackmagicMedia/Public/BlackmagicMediaSource.h
Include Path #include "BlackmagicMediaSource.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UBlackmagicMediaSource()

 Default constructor. BlackmagicMediaSource.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioChannels EBlackmagicMediaAudioChannel Desired number of audio channel to capture. BlackmagicMediaSource.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Audio
  • Meta=(EditCondition="bCaptureAudio")
AutoDetectableTimecodeFormat EMediaIOAutoDetectableTimecodeFormat Use the time code embedded in the input stream. BlackmagicMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Blackmagic"
bCaptureAudio bool Capture Audio from the Blackmagic source. BlackmagicMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Audio"
bCaptureVideo bool Capture Video from the Blackmagic source. BlackmagicMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Video"
bEncodeTimecodeInTexel bool Burn Frame Timecode in the input texture without any frame number clipping. BlackmagicMediaSource.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Debug"
  • Meta=(DisplayName="Burn Frame Timecode")
bLogDropFrame bool Log a warning when there's a drop frame. BlackmagicMediaSource.h
  • EditAnywhere
  • Category="Debug"
ColorFormat EBlackmagicMediaSourceColorFormat Native data format internally used by the device after being converted from SDI/HDMI signal. BlackmagicMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category="Video"
  • Meta=(EditCondition="bCaptureVideo")
MaxNumAudioFrameBuffer int32 Maximum number of audio frames to buffer. BlackmagicMediaSource.h
  • BlueprintReadOnly
  • EditAnywhere
  • AdvancedDisplay
  • Category="Audio"
  • Meta=(EditCondition="bCaptureAudio", ClampMin="1", ClampMax="32")
MaxNumVideoFrameBuffer int32 Maximum number of video frames to buffer. BlackmagicMediaSource.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. BlackmagicMediaSource.h
  • EditAnywhere
  • Category="Blackmagic"
  • Meta=(DisplayName="Configuration")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AssignDefaultConfiguration()

 Assigns a default configuration (The first one in the list of configurations). BlackmagicMediaSource.h  

Overridden from UTimeSynchronizableMediaSource

Name Remarks Include Path Unreal Specifiers

virtual bool SupportsFormatAutoDetection()

   BlackmagicMediaSource.h  

Overridden from UMediaSource

Name Remarks Include Path Unreal Specifiers

virtual FString GetDescriptionString()

   BlackmagicMediaSource.h  

virtual void GetDetailsPanelInfoElements ( TArray< FInfoElement >& OutInfoElements
) const

   BlackmagicMediaSource.h  

virtual FString GetUrl()

   BlackmagicMediaSource.h  

virtual bool Validate()

   BlackmagicMediaSource.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   BlackmagicMediaSource.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& InPropertyChangedEvent
)

   BlackmagicMediaSource.h  

virtual void PostLoad()

   BlackmagicMediaSource.h  

Overridden from IMediaOptions

Name Remarks Include Path Unreal Specifiers

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

   BlackmagicMediaSource.h  

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

   BlackmagicMediaSource.h  

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

   BlackmagicMediaSource.h  

virtual bool HasMediaOption ( const FName& Key
) const

   BlackmagicMediaSource.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bIsSRGBInput_DEPRECATED bool Whether the video input is in sRGB color space. BlackmagicMediaSource.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use ColorEncoding instead.")
TimecodeFormat_DEPRECATED EMediaIOTimecodeFormat Use the time code embedded in the input stream. BlackmagicMediaSource.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