1. Epic GamesDeveloper
  3. FMediaIOCoreAudioSampleBase

FMediaIOCoreAudioSampleBase

Implements a media audio sample.

Unreal Engine C++ API Reference > Plugins > MediaIOCore

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function   Default constructor.

Functions

  Type Name Description
Protected function Virtual void  
Public function bool

Initialize ( TArray< int32 > InAudioBuffer,
uint32 InNumberOfChannels,
uint32 InSampleRate,
FTimespan InTime,
const TOptional< FTimecode >& InTimecode
)

 Initialize the sample.
Public function bool

Initialize ( const int32* InAudioBuffer,
uint32 InBufferSize,
uint32 InNumberOfChannels,
uint32 InSampleRate,
FTimespan InTime,
const TOptional< FTimecode >& InTimecode
)

 Initialize the sample.
Public function Virtual void *

RequestBuffer ( uint32 InBufferSize
)

 Request an uninitialized sample buffer.
Public function bool

SetBuffer ( TArray< int32 > InAudioBuffer
)

 Set the sample buffer.
Public function bool

SetBuffer ( const int32* InAudioBuffer,
uint32 InBufferSize
)

 Set the sample buffer.
Public function bool

SetProperties ( uint32 InBufferSize,
uint32 InNumberOfChannels,
uint32 InSampleRate,
FTimespan InTime,
const TOptional< FTimecode >& InTimecode
)

 Set the sample properties.

Overridden from IMediaAudioSample

  Type Name Description
Public function Virtual const void * Get the sample data.The returned buffer is only valid for the life time of this sample.
Public function Virtual Const uint32 Get the sample's number of channels.
Public function Virtual Const FTimespan Get the amount of time for which the sample is valid.
Public function Virtual Const EMediaAudioSampleFormat Get the audio sample format.
Public function Virtual Const uint32 Get the number of frames in the buffer.A frame consists of one sample value per channel.
Public function Virtual Const uint32 Get the sample's sampling rate (in audio frames per second).
Public function Virtual Const FMediaTimeStamp

GetTime ()

 Get the sample time (in the player's local clock).
Public function Virtual Const TOptional< FTimecode > Get the sample timecode if available.

Overridden from IMediaPoolable

  Type Name Description
Public function Virtual void Called when the object added to the pool.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page