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

This class contains parameters and methods that needed for creating a local camera stream. When a stream is created, it will not be impacted if these parameters are changed. More...

#include <owt/base/localcamerastreamparameters.h>

Public Member Functions

 LocalCameraStreamParameters (bool audio_enabled, bool video_enabled)
 Initialize a LocalCameraStreamParameters. More...
 
void CameraId (const std::string &camera_id)
 Set the ID of the camera to be used. More...
 
void StreamName (const std::string &stream_name)
 Set the ID of media stream. More...
 
void Resolution (int width, int height)
 Set the video resolution. If the resolution specified is not supported on current device, creation will failed. More...
 
void Fps (int fps)
 Set the frame rate. If the frame rate specified is not supported on current device, creation will failed. More...
 

Detailed Description

This class contains parameters and methods that needed for creating a local camera stream. When a stream is created, it will not be impacted if these parameters are changed.

Constructor & Destructor Documentation

◆ LocalCameraStreamParameters()

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

Initialize a LocalCameraStreamParameters.

Parameters
audio_enabledIndicates if audio is enabled for this stream.
video_anabledIndicates if video is enabled for this stream.

Member Function Documentation

◆ CameraId()

void owt::base::LocalCameraStreamParameters::CameraId ( const std::string &  camera_id)

Set the ID of the camera to be used.

Parameters
camera_idCamera ID. On Windows, camera ID is the DevicePath of capturer device. DevicePath is a unique string that identifies the device. Please refer https://msdn.microsoft.com/en-us/library/windows/desktop/dd377566.aspx for detailed information about DevicePath.

◆ Fps()

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

Set the frame rate. If the frame rate specified is not supported on current device, creation will failed.

Parameters
fpsThe frame rate of the video.

◆ Resolution()

void owt::base::LocalCameraStreamParameters::Resolution ( int  width,
int  height 
)

Set the video resolution. If the resolution specified is not supported on current device, creation will failed.

Parameters
widthThe width of the video.
heightThe height of the video.

◆ StreamName()

void owt::base::LocalCameraStreamParameters::StreamName ( const std::string &  stream_name)

Set the ID of media stream.

Parameters
stream_nameThe ID of media stream created.