ttv::broadcast::PassThroughAudioCapture Class Reference

#include <passthroughaudiocapture.h>

Inheritance diagram for ttv::broadcast::PassThroughAudioCapture:

Classes
struct	QueueEntry

Public Member Functions
	PassThroughAudioCapture ()
virtual	~PassThroughAudioCapture ()
TTV_ErrorCode	SetAudioFormat (AudioFormat format)
TTV_ErrorCode	SetNumChannels (uint32_t numChannels)
TTV_ErrorCode	EnqueueAudioPacket (std::vector< uint8_t > &&videoPacket, uint64_t timestamp)
virtual std::string	GetName () const override
virtual uint32_t	GetNumChannels () const override
virtual TTV_ErrorCode	Process (const std::shared_ptr< IAudioMixer > &mixer, uint64_t &lastSampleTime) override
virtual TTV_ErrorCode	Stop () override
virtual void	SetAudioMixer (const std::shared_ptr< IAudioMixer > &mixer) override
virtual bool	GetMuted () const override
virtual void	SetMuted (bool muted) override
virtual void	SetAudioLayer (AudioLayerId layer) override
virtual AudioLayerId	GetAudioLayer () const override
virtual void	SetInitialTime (uint64_t initialTime) override
virtual TTV_ErrorCode	Initialize () override
virtual TTV_ErrorCode	Start () override
virtual TTV_ErrorCode	Shutdown () override

Static Public Member Functions
static uint64_t	SamplesToSystemTime (uint64_t samples, uint32_t sampleRate)
static uint64_t	SystemTimeToSamples (uint64_t time, uint32_t sampleRate)

Protected Attributes
std::shared_ptr< IAudioMixer >	mAudioMixer
AudioLayerId	mAudioLayer
uint64_t	mInitialSysTime
bool	mMuted
bool	mInitialized
bool	mStarted

Private Attributes
ConcurrentQueue< std::shared_ptr< QueueEntry > >	mAudioPacketQueue
AudioFormat	mAudioFormat
uint32_t	mNumChannels

---

Class Documentation

ttv::broadcast::PassThroughAudioCapture::QueueEntry

struct ttv::broadcast::PassThroughAudioCapture::QueueEntry

Class Members
vector< uint8_t >	packet
uint64_t	timestamp

Constructor & Destructor Documentation

PassThroughAudioCapture()

ttv::broadcast::PassThroughAudioCapture::PassThroughAudioCapture

(

)

~PassThroughAudioCapture()

virtual ttv::broadcast::PassThroughAudioCapture::~PassThroughAudioCapture ( )

virtual

Member Function Documentation

EnqueueAudioPacket()

TTV_ErrorCode ttv::broadcast::PassThroughAudioCapture::EnqueueAudioPacket	(	std::vector< uint8_t > &&	videoPacket,
		uint64_t	timestamp
	)

GetAudioLayer()

virtual AudioLayerId ttv::broadcast::AudioCaptureBase::GetAudioLayer ( ) const

overridevirtualinherited

Implements ttv::broadcast::IAudioCapture.

GetMuted()

virtual bool ttv::broadcast::AudioCaptureBase::GetMuted ( ) const

overridevirtualinherited

Retrieves the current muted state.

Implements ttv::broadcast::IAudioCapture.

GetName()

virtual std::string ttv::broadcast::PassThroughAudioCapture::GetName ( ) const

overridevirtual

Retrieves the name for logging purposes.

Implements ttv::broadcast::IAudioCapture.

GetNumChannels()

virtual uint32_t ttv::broadcast::PassThroughAudioCapture::GetNumChannels ( ) const

overridevirtual

Retrieves the number of channels captured.

Implements ttv::broadcast::IAudioCapture.

Initialize()

virtual TTV_ErrorCode ttv::broadcast::AudioCaptureBase::Initialize ( )

overridevirtualinherited

Implements ttv::broadcast::IAudioCapture.

Process()

virtual TTV_ErrorCode ttv::broadcast::PassThroughAudioCapture::Process ( const std::shared_ptr< IAudioMixer > &  mixer, uint64_t &  lastSampleTime  )

overridevirtual

Implements ttv::broadcast::IAudioCapture.

SamplesToSystemTime()

static uint64_t ttv::broadcast::AudioCaptureBase::SamplesToSystemTime ( uint64_t  samples, uint32_t  sampleRate  )

staticinherited

SetAudioFormat()

TTV_ErrorCode ttv::broadcast::PassThroughAudioCapture::SetAudioFormat

(

AudioFormat

format

)

SetAudioLayer()

virtual void ttv::broadcast::AudioCaptureBase::SetAudioLayer ( AudioLayerId  layer )

overridevirtualinherited

Implements ttv::broadcast::IAudioCapture.

SetAudioMixer()

virtual void ttv::broadcast::AudioCaptureBase::SetAudioMixer ( const std::shared_ptr< IAudioMixer > &  mixer )

overridevirtualinherited

Implements ttv::broadcast::IAudioCapture.

SetInitialTime()

virtual void ttv::broadcast::AudioCaptureBase::SetInitialTime ( uint64_t  initialTime )

overridevirtualinherited

This is call once upon starting capture so there is a relative timestamp to work off of. This is used to pace the capture.

Implements ttv::broadcast::IAudioCapture.

Reimplemented in ttv::broadcast::AppleAudioCapture.

SetMuted()

virtual void ttv::broadcast::AudioCaptureBase::SetMuted ( bool  muted )

overridevirtualinherited

Sets the current muted state. The capturer should track this flag so it can be returned from GetMuted() but it can also optionally pause capturing when muted if desired. Silence should still be written as if there were real audio available.

Implements ttv::broadcast::IAudioCapture.

SetNumChannels()

TTV_ErrorCode ttv::broadcast::PassThroughAudioCapture::SetNumChannels

(

uint32_t

numChannels

)

Shutdown()

virtual TTV_ErrorCode ttv::broadcast::AudioCaptureBase::Shutdown ( )

overridevirtualinherited

Implements ttv::broadcast::IAudioCapture.

Start()

virtual TTV_ErrorCode ttv::broadcast::AudioCaptureBase::Start ( )

overridevirtualinherited

Implements ttv::broadcast::IAudioCapture.

Reimplemented in ttv::broadcast::WinAudioCapture, and ttv::broadcast::AppleAudioCapture.

Stop()

virtual TTV_ErrorCode ttv::broadcast::PassThroughAudioCapture::Stop ( )

overridevirtual

Reimplemented from ttv::broadcast::AudioCaptureBase.

SystemTimeToSamples()

static uint64_t ttv::broadcast::AudioCaptureBase::SystemTimeToSamples ( uint64_t  time, uint32_t  sampleRate  )

staticinherited

Member Data Documentation

mAudioFormat

AudioFormat ttv::broadcast::PassThroughAudioCapture::mAudioFormat

private

mAudioLayer

AudioLayerId ttv::broadcast::AudioCaptureBase::mAudioLayer

protectedinherited

mAudioMixer

std::shared_ptr<IAudioMixer> ttv::broadcast::AudioCaptureBase::mAudioMixer

protectedinherited

mAudioPacketQueue

ConcurrentQueue<std::shared_ptr<QueueEntry> > ttv::broadcast::PassThroughAudioCapture::mAudioPacketQueue

private

mInitialized

bool ttv::broadcast::AudioCaptureBase::mInitialized

protectedinherited

mInitialSysTime

uint64_t ttv::broadcast::AudioCaptureBase::mInitialSysTime

protectedinherited

mMuted

bool ttv::broadcast::AudioCaptureBase::mMuted

protectedinherited

mNumChannels

uint32_t ttv::broadcast::PassThroughAudioCapture::mNumChannels

private

mStarted

bool ttv::broadcast::AudioCaptureBase::mStarted

protectedinherited

---

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

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