ttv::broadcast::WinAudioCapture Class Reference

#include <winaudiocapture.h>

Inheritance diagram for ttv::broadcast::WinAudioCapture:

Public Types
enum	CaptureType { CaptureType::System, CaptureType::Microphone }

Public Member Functions
	WinAudioCapture (CaptureType type)
virtual	~WinAudioCapture ()
virtual std::string	GetName () const override
virtual uint32_t	GetNumChannels () const override
virtual TTV_ErrorCode	Start () override
virtual TTV_ErrorCode	Stop () override
virtual TTV_ErrorCode	Process (const std::shared_ptr< IAudioMixer > &mixer, uint64_t &lastSampleTime) 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	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 Member Functions
TTV_ErrorCode	SubmitSamples (void *samples, size_t sampleCount, uint64_t timestamp)

Private Attributes
std::unique_ptr< WinAudioCaptureInternalData >	mInternalData

Detailed Description

An IAudioCapture implementation that can capture both system audio and microphone audio from Windows.

Member Enumeration Documentation

CaptureType

enum ttv::broadcast::WinAudioCapture::CaptureType

strong

Enumerator
System
Microphone

Constructor & Destructor Documentation

WinAudioCapture()

ttv::broadcast::WinAudioCapture::WinAudioCapture

(

CaptureType

type

)

~WinAudioCapture()

virtual ttv::broadcast::WinAudioCapture::~WinAudioCapture ( )

virtual

Member Function Documentation

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::WinAudioCapture::GetName ( ) const

overridevirtual

Retrieves the name for logging purposes.

Implements ttv::broadcast::IAudioCapture.

GetNumChannels()

virtual uint32_t ttv::broadcast::WinAudioCapture::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::WinAudioCapture::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

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.

Shutdown()

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

overridevirtualinherited

Implements ttv::broadcast::IAudioCapture.

Start()

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

overridevirtual

Reimplemented from ttv::broadcast::AudioCaptureBase.

Stop()

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

overridevirtual

Reimplemented from ttv::broadcast::AudioCaptureBase.

SubmitSamples()

TTV_ErrorCode ttv::broadcast::WinAudioCapture::SubmitSamples ( void *  samples, size_t  sampleCount, uint64_t  timestamp  )

private

SystemTimeToSamples()

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

staticinherited

Member Data Documentation

mAudioLayer

AudioLayerId ttv::broadcast::AudioCaptureBase::mAudioLayer

protectedinherited

mAudioMixer

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

protectedinherited

mInitialized

bool ttv::broadcast::AudioCaptureBase::mInitialized

protectedinherited

mInitialSysTime

uint64_t ttv::broadcast::AudioCaptureBase::mInitialSysTime

protectedinherited

mInternalData

std::unique_ptr<WinAudioCaptureInternalData> ttv::broadcast::WinAudioCapture::mInternalData

private

mMuted

bool ttv::broadcast::AudioCaptureBase::mMuted

protectedinherited

mStarted

bool ttv::broadcast::AudioCaptureBase::mStarted

protectedinherited

---

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

• modules/broadcast/broadcast_win32/include/twitchsdk/broadcast/winaudiocapture.h