ttv::broadcast::PcmAudioFrame Class Reference

#include <pcmaudioframe.h>

Inheritance diagram for ttv::broadcast::PcmAudioFrame:

Public Types
typedef std::function< void()>	UnlockFunc

Public Member Functions
	PcmAudioFrame (const uint8_t *sampleBuffer, uint32_t numSamplesPerChannel, uint32_t numChannels, bool interleaved, AudioSampleFormat audioSampleFormat, uint64_t timeStamp)
const std::vector< uint8_t > &	GetSampleBuffer () const
AudioSampleFormat	GetAudioSampleFormat () const
uint32_t	GetNumSamplesPerChannel () const
bool	GetInterleaved () const
void	SetTimeStamp (uint64_t timeStamp)
uint64_t	GetTimeStamp () const
void	SetAudioFormat (AudioFormat format)
AudioFormat	GetAudioFormat () const
void	SetNumChannels (uint32_t numChannels)
uint32_t	GetNumChannels () const
void	SetSampleRateHz (uint32_t rate)
uint32_t	GetSampleRateHz () const
IAudioFrameReceiver::ReceiverTypeId	GetReceiverTypeId () const

Protected Member Functions
void	SetUnlockCallback (UnlockFunc callback)

Private Attributes
std::vector< uint8_t >	mSampleBuffer
AudioSampleFormat	mAudioSampleFormat
uint32_t	mNumSamplesPerChannel
bool	mInterleaved

Member Typedef Documentation

UnlockFunc

typedef std::function<void()> ttv::broadcast::AudioFrame::UnlockFunc

inherited

Constructor & Destructor Documentation

PcmAudioFrame()

ttv::broadcast::PcmAudioFrame::PcmAudioFrame	(	const uint8_t *	sampleBuffer,
		uint32_t	numSamplesPerChannel,
		uint32_t	numChannels,
		bool	interleaved,
		AudioSampleFormat	audioSampleFormat,
		uint64_t	timeStamp
	)

Member Function Documentation

GetAudioFormat()

AudioFormat ttv::broadcast::AudioFrame::GetAudioFormat ( ) const

inlineinherited

GetAudioSampleFormat()

AudioSampleFormat ttv::broadcast::PcmAudioFrame::GetAudioSampleFormat ( ) const

inline

GetInterleaved()

bool ttv::broadcast::PcmAudioFrame::GetInterleaved ( ) const

inline

GetNumChannels()

uint32_t ttv::broadcast::AudioFrame::GetNumChannels ( ) const

inlineinherited

GetNumSamplesPerChannel()

uint32_t ttv::broadcast::PcmAudioFrame::GetNumSamplesPerChannel ( ) const

inline

GetReceiverTypeId()

IAudioFrameReceiver::ReceiverTypeId ttv::broadcast::AudioFrame::GetReceiverTypeId ( ) const

inlineinherited

Returns the type id of the receiver that packaged the AudioFrame.

GetSampleBuffer()

const std::vector<uint8_t>& ttv::broadcast::PcmAudioFrame::GetSampleBuffer ( ) const

inline

GetSampleRateHz()

uint32_t ttv::broadcast::AudioFrame::GetSampleRateHz ( ) const

inlineinherited

GetTimeStamp()

uint64_t ttv::broadcast::AudioFrame::GetTimeStamp ( ) const

inlineinherited

SetAudioFormat()

void ttv::broadcast::AudioFrame::SetAudioFormat ( AudioFormat  format )

inlineinherited

SetNumChannels()

void ttv::broadcast::AudioFrame::SetNumChannels ( uint32_t  numChannels )

inlineinherited

SetSampleRateHz()

void ttv::broadcast::AudioFrame::SetSampleRateHz ( uint32_t  rate )

inlineinherited

SetTimeStamp()

void ttv::broadcast::AudioFrame::SetTimeStamp ( uint64_t  timeStamp )

inlineinherited

SetUnlockCallback()

void ttv::broadcast::AudioFrame::SetUnlockCallback ( UnlockFunc  callback )

inlineprotectedinherited

Member Data Documentation

mAudioSampleFormat

AudioSampleFormat ttv::broadcast::PcmAudioFrame::mAudioSampleFormat

private

mInterleaved

bool ttv::broadcast::PcmAudioFrame::mInterleaved

private

mNumSamplesPerChannel

uint32_t ttv::broadcast::PcmAudioFrame::mNumSamplesPerChannel

private

mSampleBuffer

std::vector<uint8_t> ttv::broadcast::PcmAudioFrame::mSampleBuffer

private

---

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

• modules/broadcast/broadcast_common/include/twitchsdk/broadcast/internal/pcmaudioframe.h