IMediaAudioSample

Interface for media audio samples.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Media

Header

/Engine/Source/Runtime/Media/Public/IMediaAudioSample.h

Include

#include "IMediaAudioSample.h"

Syntax

class IMediaAudioSample

Remarks

Interface for media audio samples.

Destructors

Name Description

Public function Virtual

~IMediaAudioSample()

Virtual destructor.

Functions

Name Description

Public function

const void &...

 

GetBuffer()

Get the sample data.

The returned buffer is only valid for the life time of this sample.

Public function Const

uint32

 

GetChannels()

Get the sample's number of channels.

Public function Const

FTimespan

 

GetDuration()

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

Public function Const

EMediaAudioS...

 

GetFormat()

Get the audio sample format.

Public function Const

uint32

 

GetFrames()

Get the number of frames in the buffer.

A frame consists of one sample value per channel.

Public function Const

uint32

 

GetSampleRate()

Get the sample's sampling rate (in audio frames per second).

Public function 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.