Intel® Collaboration Suite for WebRTC  version 4.3.1
Open WebRTC Toolkit (OWT) Client SDK for Windows*
owt::base::LocalDesktopStreamParameters Class Referencefinal

This class contains parameters and methods that's needed for creating a local stream with certain screen or window as source. When a stream is created, it will not be impacted if these parameters are changed. More...

#include <owt/base/localcamerastreamparameters.h>

Public Types

enum  DesktopCapturePolicy : int {
  DesktopCapturePolicy::kDefault = 0, DesktopCapturePolicy::kEnableDirectX = 1, DesktopCapturePolicy::kEnableEffects = 2, DesktopCapturePolicy::kEnableUpdateDetection = 4,
  DesktopCapturePolicy::kEnableMagnification = 8
}
 
enum  DesktopSourceType : int { DesktopSourceType::kFullScreen = 1, DesktopSourceType::kApplication }
 

Public Member Functions

 LocalDesktopStreamParameters (bool audio_enabled, bool video_enabled)
 Initialize a LocalDesktopStreamParameters. More...
 
bool VideoEnabled () const
 Get video is enabled or not for this stream. More...
 
bool AudioEnabled () const
 Get audio is enabled or not for this stream. More...
 
void SourceType (DesktopSourceType source_type)
 Set the source type of screen/app sharing. More...
 
void CapturePolicy (DesktopCapturePolicy capture_policy)
 Set the capturer features capture_policy Indicate the feature used by the capturer.
 
void Fps (int fps)
 Set the frame rate. The actual frame rate of window/screen capturing may be lower than this. More...
 

Detailed Description

This class contains parameters and methods that's needed for creating a local stream with certain screen or window as source. When a stream is created, it will not be impacted if these parameters are changed.

Member Enumeration Documentation

◆ DesktopCapturePolicy

Enumerator
kDefault 

Default capture policy.

kEnableDirectX 

With this policy set, on windows, use DirectX for desktop capture if possisble.

kEnableEffects 

With this policy set, enable platform specific window effects if possible.

kEnableUpdateDetection 

With this policy set, capturer will provide update region information to caller.

kEnableMagnification 

With this policy set, capturer can send out scaled captured frame.

◆ DesktopSourceType

Enumerator
kFullScreen 

Capture from whole screen.

kApplication 

Capture from application.

Constructor & Destructor Documentation

◆ LocalDesktopStreamParameters()

owt::base::LocalDesktopStreamParameters::LocalDesktopStreamParameters ( bool  audio_enabled,
bool  video_enabled 
)

Initialize a LocalDesktopStreamParameters.

Parameters
audio_enabledIndicates if audio is enabled for this stream.
video_anabledIndicates if video is enabled for this stream.
soruce_typeIndicates if capture from screen or an app.
capture_policythe OR of any of the DesktopCapturePolicy options.

Member Function Documentation

◆ AudioEnabled()

bool owt::base::LocalDesktopStreamParameters::AudioEnabled ( ) const
inline

Get audio is enabled or not for this stream.

Returns
true or false.

◆ Fps()

void owt::base::LocalDesktopStreamParameters::Fps ( int  fps)

Set the frame rate. The actual frame rate of window/screen capturing may be lower than this.

Parameters
fpsThe frame rate of the captured screen/window.

◆ SourceType()

void owt::base::LocalDesktopStreamParameters::SourceType ( DesktopSourceType  source_type)
inline

Set the source type of screen/app sharing.

Parameters
source_typeIndicate if capturing the full screen or an application.

◆ VideoEnabled()

bool owt::base::LocalDesktopStreamParameters::VideoEnabled ( ) const
inline

Get video is enabled or not for this stream.

Returns
true or false.