1. Epic GamesDeveloper
  3. UBinkMediaPlayer

UBinkMediaPlayer

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

API > API/Plugins > API/Plugins/BinkMediaPlayer

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.

   
Name UBinkMediaPlayer
Type class
Header File /Engine/Plugins/Media/BinkMedia/Source/BinkMediaPlayer/Public/BinkMediaPlayer.h
Include Path #include "BinkMediaPlayer.h"

Syntax

UCLASS (BlueprintType, HideCategories=(Object))  
class UBinkMediaPlayer :  
    public UObject ,  
    public FTickableGameObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UBinkMediaPlayer ( const FObjectInitializer& ObjectInitializer
)

   BinkMediaPlayer.h  

Classes

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

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BinkBufferMode TEnumAsByte< EBinkMediaPlayerBinkBufferModes > Used to specify the how the video should be buffered. BinkMediaPlayer.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Source
BinkDestinationLowerRight FVector2D Used to specify the sounds to open at playback. BinkMediaPlayer.h
  • EditAnywhere
  • Category=Playback
BinkDestinationUpperLeft FVector2D Used to specify the sounds to open at playback. BinkMediaPlayer.h
  • EditAnywhere
  • Category=Playback
BinkDrawStyle TEnumAsByte< EBinkMediaPlayerBinkDrawStyle > Used to specify how the movie is drawn. BinkMediaPlayer.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Source
BinkLayerDepth int32 Used to specify the render order. BinkMediaPlayer.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Source
BinkSoundTrack TEnumAsByte< EBinkMediaPlayerBinkSoundTrack > Used to specify the sounds to open at playback. BinkMediaPlayer.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Source
BinkSoundTrackStart int32 Used to specify the sounds to open at playback. BinkMediaPlayer.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Source
bnk BINKPLUGIN *   BinkMediaPlayer.h  
CurrentBinkBufferMode TEnumAsByte< EBinkMediaPlayerBinkBufferModes > Holds the bink buffer mode of the currently loaded media source. BinkMediaPlayer.h  
CurrentBinkSoundTrack TEnumAsByte< EBinkMediaPlayerBinkSoundTrack > Holds the bink sound track of the currently loaded media source. BinkMediaPlayer.h  
CurrentBinkSoundTrackStart int32 Holds the bink sound track start of the currently loaded media source. BinkMediaPlayer.h  
CurrentDrawStyle EBinkMediaPlayerBinkDrawStyle   BinkMediaPlayer.h  
CurrentHasSubtitles int32   BinkMediaPlayer.h  
CurrentLayerDepth int32   BinkMediaPlayer.h  
CurrentUrl FString Note - not serialized. BinkMediaPlayer.h  
DelayedOpen uint32 To reduce memory use, don't immediately open the bink until it is first played. BinkMediaPlayer.h
  • EditAnywhere
  • Category=Playback
Looping uint32 Whether playback should loop when it reaches the end. BinkMediaPlayer.h
  • EditAnywhere
  • Category=Playback
MediaChangedEvent FOnMediaChanged Holds a delegate that is executed when media has been opened or closed. BinkMediaPlayer.h  
OnMediaClosed FOnBinkMediaPlayerMediaClosed Holds a delegate that is invoked when a media source has been closed. BinkMediaPlayer.h
  • BlueprintAssignable
  • Category="Media|BinkMediaPlayer"
OnMediaOpened FOnBinkMediaPlayerMediaOpened Holds a delegate that is invoked when a media source has been opened. BinkMediaPlayer.h
  • BlueprintAssignable
  • Category="Media|BinkMediaPlayer"
OnMediaReachedEnd FOnBinkMediaPlayerMediaReachedEnd Holds a delegate that is invoked when a media source has been opened. BinkMediaPlayer.h
  • BlueprintAssignable
  • Category="Media|BinkMediaPlayer"
OnPlaybackSuspended FOnBinkMediaPlayerMediaEvent A delegate that is invoked when media playback has been suspended. BinkMediaPlayer.h
  • BlueprintAssignable
  • Category="Media|BinkMediaPlayer"
  • Meta=(HideInDetailPanel)
overlayHook FDelegateHandle   BinkMediaPlayer.h  
paused bool   BinkMediaPlayer.h  
reached_end bool   BinkMediaPlayer.h  
StartImmediately uint32 Whether playback start immediately, or wait for blueprint to start it. BinkMediaPlayer.h
  • EditAnywhere
  • Category=Playback
URL FString The path or URL to the media file to be played. BinkMediaPlayer.h
  • EditAnywhere
  • Category=Source

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanPause ()

 Checks whether media playback can be paused right now. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool CanPlay ()

 Checks whether media playback can be started right now. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

void Close()

   BinkMediaPlayer.h  

void CloseUrl ()

 Closes the specified media URL. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

void Draw ( UTexture* texture,
bool tonemap,
int out_nits,
float alpha,
bool srgb_decode,
bool hdr
)

 Draws this bink to the specified texture BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

FIntPoint GetDimensions()

   BinkMediaPlayer.h  
Gets the media's duration. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

float GetFrameRate()

   BinkMediaPlayer.h  

float GetRate ()

 Gets the media's current playback rate. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"
Gets the media's current playback time. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

const FString & GetUrl ()

 Gets the URL of the currently loaded media, if any. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

void HandleMediaPlayerMediaClosed()

 Callback for when the media player has closed a media source. BinkMediaPlayer.h  

void HandleMediaPlayerMediaOpened ( FString OpenedUrl
)

 Callback for when the media player has opened a new media source. BinkMediaPlayer.h  

void InitializePlayer()

 Initializes the media player. BinkMediaPlayer.h  

bool IsGotoing ()

 Checks whether playback is "GoTo'ing". BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool IsInitialized ()

 Checks whether this player has been initialized with a media source. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool IsLooping ()

 Checks whether playback is looping. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool IsPaused ()

 Checks whether playback is currently paused. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool IsPlaying ()

 Checks whether playback has started. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool IsReady()

   BinkMediaPlayer.h  

bool IsStopped ()

 Checks whether playback has stopped. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

UBinkMediaPlayer::FOnMediaChanged TBaseMulticastDelegate_NoParams OnMediaChanged()

   BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool Open ( const FString& Url
)

   BinkMediaPlayer.h  

bool OpenUrl ( const FString& NewUrl
)

 Opens the specified media URL. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool Pause ()

 Pauses media playback.This is the same as setting the playback rate to 0.0. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool Play ()

 Starts media playback.This is the same as setting the playback rate to 1.0. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool Rewind ()

 Rewinds the media to the beginning.This is the same as seeking to zero time. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool Seek ( const FTimespan& InTime
)

 Seeks to the specified playback time. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool SetLooping ( bool InLooping
)

 Enables or disables playback looping. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool SetRate ( float Rate
)

 Changes the media's playback rate. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

void SetVolume ( float Rate
)

 Changes the media's volume BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

void Stop ()

 Stops playback and unloads the video from memory. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool SupportsRate ( float Rate,
bool Unthinned
) const

 Checks whether the specified playback rate is supported. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"
Checks whether the currently loaded media supports scrubbing. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

bool SupportsSeeking ()

 Checks whether the currently loaded media can jump to a certain position. BinkMediaPlayer.h
  • BlueprintCallable
  • Category="Media|BinkMediaPlayer"

void UpdateTexture ( const UTexture* tex,
FRHICommandListImmediate& RHICmdList,
FTextureRHIRef ref,
void* nativePtr,
int width,
int height,
bool isEditor,
bool tonemap,
int output_nits,
float alpha,
bool srgb_decode,
bool is_hdr
)

   BinkMediaPlayer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual 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; BinkMediaPlayer.h  

virtual FString GetDesc()

   BinkMediaPlayer.h  

virtual void PostLoad()

   BinkMediaPlayer.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsTickableInEditor()

   BinkMediaPlayer.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   BinkMediaPlayer.h  

virtual bool IsTickable()

   BinkMediaPlayer.h  

virtual void Tick ( float DeltaTime
)

   BinkMediaPlayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page