ttv::broadcast::AudioFrame Class Reference

#include <audioframe.h>

Inheritance diagram for ttv::broadcast::AudioFrame:

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

Public Member Functions
virtual	~AudioFrame ()
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
	AudioFrame (IAudioFrameReceiver::ReceiverTypeId receiverTypeId)
void	SetUnlockCallback (UnlockFunc callback)

Private Attributes
UnlockFunc	mUnlockCallback
IAudioFrameReceiver::ReceiverTypeId	mReceiverTypeId
AudioFormat	mAudioFormat
uint64_t	mTimeStamp
uint32_t	mNumChannels
uint32_t	mSampleRateHz

Detailed Description

The container for audio data to be encoded. This class will be extended to hold implementation-specific data.

Member Typedef Documentation

UnlockFunc

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

Constructor & Destructor Documentation

~AudioFrame()

virtual ttv::broadcast::AudioFrame::~AudioFrame ( )

virtual

AudioFrame()

ttv::broadcast::AudioFrame::AudioFrame ( IAudioFrameReceiver::ReceiverTypeId  receiverTypeId )

protected

Member Function Documentation

GetAudioFormat()

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

inline

GetNumChannels()

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

inline

GetReceiverTypeId()

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

inline

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

GetSampleRateHz()

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

inline

GetTimeStamp()

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

inline

SetAudioFormat()

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

inline

SetNumChannels()

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

inline

SetSampleRateHz()

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

inline

SetTimeStamp()

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

inline

SetUnlockCallback()

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

inlineprotected

Member Data Documentation

mAudioFormat

AudioFormat ttv::broadcast::AudioFrame::mAudioFormat

private

mNumChannels

uint32_t ttv::broadcast::AudioFrame::mNumChannels

private

mReceiverTypeId

IAudioFrameReceiver::ReceiverTypeId ttv::broadcast::AudioFrame::mReceiverTypeId

private

mSampleRateHz

uint32_t ttv::broadcast::AudioFrame::mSampleRateHz

private

mTimeStamp

uint64_t ttv::broadcast::AudioFrame::mTimeStamp

private

mUnlockCallback

UnlockFunc ttv::broadcast::AudioFrame::mUnlockCallback

private

---

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

• modules/broadcast/broadcast_common/include/twitchsdk/broadcast/audioframe.h