FMediaIOCoreAudioSampleBase

Implements a media audio sample.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMediaAudioSample

IMediaPoolable

FMediaIOCoreAudioSampleBase

References

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

Syntax

class FMediaIOCoreAudioSampleBase :
public IMediaAudioSample,
public IMediaPoolable

Remarks

Implements a media audio sample.

Variables

	Name	Description
TArray< int32 >	Buffer	The sample's frame buffer.
uint32	Channels	Number of audio channels.
FTimespan	Duration	The duration for which the sample is valid.
uint32	SampleRate	Audio sample rate (in samples per second).
FTimespan	Time	Sample time.
TOptional< FTim...	Timecode	Sample timecode.

Constructors

	Name	Description
	FMediaIOCoreAudioSampleBase()	Default constructor.

Functions

	Name	Description
void	FreeSample()
bool	Initialize ( TArray< int32 > InAudioBuffer, uint32 InNumberOfChannels, uint32 InSampleRate, FTimespan InTime, const TOptional< FTimecode >& InTi... )	Initialize the sample.
bool	Initialize ( const int32* InAudioBuffer, uint32 InBufferSize, uint32 InNumberOfChannels, uint32 InSampleRate, FTimespan InTime, const TOptional< FTimecode >& InTi... )	Initialize the sample.
void *	RequestBuffer ( uint32 InBufferSize )	Request an uninitialized sample buffer.
bool	SetBuffer ( TArray< int32 > InAudioBuffer )	Set the sample buffer.
bool	SetBuffer ( const int32* InAudioBuffer, uint32 InBufferSize )	Set the sample buffer.
bool	SetProperties ( uint32 InBufferSize, uint32 InNumberOfChannels, uint32 InSampleRate, FTimespan InTime, const TOptional< FTimecode >& InTi... )	Set the sample properties.

Overridden from IMediaAudioSample

	Name	Description
const void &...	GetBuffer()	Get the sample data. The returned buffer is only valid for the life time of this sample.
uint32	GetChannels()	Get the sample's number of channels.
FTimespan	GetDuration()	Get the amount of time for which the sample is valid.
EMediaAudioS...	GetFormat()	Get the audio sample format.
uint32	GetFrames()	Get the number of frames in the buffer. A frame consists of one sample value per channel.
uint32	GetSampleRate()	Get the sample's sampling rate (in audio frames per second).
FMediaTimeSt...	GetTime()	Get the sample time (in the player's local clock).
TOptional< F...	GetTimecode()	Get the sample timecode if available.

Overridden from IMediaPoolable

		Name	Description
	void	ShutdownPoolable()	Called when the object added to the pool.