UBinkMediaTexture

Implements a texture asset for rendering video tracks from [UBinkMediaPlayer](API\Plugins\BinkMediaPlayer\UBinkMediaPlayer) assets.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

BinkMediaPlayer

Header

/Engine/Plugins/Media/BinkMedia/Source/BinkMediaPlayer/Public/BinkMediaTexture.h

Include

#include "BinkMediaTexture.h"

Syntax

UCLASS(HideCategories=(Compression, LevelOfDetail, Object))
class UBinkMediaTexture : public UTexture

Remarks

Implements a texture asset for rendering video tracks from UBinkMediaPlayer assets.

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable

TEnumAsByte< Te...

 

AddressX

The addressing mode to use for the X axis.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable

TEnumAsByte< Te...

 

AddressY

The addressing mode to use for the Y axis.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

float

 

Alpha

Alpha_value is just a constant blend value for entire video frame.

Public variable

FIntPoint

 

CachedDimensions

Public variable

UBinkMediaPlaye...

 

CurrentMediaPlayer

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

DecodeSRGB

Enable decoding of sRGB to Linear inside Bink when drawing to this texture.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

UBinkMediaPlaye...

 

MediaPlayer

The MediaPlayer asset to stream video from.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

float

 

OutputNits

When tonemapping, set this for to desired output nits capability for the current display.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

TEnumAsByte< EP...

 

PixelFormat

The Pixel Format for the texture.

Public variable

FRenderCommandF...

 

ReleasePlayerFence

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

bool

 

Tonemap

Whether to enable tonemaping for the video.

Constructors

Name Description

Public function

UBinkMediaTexture

(
    const FObjectInitializer& ObjectIn...
)

Destructors

Name Description

Public function

~UBinkMediaTexture()

Functions

Name Description

Public function UFunction BlueprintCallable, Category

void

 

Clear()

Clears this texture to transparent-black.

Public function

void

 

HandleMediaPlayerMediaChanged()

Public function

void

 

InitializeTrack()

Public function UFunction BlueprintCallable, Category

void

 

SetMediaPlayer

(
    UBinkMediaPlayer* InMediaPlaye...
)

Sets the media player asset to be used for this texture.

Overridden from UTexture

Name Description

Public function Virtual

FTextureReso...

 

CreateResource()

Implemented by subclasses to create a new resource for the texture.

Public function Virtual Const

EMaterialVal...

 

GetMaterialType()

Public function Virtual Const

uint32

 

GetSurfaceArraySize()

Public function Virtual Const

float

 

GetSurfaceDepth()

Public function Virtual Const

float

 

GetSurfaceHeight()

Public function Virtual Const

float

 

GetSurfaceWidth()

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

FinishDestroy()

Called to finish destroying the object.

Public function Virtual

FString

 

GetDesc()

Return a one line description of an object for viewing in the thumbnail view of the generic browser

Public function Virtual

bool

 

IsReadyForFinishDestroy()

Called to check if the object is ready for FinishDestroy.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.