Navigation
API > API/Runtime > API/Runtime/Media
Interface for media audio samples.
| Name | IMediaAudioSample |
| Type | class |
| Header File | /Engine/Source/Runtime/Media/Public/IMediaAudioSample.h |
| Include Path | #include "IMediaAudioSample.h" |
Syntax
class IMediaAudioSample
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMediaAudioSample() |
Virtual destructor. | IMediaAudioSample.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const void * GetBuffer () |
Get the sample data.The returned buffer is only valid for the life time of this sample. | IMediaAudioSample.h | |
uint32 GetChannels () |
Get the sample's number of channels. | IMediaAudioSample.h | |
| Get the amount of time for which the sample is valid. | IMediaAudioSample.h | ||
| Get the audio sample format. | IMediaAudioSample.h | ||
uint32 GetFrames () |
Get the number of frames in the buffer.A frame consists of one sample value per channel. | IMediaAudioSample.h | |
uint32 GetSampleRate () |
Get the sample's sampling rate (in audio frames per second). | IMediaAudioSample.h | |
| Get the sample time (in the player's local clock). | IMediaAudioSample.h | ||
virtual TOptional< FTimecode > GetTimecode () |
Get the sample timecode if available. | IMediaAudioSample.h |