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 > BinkMediaPlayer > UBinkMediaPlayer

Light Theme

Dark Theme

UBinkMediaPlayer

Implements a media player asset that can play movies and other media.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBinkMediaPlayer

References

Module	BinkMediaPlayer
Header	/Engine/Plugins/Media/BinkMedia/Source/BinkMediaPlayer/Public/BinkMediaPlayer.h
Include	#include "BinkMediaPlayer.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, HideCategories=(Object))
class UBinkMediaPlayer :
public UObject,
public FTickableGameObject

Remarks

Implements a media player asset that can play movies and other media.

This class is represents a media URL along with a corresponding media player for exposing media playback functionality to the Engine and to Blueprints.

Variables

	Name	Description
TEnumAsByte< EB...	BinkBufferMode	Used to specify the how the video should be buffered.
FVector2D	BinkDestinationLowerRight	Used to specify the sounds to open at playback.
FVector2D	BinkDestinationUpperLeft	Used to specify the sounds to open at playback.
TEnumAsByte< EB...	BinkDrawStyle	Used to specify how the movie is drawn.
int32	BinkLayerDepth	Used to specify the render order.
TEnumAsByte< EB...	BinkSoundTrack	Used to specify the sounds to open at playback.
int32	BinkSoundTrackStart	Used to specify the sounds to open at playback.
BINKPLUGIN *...	bnk
TEnumAsByte< EB...	CurrentBinkBufferMode	Holds the bink buffer mode of the currently loaded media source.
TEnumAsByte< EB...	CurrentBinkSoundTrack	Holds the bink sound track of the currently loaded media source.
int32	CurrentBinkSoundTrackStart	Holds the bink sound track start of the currently loaded media source.
EBinkMediaPlaye...	CurrentDrawStyle
int32	CurrentLayerDepth
FString	CurrentUrl
uint32: 1	DelayedOpen	To reduce memory use, don't immediately open the bink until it is first played.
uint32: 1	Looping	Whether playback should loop when it reaches the end.
FOnMediaChanged	MediaChangedEvent	Holds a delegate that is executed when media has been opened or closed.
FOnBinkMediaPla...	OnMediaClosed	Holds a delegate that is invoked when a media source has been closed.
FOnBinkMediaPla...	OnMediaOpened	Holds a delegate that is invoked when a media source has been opened.
FOnBinkMediaPla...	OnMediaReachedEnd	Holds a delegate that is invoked when a media source has been opened.
FOnBinkMediaPla...	OnPlaybackSuspended	A delegate that is invoked when media playback has been suspended.
FDelegateHandle	overlayHook
bool	paused
bool	reached_end
uint32: 1	StartImmediately	Whether playback start immediately, or wait for blueprint to start it.
FString	URL	The path or URL to the media file to be played.

Constructors

	Name	Description
	UBinkMediaPlayer ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	CanPause()	Checks whether media playback can be paused right now.
bool	CanPlay()	Checks whether media playback can be started right now.
void	Close()
void	CloseUrl()	Opens the specified media URL.
void	Draw ( UTexture* texture, bool tonemap, int out_nits, float alpha, bool srgb_decode, bool hdr )	Draws this bink to the specified texture
FIntPoint	GetDimensions()
FTimespan	GetDuration()	Gets the media's duration.
float	GetFrameRate()
float	GetRate()	Gets the media's current playback rate.
FTimespan	GetTime()	Gets the media's current playback time.
const FStrin...	GetUrl()	Gets the URL of the currently loaded media, if any.
void	HandleMediaPlayerMediaClosed()	Callback for when the media player has closed a media source.
void	HandleMediaPlayerMediaOpened ( FString OpenedUrl )	Callback for when the media player has opened a new media source.
void	InitializePlayer()	Initializes the media player.
bool	IsInitialized()	Checks whether this player has been initialized with a media source.
bool	IsLooping()	Checks whether playback is looping.
bool	IsPaused()	Checks whether playback is currently paused.
bool	IsPlaying()	Checks whether playback has started.
bool	IsReady()
bool	IsStopped()	Checks whether playback has stopped.
UBinkMediaPl...	OnMediaChanged()
bool	Open ( const FString& Url )
bool	OpenUrl ( const FString& NewUrl )	Opens the specified media URL.
bool	Pause()	Pauses media playback. This is the same as setting the playback rate to 0.0.
bool	Play()	Starts media playback. This is the same as setting the playback rate to 1.0.
bool	Rewind()	Rewinds the media to the beginning. This is the same as seeking to zero time.
bool	Seek ( const FTimespan& InTime )	Seeks to the specified playback time.
bool	SetLooping ( bool InLooping )	Enables or disables playback looping.
bool	SetRate ( float Rate )	Changes the media's playback rate.
void	SetVolume ( float Rate )	Changes the media's volume
void	Stop()	Stops playback and unloads the video from memory.
bool	SupportsRate ( float Rate, bool Unthinned )	Checks whether the specified playback rate is supported.
bool	SupportsScrubbing()	Checks whether the currently loaded media supports scrubbing.
bool	SupportsSeeking()	Checks whether the currently loaded media can jump to a certain position.
void	UpdateTexture ( FRHICommandListImmediate& RHICmdLi..., FTextureRHIRef ref, void* nativePtr, int width, int height, bool isEditor, bool tonemap, int output_nits, float alpha, bool srgb_decode, bool is_hdr )

Overridden from UObject

	Name	Description
void	BeginDestroy()	UMediaPlayerBase overrides not already part of the build provided by RAD virtual TSharedRef GetPlayerFacade() const override; virtual bool IsPreparing() const override { return !IsReady(); } virtual bool OpenSource(UMediaSource* InMediaSource) override;
FString	GetDesc()	Return a one line description of an object for viewing in the thumbnail view of the generic browser
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Overridden from FTickableGameObject

		Name	Description
	bool	IsTickableInEditor()	Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Classes

	Name	Description
	FOnMediaChanged	Gets an event delegate that is invoked when media has been opened or closed.

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

Take our survey

Dismiss