Home --> Documentations --> PJSIP Reference

pjsua_vid_preview_param Struct Reference

#include <pjsua.h>

Data Fields

pjmedia_vid_dev_index rend_id
pj_bool_t show
unsigned wnd_flags
pjmedia_format format
pjmedia_vid_dev_hwnd wnd

Detailed Description

Parameters for starting video preview with pjsua_vid_preview_start(). Application should initialize this structure with pjsua_vid_preview_param_default().

Field Documentation

◆ rend_id

pjmedia_vid_dev_index pjsua_vid_preview_param::rend_id

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

pj_bool_t pjsua_vid_preview_param::show

Show window initially.

Default: PJ_TRUE.

◆ wnd_flags

unsigned pjsua_vid_preview_param::wnd_flags

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

Default: 0.

◆ format

pjmedia_format pjsua_vid_preview_param::format

Media format. Initialize this with pjmedia_format_init_video(). If left unitialized, this parameter will not be used.

◆ wnd

pjmedia_vid_dev_hwnd pjsua_vid_preview_param::wnd

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.