IVoiceDecoder Class Reference

#include <VoiceCodec.h>

Inheritance diagram for IVoiceDecoder:

Public Member Functions
virtual	~IVoiceDecoder ()
virtual bool	Init (int32 SampleRate, int32 NumChannels)=0
virtual void	Decode (const uint8 *CompressedData, uint32 CompressedDataSize, uint8 *OutRawPCMData, uint32 &OutRawDataSize)=0
virtual void	Reset ()=0
virtual void	Destroy ()=0
virtual void	DumpState () const =0
Public Member Functions inherited from TSharedFromThis< IVoiceDecoder >
TSharedRef< IVoiceDecoder, Mode >	AsShared ()
TSharedRef< IVoiceDecoder const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< IVoiceDecoder, Mode >	AsWeak ()
TWeakPtr< IVoiceDecoder const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Protected Member Functions
	IVoiceDecoder ()
Protected Member Functions inherited from TSharedFromThis< IVoiceDecoder >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< IVoiceDecoder >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Interface for decoding voice passed over the wire

Constructor & Destructor Documentation

IVoiceDecoder()

IVoiceDecoder::IVoiceDecoder ( )

inlineprotected

~IVoiceDecoder()

virtual IVoiceDecoder::~IVoiceDecoder ( )

inlinevirtual

Member Function Documentation

Decode()

virtual void IVoiceDecoder::Decode ( const uint8 *  CompressedData, uint32  CompressedDataSize, uint8 *  OutRawPCMData, uint32 &  OutRawDataSize  )

pure virtual

Decode an encoded audio stream (outputs 16bit PCM audio)

Parameters

CompressedData	encoded/compressed audio stream
CompressedDataSize	amount of data in the buffer
OutRawPCMData	buffer to contain the decoded raw PCM data
OutRawDataSize	[in/out] amount of buffer used for the decoded raw PCM data

Destroy()

virtual void IVoiceDecoder::Destroy ( )

pure virtual

Cleanup the decoder

DumpState()

virtual void IVoiceDecoder::DumpState ( ) const

pure virtual

Output the state of the decoder

Init()

virtual bool IVoiceDecoder::Init ( int32  SampleRate, int32  NumChannels  )

pure virtual

Initialize the decoder

Parameters

SampleRate	requested sample rate of the decoding (may be up sampled depending on the source data)
NumChannel	number of channels in the output decoded stream (mono streams can encode to stereo)

Returns

true if initialization was successful, false otherwise

Reset()

virtual void IVoiceDecoder::Reset ( )

pure virtual

Reset the decoder back to its initial state

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Online/Voice/Public/Interfaces/VoiceCodec.h