webrtc::DesktopCapturer Class Reference

#include <desktop_capturer.h>

Inheritance diagram for webrtc::DesktopCapturer:

Classes
class	Callback
struct	Source

Public Types
enum	Result {   Result::SUCCESS, Result::ERROR_TEMPORARY, Result::ERROR_PERMANENT, Result::MAX_VALUE = ERROR_PERMANENT,   Result::SUCCESS, Result::ERROR_TEMPORARY, Result::ERROR_PERMANENT, Result::MAX_VALUE = ERROR_PERMANENT }
enum	Result {   Result::SUCCESS, Result::ERROR_TEMPORARY, Result::ERROR_PERMANENT, Result::MAX_VALUE = ERROR_PERMANENT,   Result::SUCCESS, Result::ERROR_TEMPORARY, Result::ERROR_PERMANENT, Result::MAX_VALUE = ERROR_PERMANENT }
typedef intptr_t	SourceId
typedef std::vector< Source >	SourceList
typedef intptr_t	SourceId
typedef std::vector< Source >	SourceList

Public Member Functions
virtual	~DesktopCapturer ()
virtual void	Start (Callback *callback)=0
virtual void	SetSharedMemoryFactory (std::unique_ptr< SharedMemoryFactory > shared_memory_factory)
virtual void	CaptureFrame ()=0
virtual void	SetExcludedWindow (WindowId window)
virtual bool	GetSourceList (SourceList *sources)
virtual bool	SelectSource (SourceId id)
virtual bool	FocusOnSelectedSource ()
virtual	~DesktopCapturer ()
virtual void	Start (Callback *callback)=0
virtual void	SetSharedMemoryFactory (std::unique_ptr< SharedMemoryFactory > shared_memory_factory)
virtual void	CaptureFrame ()=0
virtual void	SetExcludedWindow (WindowId window)
virtual bool	GetSourceList (SourceList *sources)
virtual bool	SelectSource (SourceId id)
virtual bool	FocusOnSelectedSource ()

Static Public Member Functions
static std::unique_ptr< DesktopCapturer >	CreateWindowCapturer (const DesktopCaptureOptions &options)
static std::unique_ptr< DesktopCapturer >	CreateScreenCapturer (const DesktopCaptureOptions &options)
static std::unique_ptr< DesktopCapturer >	CreateWindowCapturer (const DesktopCaptureOptions &options)
static std::unique_ptr< DesktopCapturer >	CreateScreenCapturer (const DesktopCaptureOptions &options)

Static Protected Member Functions
static std::unique_ptr< DesktopCapturer >	CreateRawWindowCapturer (const DesktopCaptureOptions &options)
static std::unique_ptr< DesktopCapturer >	CreateRawScreenCapturer (const DesktopCaptureOptions &options)
static std::unique_ptr< DesktopCapturer >	CreateRawWindowCapturer (const DesktopCaptureOptions &options)
static std::unique_ptr< DesktopCapturer >	CreateRawScreenCapturer (const DesktopCaptureOptions &options)

Member Typedef Documentation

SourceId [1/2]

typedef intptr_t webrtc::DesktopCapturer::SourceId

SourceId [2/2]

typedef intptr_t webrtc::DesktopCapturer::SourceId

SourceList [1/2]

typedef std::vector<Source> webrtc::DesktopCapturer::SourceList

SourceList [2/2]

typedef std::vector<Source> webrtc::DesktopCapturer::SourceList

Member Enumeration Documentation

Result [1/2]

enum webrtc::DesktopCapturer::Result

strong

Enumerator
SUCCESS
ERROR_TEMPORARY
ERROR_PERMANENT
MAX_VALUE
SUCCESS
ERROR_TEMPORARY
ERROR_PERMANENT
MAX_VALUE

Result [2/2]

enum webrtc::DesktopCapturer::Result

strong

Enumerator
SUCCESS
ERROR_TEMPORARY
ERROR_PERMANENT
MAX_VALUE
SUCCESS
ERROR_TEMPORARY
ERROR_PERMANENT
MAX_VALUE

Constructor & Destructor Documentation

~DesktopCapturer() [1/2]

webrtc::DesktopCapturer::~DesktopCapturer ( )

virtualdefault

~DesktopCapturer() [2/2]

virtual webrtc::DesktopCapturer::~DesktopCapturer ( )

virtual

Member Function Documentation

CaptureFrame() [1/2]

virtual void webrtc::DesktopCapturer::CaptureFrame ( )

pure virtual

Implemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::ScreenCapturerWinGdi, webrtc::ScreenCapturerWinGdi, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

CaptureFrame() [2/2]

virtual void webrtc::DesktopCapturer::CaptureFrame ( )

pure virtual

Implemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::ScreenCapturerWinGdi, webrtc::ScreenCapturerWinGdi, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

CreateRawScreenCapturer() [1/2]

std::unique_ptr< DesktopCapturer > webrtc::DesktopCapturer::CreateRawScreenCapturer ( const DesktopCaptureOptions &  options )

staticprotected

CreateRawScreenCapturer() [2/2]

static std::unique_ptr<DesktopCapturer> webrtc::DesktopCapturer::CreateRawScreenCapturer ( const DesktopCaptureOptions &  options )

staticprotected

CreateRawWindowCapturer() [1/2]

static std::unique_ptr<DesktopCapturer> webrtc::DesktopCapturer::CreateRawWindowCapturer ( const DesktopCaptureOptions &  options )

staticprotected

CreateRawWindowCapturer() [2/2]

std::unique_ptr< DesktopCapturer > webrtc::DesktopCapturer::CreateRawWindowCapturer ( const DesktopCaptureOptions &  options )

staticprotected

CreateScreenCapturer() [1/2]

static std::unique_ptr<DesktopCapturer> webrtc::DesktopCapturer::CreateScreenCapturer ( const DesktopCaptureOptions &  options )

static

CreateScreenCapturer() [2/2]

std::unique_ptr< DesktopCapturer > webrtc::DesktopCapturer::CreateScreenCapturer ( const DesktopCaptureOptions &  options )

static

CreateWindowCapturer() [1/2]

std::unique_ptr< DesktopCapturer > webrtc::DesktopCapturer::CreateWindowCapturer ( const DesktopCaptureOptions &  options )

static

CreateWindowCapturer() [2/2]

static std::unique_ptr<DesktopCapturer> webrtc::DesktopCapturer::CreateWindowCapturer ( const DesktopCaptureOptions &  options )

static

FocusOnSelectedSource() [1/2]

virtual bool webrtc::DesktopCapturer::FocusOnSelectedSource ( )

virtual

Reimplemented in webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

FocusOnSelectedSource() [2/2]

bool webrtc::DesktopCapturer::FocusOnSelectedSource ( )

virtual

Reimplemented in webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

GetSourceList() [1/2]

virtual bool webrtc::DesktopCapturer::GetSourceList ( SourceList *  sources )

virtual

Reimplemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::ScreenCapturerWinGdi, webrtc::ScreenCapturerWinGdi, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

GetSourceList() [2/2]

bool webrtc::DesktopCapturer::GetSourceList ( SourceList *  sources )

virtual

Reimplemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::ScreenCapturerWinGdi, webrtc::ScreenCapturerWinGdi, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

SelectSource() [1/2]

virtual bool webrtc::DesktopCapturer::SelectSource ( SourceId  id )

virtual

Reimplemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, and webrtc::FallbackDesktopCapturerWrapper.

SelectSource() [2/2]

bool webrtc::DesktopCapturer::SelectSource ( SourceId  id )

virtual

Reimplemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, and webrtc::FallbackDesktopCapturerWrapper.

SetExcludedWindow() [1/2]

virtual void webrtc::DesktopCapturer::SetExcludedWindow ( WindowId  window )

virtual

Reimplemented in webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

SetExcludedWindow() [2/2]

void webrtc::DesktopCapturer::SetExcludedWindow ( WindowId  window )

virtual

Reimplemented in webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

SetSharedMemoryFactory() [1/2]

virtual void webrtc::DesktopCapturer::SetSharedMemoryFactory ( std::unique_ptr< SharedMemoryFactory >  shared_memory_factory )

virtual

Reimplemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::ScreenCapturerWinGdi, webrtc::ScreenCapturerWinGdi, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

SetSharedMemoryFactory() [2/2]

void webrtc::DesktopCapturer::SetSharedMemoryFactory ( std::unique_ptr< SharedMemoryFactory >  shared_memory_factory )

virtual

Reimplemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::ScreenCapturerWinGdi, webrtc::ScreenCapturerWinGdi, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

Start() [1/2]

virtual void webrtc::DesktopCapturer::Start ( Callback *  callback )

pure virtual

Implemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

Start() [2/2]

virtual void webrtc::DesktopCapturer::Start ( Callback *  callback )

pure virtual

Implemented in webrtc::FakeDesktopCapturer, webrtc::FakeDesktopCapturer, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinDirectx, webrtc::ScreenCapturerWinMagnifier, webrtc::ScreenCapturerWinMagnifier, webrtc::DesktopCapturerDifferWrapper, webrtc::DesktopCapturerDifferWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::FallbackDesktopCapturerWrapper, webrtc::DesktopAndCursorComposer, webrtc::DesktopAndCursorComposer, webrtc::CroppingWindowCapturer, and webrtc::CroppingWindowCapturer.

---

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

• DerivedData/WebKit/Build/Products/Debug/usr/local/include/webrtc/modules/desktop_capture/desktop_capturer.h
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/desktop_capturer.cc
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/screen_capturer_mac.mm
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/screen_capturer_null.cc
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/screen_capturer_win.cc
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/screen_capturer_x11.cc
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/window_capturer_mac.mm
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/window_capturer_null.cc
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/window_capturer_win.cc
• Source/ThirdParty/libwebrtc/Source/webrtc/modules/desktop_capture/window_capturer_x11.cc