1. Epic GamesDeveloper
  3. FMediaIOCorePlayerBase

FMediaIOCorePlayerBase

Implements a base player for hardware IO cards.

Unreal Engine C++ API Reference > Plugins > MediaIOCore

Inheritance Hierarchy

References

   
Module MediaIOCore
Header /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCorePlayerBase.h
Include #include "MediaIOCorePlayerBase.h"

Syntax

class FMediaIOCorePlayerBase :  
    public IMediaPlayer ,  
    protected IMediaCache ,  
    protected IMediaControls ,  
    protected IMediaTracks ,  
    protected IMediaView ,  
    public ITimedDataInput ,  
    public TSharedFromThis< FMediaIOCorePlayerBase >

Remarks

Implements a base player for hardware IO cards.

The processing of metadata and video frames is delayed until the fetch stage (TickFetch) in order to increase the window of opportunity for receiving frames for the current render frame time code.

Depending on whether the media source enables time code synchronization, the player's current play time (CurrentTime) is derived either from the time codes embedded in frames or from the Engine's global time code.

Variables

  Type Name Description
Protected variable FMediaAudioTrackFormat AudioTrackFormat Format of the audio.
Protected variable FMediaIOSamplingSettings BaseSettings Base set of settings to start from when setuping channels
Protected variable bool bAutoDetect Whether we are using autodetection.
Protected variable bool bFramelock Whether media playback should be framelocked to the engine's timecode
Protected variable bool bOverrideSourceColorSpace Whether to override the source color space or to use the metadata embedded in the ancillary data of the signal.
Protected variable bool bOverrideSourceEncoding Whether to override the source encoding or to use the metadata embedded in the ancillary data of the signal.
Protected variable bool bWarnedIncompatibleFrameRate Warn when the video frame rate is not the same as the engine's frame rate.
Protected variable TArray< ITimedDataInputChannel * > Channels Timed Data Input handler
Protected variable EMediaState CurrentState Current state of the media player.
Protected variable FTimespan CurrentTime Current playback time.
Protected variable EMediaIOSampleEvaluationType EvaluationType Sample evaluation type.
Protected variable IMediaEventSink & EventSink The media event handler.
Protected variable int32 FrameDelay When using Time Synchronization (TC synchronization), how many frame back of a delay would you like.
Public variable TSharedPtr< FMediaIOCoreTextureSampleBase > & JITRProxySample  
Protected variable uint64 LastEngineRTFrameThatUpdatedJustInTime Used to ensure that JIT rendering is executed only once per frame
Protected variable TSharedPtr< struct FOpenColorIOColorConversionSettings > OCIOSettings Open color IO conversion data.
Protected variable FString OpenUrl Url used to open the media player.
Protected variable ETextureColorSpace OverrideSourceColorSpace Color space of the source texture.
Protected variable ETextureSourceEncoding OverrideSourceEncoding Encoding of the source texture.
Protected variable FTimespan PreviousFrameTimespan Previous frame Timespan
Protected variable const TUniquePtr< FMediaIOCoreSamples > Samples The media sample cache.
Protected variable double TimeDelay When not using Time Synchronization (use computer time), how many sec back of a delay would you like.
Protected variable FFrameRate VideoFrameRate Video frame rate in the last received sample.
Protected variable FMediaVideoTrackFormat VideoTrackFormat Format of the video.

Constructors

  Type Name Description
Public function   Create and initialize a new instance.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Protected function Virtual TSharedPtr< FMediaIOCoreTextureSampleBase > Acquire a proxy sample for JITR. That sample must be initialized for JITR.
Protected function Const TSharedPtr< FMediaIOCoreTextureSampleBase > Factory method to generate texture samples.
Protected function void Internal API to push an audio sample to the internal samples pool
Protected function void Internal API to push a caption sample to the internal samples pool
Protected function void Internal API to push a metadata sample to the internal samples pool
Protected function void Internal API to push a subtitle sample to the internal samples pool
Protected function void Internal API to push a video sample to the internal samples pool
Protected function Virtual void Called after fast GPUDirect texture transferring is finished
Protected function Virtual Const bool Whether fast GPU transferring is available
Protected function Virtual Const TSharedPtr< FMediaIOCoreTextureSampleConverter > Factory method to create sample converters.
Protected function Const TArray< TSharedRef< FMediaIOCoreTextureSampleBase > >

Deinterlace ( const UE::MediaIOCore::FVideoFrame& InVideoFrame
)

 Deinterlace a video frame. Only valid to call when the video stream is open.
Protected function Static double Get the application time with a delta to represent the actual system time.
Protected function Virtual Const EMediaIOCoreColorFormat  
Protected function Virtual Const uint32 Get the number of video frames to buffer.
Protected function Static double Get the platform time with a delta to represent the actual system time.
Public function Const const FMediaIOCoreSamples &  
Protected function Const bool Whether a texture availabled for GPU transfer
Protected function Const bool Is the IO hardware/device ready to be used.
Protected function Virtual Const bool Whether JITR is available and active
Protected function Static bool Log the timecode when a frame is received.
Public function Virtual bool Just in time sample rendering.
Protected function void Allows children to notify when video format is known after auto-detection.
Protected function Virtual TSharedPtr< FMediaIOCoreTextureSampleBase >

PickSampleToRender_RenderThread ( const FFrameInfo& InFrameInformation
)

 Pick a sample to render
Protected function Virtual TSharedPtr< FMediaIOCoreTextureSampleBase >  
Protected function Virtual TSharedPtr< FMediaIOCoreTextureSampleBase >  
Protected function Virtual TSharedPtr< FMediaIOCoreTextureSampleBase >  
Protected function Virtual bool

ReadMediaOptions ( const IMediaOptions* Options
)

 Return true if the options combination are valid.
Protected function void Setup settings for the different kind of supported data channels.
Public function Virtual void  
Protected function void A wrapper method responsible for transferring of the sample textures into GPU memory based on the current settings and hardware capabilities.

Overridden from IMediaPlayer

  Type Name Description
Public function Virtual void

Close ()

 Close a previously opened media source.
Public function Virtual IMediaCache & Get the player's cache controls.
Public function Virtual IMediaControls & Get the player's playback controls.
Public function Virtual Const FString

GetInfo ()

 Get debug information about the player and currently opened media.
Public function Virtual IMediaSamples & Get the player's sample queue.
Public function Virtual Const FString Get playback statistics information.
Public function Virtual IMediaTracks & Get the player's track collection.
Public function Virtual Const FString

GetUrl ()

 Get the URL of the currently loaded media.
Public function Virtual IMediaView &

GetView ()

 Get the player's view settings.
Public function Virtual bool

Open ( const FString& Url,
const IMediaOptions* Options
)

 Open a media source from a URL with optional parameters.
Public function Virtual bool

Open ( const TSharedRef< FArchive, ESPMode::ThreadSafe >& Archive,
const FString& OriginalUrl,
const IMediaOptions* Options
)

 Open a media source from a file or memory archive with optional parameters.
Public function Virtual void

TickFetch ( FTimespan DeltaTime,
FTimespan Timecode
)

 Tick the player in the Fetch phase.

Overridden from IMediaCache

  Type Name Description
Public function Virtual Const int32 Query the number of samples for the specified caching state.
Public function Virtual Const bool

QueryCacheState ( EMediaCacheState State,
TRangeSet< FTimespan >& OutTimeRanges
)

 Query the time ranges of cached media samples for the specified caching state.

Overridden from IMediaControls

  Type Name Description
Protected function Virtual Const bool Whether the specified control is currently available.
Protected function Virtual Const FTimespan Get the media's duration.
Protected function Virtual Const float

GetRate ()

 Get the nominal playback rate, i.e. 1.0 for real time.
Protected function Virtual Const EMediaState Get the state of the media.
Protected function Virtual Const EMediaStatus Get media player status flags.
Protected function Virtual Const TRangeSet< float > Get the supported playback rates.
Protected function Virtual Const FTimespan

GetTime ()

 Get the player's current playback time.
Protected function Virtual Const bool Check whether playback is currently looping.
Protected function Virtual bool

Seek ( const FTimespan& Time
)

 Change the media's playback time.
Protected function Virtual bool

SetLooping ( bool Looping
)

 Set whether playback should be looping.
Protected function Virtual bool

SetRate ( float Rate
)

 Set the current playback rate.

Overridden from IMediaTracks

  Type Name Description
Protected function Virtual Const bool

GetAudioTrackFormat ( int32 TrackIndex,
int32 FormatIndex,
FMediaAudioTrackFormat& OutFormat
)

 Get details about the specified audio track format.
Protected function Virtual Const int32

GetNumTrackFormats ( EMediaTrackType TrackType,
int32 TrackIndex
)

 Get the number of formats of the specified track.
Protected function Virtual Const int32 Get the number of media tracks of the given type.
Protected function Virtual Const int32 Get the index of the currently selected track of the given type.
Protected function Virtual Const FText

GetTrackDisplayName ( EMediaTrackType TrackType,
int32 TrackIndex
)

 Get the human readable name of the specified track.
Protected function Virtual Const int32

GetTrackFormat ( EMediaTrackType TrackType,
int32 TrackIndex
)

 Get the index of the currently selected format of the given track type.
Protected function Virtual Const FString

GetTrackLanguage ( EMediaTrackType TrackType,
int32 TrackIndex
)

 Get the language tag of the specified track.
Protected function Virtual Const FString

GetTrackName ( EMediaTrackType TrackType,
int32 TrackIndex
)

 Get the internal name of the specified track.
Protected function Virtual Const bool

GetVideoTrackFormat ( int32 TrackIndex,
int32 FormatIndex,
FMediaVideoTrackFormat& OutFormat
)

 Get details about the specified video track format.
Protected function Virtual bool

SelectTrack ( EMediaTrackType TrackType,
int32 TrackIndex
)

 Select the active track of the given type.
Protected function Virtual bool

SetTrackFormat ( EMediaTrackType TrackType,
int32 TrackIndex,
int32 FormatIndex
)

 Select the active format on the specified track.

Overridden from ITimedDataInput

  Type Name Description
Public function Virtual void Add a channel belonging to this input
Public function Virtual Const TArray< ITimedDataInputChannel * > Get a list of the channel this input has.
Public function Virtual Const FText Get the name used when displayed.
Public function Virtual Const double Get the offset in seconds used at evaluation.
Public function Virtual Const ETimedDataInputEvaluationType Get how the input is evaluated.
Public function Virtual Const FFrameRate Get the frame rate at which the samples are produced.
Public function Virtual Const bool Does channel from this input support a different buffer size than it's input.
Public function Virtual void Remove channel from the input
Public function Virtual void

SetEvaluationOffsetInSeconds ( double Offset
)

 Set the offset in seconds used at evaluation.
Public function Virtual void Set how the input is evaluated.
Public function Virtual Const bool Whether this input supports sub frames.

Classes

  Type Name Description
Public class FFrameInfo Class used to pass information about current frame for sample picking.  

Deprecated Functions

  Type Name Description
Public function  

UE_DEPRECATED ( "5.5",
"Use the overloaded method that takes FFrameInfo instead of proxy sample."
)

 Deprecated in UE5.5.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page