BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJMEDIA Reference

pjmedia_vid_dev_param Struct Reference

Data Fields

pjmedia_dir dir
 
pjmedia_vid_dev_index cap_id
 
pjmedia_vid_dev_index rend_id
 
unsigned clock_rate
 
unsigned flags
 
pjmedia_format fmt
 
pjmedia_vid_dev_hwnd window
 
pjmedia_rect_size disp_size
 
pjmedia_coord window_pos
 
pj_bool_t window_hide
 
pj_bool_t native_preview
 
pjmedia_orient orient
 
unsigned window_flags
 
pj_bool_t window_fullscreen
 

Detailed Description

This structure specifies the parameters to open the video stream.

Field Documentation

◆ dir

pjmedia_dir pjmedia_vid_dev_param::dir

The video direction. This setting is mandatory.

◆ cap_id

pjmedia_vid_dev_index pjmedia_vid_dev_param::cap_id

The video capture device ID. This setting is mandatory if the video direction includes input/capture direction.

◆ rend_id

pjmedia_vid_dev_index pjmedia_vid_dev_param::rend_id

The video render device ID. This setting is mandatory if the video direction includes output/render direction.

◆ clock_rate

unsigned pjmedia_vid_dev_param::clock_rate

Video clock rate. This setting is mandatory if the video direction includes input/capture direction

◆ flags

unsigned pjmedia_vid_dev_param::flags

Video frame rate. This setting is mandatory if the video direction includes input/capture direction This flags specifies which of the optional settings are valid in this structure. The flags is bitmask combination of pjmedia_vid_dev_cap.

◆ fmt

pjmedia_format pjmedia_vid_dev_param::fmt

Set the video format. This setting is mandatory.

◆ window

pjmedia_vid_dev_hwnd pjmedia_vid_dev_param::window

Window for the renderer to display the video. This setting is optional, and will only be used if PJMEDIA_VID_DEV_CAP_OUTPUT_WINDOW is set in the flags.

◆ disp_size

pjmedia_rect_size pjmedia_vid_dev_param::disp_size

Video display size. This setting is optional, and will only be used if PJMEDIA_VID_DEV_CAP_OUTPUT_RESIZE is set in the flags.

◆ window_pos

pjmedia_coord pjmedia_vid_dev_param::window_pos

Video window position. This setting is optional, and will only be used if PJMEDIA_VID_DEV_CAP_OUTPUT_POSITION is set in the flags.

◆ window_hide

pj_bool_t pjmedia_vid_dev_param::window_hide

Video window's visibility. This setting is optional, and will only be used if PJMEDIA_VID_DEV_CAP_OUTPUT_HIDE is set in the flags.

◆ native_preview

pj_bool_t pjmedia_vid_dev_param::native_preview

Enable built-in preview. This setting is optional and is only used if PJMEDIA_VID_DEV_CAP_INPUT_PREVIEW capability is supported and set in the flags.

◆ orient

pjmedia_orient pjmedia_vid_dev_param::orient

Video orientation. This setting is optional and is only used if PJMEDIA_VID_DEV_CAP_ORIENTATION capability is supported and is set in the flags.

◆ window_flags

unsigned pjmedia_vid_dev_param::window_flags

Video window flags. This setting is optional, and will only be used if PJMEDIA_VID_DEV_CAP_OUTPUT_WINDOW_FLAGS is set in the flags.

◆ window_fullscreen

pj_bool_t pjmedia_vid_dev_param::window_fullscreen

Video window's full screen status. This setting is optional, and will only be used if PJMEDIA_VID_DEV_CAP_OUTPUT_FULLSCREEN is set in the flags.


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

 


PJMEDIA small footprint Open Source media stack
Copyright (C) 2006-2008 Teluu Inc.