IMediaBinarySample Class Reference

#include <IMediaBinarySample.h>

Public Member Functions
virtual const void *	GetData ()=0
virtual FTimespan	GetDuration () const =0
virtual uint32	GetSize () const =0
virtual FMediaTimeStamp	GetTime () const =0
virtual TOptional< FTimecode >	GetTimecode () const
virtual FGuid	GetGUID () const
virtual	~IMediaBinarySample ()

Detailed Description

Interface for media binary data samples.

Constructor & Destructor Documentation

~IMediaBinarySample()

virtual IMediaBinarySample::~IMediaBinarySample ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

GetData()

virtual const void * IMediaBinarySample::GetData ( )

pure virtual

Get the sample data.

Returns

Pointer to data buffer.

See also

GetDuration, GetSize, GetTime

GetDuration()

virtual FTimespan IMediaBinarySample::GetDuration ( ) const

pure virtual

Get the amount of time for which the sample is valid.

A duration of zero indicates that the sample is valid until the timecode of the next sample in the queue.

Returns

Sample duration.

See also

GetData, GetSize, GetTime

GetGUID()

virtual FGuid IMediaBinarySample::GetGUID ( ) const

inlinevirtual

Get the GUID identifying the derived type that may implement additional, type specific methods. If the GUID matches a type known type it is safe to static cast this class to the derived type. This is usually done to identify the format of the binary data carried here.

GetSize()

virtual uint32 IMediaBinarySample::GetSize ( ) const

pure virtual

Get the size of the binary data.

See also

GetData, GetDuration, GetTime

GetTime()

virtual FMediaTimeStamp IMediaBinarySample::GetTime ( ) const

pure virtual

Get the sample time (in the player's local clock).

This value is used primarily for debugging purposes.

Returns

Sample time.

See also

GetData, GetDuration, GetSize, GetTime

GetTimecode()

virtual TOptional< FTimecode > IMediaBinarySample::GetTimecode ( ) const

inlinevirtual

Get the sample timecode if available.

Returns

Sample timecode.

See also

GetTime

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Media/Public/IMediaBinarySample.h