BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJSIP Reference

pj::VideoPreview Class Reference

#include <media.hpp>

Public Member Functions

 VideoPreview (int dev_id)
 
bool hasNative ()
 
void start (const VideoPreviewOpParam &param) throw (Error)
 
void stop () throw (Error)
 
VideoWindow getVideoWindow ()
 
VideoMedia getVideoMedia () throw (Error)
 

Detailed Description

Video Preview

Constructor & Destructor Documentation

◆ VideoPreview()

pj::VideoPreview::VideoPreview ( int  dev_id)

Constructor

Member Function Documentation

◆ hasNative()

bool pj::VideoPreview::hasNative ( )

Determine if the specified video input device has built-in native preview capability. This is a convenience function that is equal to querying device's capability for PJMEDIA_VID_DEV_CAP_INPUT_PREVIEW capability.

Returns
true if it has.

◆ start()

void pj::VideoPreview::start ( const VideoPreviewOpParam param)
throw (Error
)

Start video preview window for the specified capture device.

Parameters
paramVideo preview parameters.

◆ stop()

void pj::VideoPreview::stop ( )
throw (Error
)

Stop video preview.

◆ getVideoWindow()

VideoWindow pj::VideoPreview::getVideoWindow ( )

Get the preview window handle associated with the capture device,if any.

◆ getVideoMedia()

VideoMedia pj::VideoPreview::getVideoMedia ( )
throw (Error
)

Get video media or conference bridge port of the video capture device.

Returns
Video media of the video capture device.

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

 


PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
Copyright (C) 2006-2008 Teluu Inc.