1. Epic GamesDeveloper
  3. IMediaRenderer

IMediaRenderer

API > API/Plugins > API/Plugins/ElectraBase

   
Name IMediaRenderer
Type class
Header File /Engine/Plugins/Media/ElectraUtil/Source/ElectraBase/Public/MediaRendererBase.h
Include Path #include "MediaRendererBase.h"

Syntax

class IMediaRenderer : public IDecoderOutputOwner

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IMediaRenderer()

   MediaRendererBase.h  

Interfaces

Name Remarks
IBuffer Buffer interface

Functions

Public

Name Remarks Include Path Unreal Specifiers

UEMediaError AcquireBuffer ( IBuffer*& OutBuffer,
int32 TimeoutInMicroseconds,
const FParamDict& InParameters
)

 Asks for a sample buffer from the buffer pool created previously through CreateBufferPool(). MediaRendererBase.h  

bool CanReceiveOutputFrames ( uint64 NumFrames
) const

 Returns if the renderer's output queues are ready to receive any output from a decode MediaRendererBase.h  

UEMediaError CreateBufferPool ( const FParamDict& Parameters
)

 Methods called from a decoder (and from within the decoder thread) Create a buffer pool from where a decoder can get the block of memory to decode into. MediaRendererBase.h  

UEMediaError Flush ( const FParamDict& InOptions
)

 Flushes all pending buffers not yet rendered. MediaRendererBase.h  
Methods called from both a decoder and the player from their respective threads. MediaRendererBase.h  

bool GetEnqueuedFrameInfo ( int32& OutNumberOfEnqueuedFrames,
FTimeValue& OutDurationOfEnqueuedFrames
) const

 Returns how many frames of ready to use data the renderer has in its queue. MediaRendererBase.h  

UEMediaError ReleaseBufferPool ()

 Informs that the decoder is done with this pool. MediaRendererBase.h  

UEMediaError ReturnBuffer ( IBuffer* Buffer,
bool bRender,
FParamDict& InOutSampleProperties
)

 Releases the buffer for rendering and subsequent return to the buffer pool. MediaRendererBase.h  

void SetNextApproximatePresentationTime ( const FTimeValue& NextApproxPTS
)

 Sets the next expected sample's approximate presentation time stamp. MediaRendererBase.h  

void SetParentRenderer ( TWeakPtr< IMediaRenderer, ESPMode::ThreadSafe > ParentRenderer
)

 Called if this renderer is being wrapped by another renderer. MediaRendererBase.h  

void SetRenderClock ( TSharedPtr< IMediaRenderClock, ESPMode::ThreadSafe > RenderClock
)

 Methods called from the player (and from within the player thread) Sets the render clock which this renderer needs to update with the presentation time of the most recently rendered sample. MediaRendererBase.h  

void StartRendering ( const FParamDict& InOptions
)

 Begins rendering of the first sample buffer. MediaRendererBase.h  

void StopRendering ( const FParamDict& InOptions
)

 Stops rendering of sample buffers. MediaRendererBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page