FMediaIOCoreBinarySampleBase

Implements a media binary data sample for AjaMedia.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMediaBinarySample

IMediaPoolable

FMediaIOCoreBinarySampleBase

References

Module

MediaIOCore

Header

/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCoreBinarySampleBase.h

Include

#include "MediaIOCoreBinarySampleBase.h"

Syntax

class FMediaIOCoreBinarySampleBase :
    public IMediaBinarySample,
    public IMediaPoolable

Remarks

Implements a media binary data sample for AjaMedia.

Variables

Name Description

Protected variable

TArray< uint8 >

 

Buffer

The sample's frame buffer.

Protected variable

FTimespan

 

Duration

Duration for which the sample is valid.

Protected variable

FTimespan

 

Time

Sample time.

Protected variable

TOptional< FTim...

 

Timecode

Sample timecode.

Constructors

Name Description

Public function

FMediaIOCoreBinarySampleBase()

Default constructor.

Functions

Name Description

Protected function Virtual

void

 

FreeSample()

Public function

bool

 

Initialize

(
    TArray< uint8 > InBinaryBuffer,
    FTimespan InTime,
    const FFrameRate& InFrameRate,
    const TOptional< FTimecode >& InTi...
)

Initialize the sample.

Public function

bool

 

Initialize

(
    const uint8* InBinaryBuffer,
    uint32 InBufferSize,
    FTimespan InTime,
    const FFrameRate& InFrameRate,
    const TOptional< FTimecode >& InTi...
)

Initialize the sample.

Public function Virtual

void *

 

RequestBuffer

(
    uint32 InBufferSize
)

Request an uninitialized sample buffer.

Public function

bool

 

SetBuffer

(
    TArray< uint8 > InBinaryBuffer
)

Set the sample buffer.

Public function

bool

 

SetBuffer

(
    const uint8* InBinaryBuffer,
    uint32 InBufferSize
)

Set the sample buffer.

Public function

bool

 

SetProperties

(
    FTimespan InTime,
    const FFrameRate& InFrameRate,
    const TOptional< FTimecode >& InTi...
)

Set the sample properties.

Overridden from IMediaBinarySample

Name Description

Public function Virtual

const void &...

 

GetData()

Get the sample data.

Public function Virtual Const

FTimespan

 

GetDuration()

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

Public function Virtual Const

uint32

 

GetSize()

Get the size of the binary data.

Public function Virtual Const

FMediaTimeSt...

 

GetTime()

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

Public function Virtual Const

TOptional< F...

 

GetTimecode()

Get the sample timecode if available.

Overridden from IMediaPoolable

Name Description

Public function Virtual

void

 

ShutdownPoolable()

Called when the object added to the pool.