Home --> Documentations --> PJSIP Reference

pj::VideoPreviewOpParam Struct Reference

#include <media.hpp>

Public Member Functions

 VideoPreviewOpParam ()
void fromPj (const pjsua_vid_preview_param &prm)
pjsua_vid_preview_param toPj () const

Data Fields

pjmedia_vid_dev_index rendId
bool show
unsigned windowFlags
MediaFormat format
VideoWindowHandle window

Detailed Description

This structure contains parameters for VideoPreview::start()

Constructor & Destructor Documentation

◆ VideoPreviewOpParam()

pj::VideoPreviewOpParam::VideoPreviewOpParam ( )

Default constructor initializes with default values.

Member Function Documentation

◆ fromPj()

void pj::VideoPreviewOpParam::fromPj ( const pjsua_vid_preview_param prm)

Convert from pjsip

◆ toPj()

pjsua_vid_preview_param pj::VideoPreviewOpParam::toPj ( ) const

Convert to pjsip

Field Documentation

◆ rendId

pjmedia_vid_dev_index pj::VideoPreviewOpParam::rendId

Device ID for the video renderer to be used for rendering the capture stream for preview. This parameter is ignored if native preview is being used.


◆ show

bool pj::VideoPreviewOpParam::show

Show window initially.

Default: PJ_TRUE.

◆ windowFlags

unsigned pj::VideoPreviewOpParam::windowFlags

Window flags. The value is a bitmask combination of pjmedia_vid_dev_wnd_flag.

Default: 0.

◆ format

MediaFormat pj::VideoPreviewOpParam::format

Media format. If left unitialized, this parameter will not be used.

◆ window

VideoWindowHandle pj::VideoPreviewOpParam::window

Optional output window to be used to display the video preview. This parameter will only be used if the video device supports PJMEDIA_VID_DEV_CAP_OUTPUT_WINDOW capability and the capability is not read-only.

The documentation for this struct 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.