BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

pj::AccountVideoConfig Struct Reference

#include <account.hpp>

Inheritance diagram for pj::AccountVideoConfig:
pj::PersistentObject

Public Member Functions

virtual void readObject (const ContainerNode &node) PJSUA2_THROW(Error)
 
virtual void writeObject (ContainerNode &node) const PJSUA2_THROW(Error)
 
- Public Member Functions inherited from pj::PersistentObject
virtual ~PersistentObject ()
 

Data Fields

bool autoShowIncoming
 
bool autoTransmitOutgoing
 
unsigned windowFlags
 
pjmedia_vid_dev_index defaultCaptureDevice
 
pjmedia_vid_dev_index defaultRenderDevice
 
pjmedia_vid_stream_rc_method rateControlMethod
 
unsigned rateControlBandwidth
 
unsigned startKeyframeCount
 
unsigned startKeyframeInterval
 

Detailed Description

Account video config. This will be specified in AccountConfig.

Member Function Documentation

◆ readObject()

virtual void pj::AccountVideoConfig::readObject ( const ContainerNode node)
virtual

Read this object from a container node.

Parameters
nodeContainer to read values from.

Implements pj::PersistentObject.

◆ writeObject()

virtual void pj::AccountVideoConfig::writeObject ( ContainerNode node) const
virtual

Write this object to a container node.

Parameters
nodeContainer to write values to.

Implements pj::PersistentObject.

Field Documentation

◆ autoShowIncoming

bool pj::AccountVideoConfig::autoShowIncoming

Specify whether incoming video should be shown to screen by default. This applies to incoming call (INVITE), incoming re-INVITE, and incoming UPDATE requests.

Regardless of this setting, application can detect incoming video by implementing on_call_media_state() callback and enumerating the media stream(s) with pjsua_call_get_info(). Once incoming video is recognised, application may retrieve the window associated with the incoming video and show or hide it with pjsua_vid_win_set_show().

Default: False

◆ autoTransmitOutgoing

bool pj::AccountVideoConfig::autoTransmitOutgoing

Specify whether outgoing video should be activated by default when making outgoing calls and/or when incoming video is detected. This applies to incoming and outgoing calls, incoming re-INVITE, and incoming UPDATE. If the setting is non-zero, outgoing video transmission will be started as soon as response to these requests is sent (or received).

Regardless of the value of this setting, application can start and stop outgoing video transmission with pjsua_call_set_vid_strm().

Default: False

◆ windowFlags

unsigned pj::AccountVideoConfig::windowFlags

Specify video window's flags. The value is a bitmask combination of pjmedia_vid_dev_wnd_flag.

Default: 0

◆ defaultCaptureDevice

pjmedia_vid_dev_index pj::AccountVideoConfig::defaultCaptureDevice

Specify the default capture device to be used by this account. If vidOutAutoTransmit is enabled, this device will be used for capturing video.

Default: PJMEDIA_VID_DEFAULT_CAPTURE_DEV

◆ defaultRenderDevice

pjmedia_vid_dev_index pj::AccountVideoConfig::defaultRenderDevice

Specify the default rendering device to be used by this account.

Default: PJMEDIA_VID_DEFAULT_RENDER_DEV

◆ rateControlMethod

pjmedia_vid_stream_rc_method pj::AccountVideoConfig::rateControlMethod

Rate control method.

Default: PJMEDIA_VID_STREAM_RC_SIMPLE_BLOCKING.

◆ rateControlBandwidth

unsigned pj::AccountVideoConfig::rateControlBandwidth

Upstream/outgoing bandwidth. If this is set to zero, the video stream will use codec maximum bitrate setting.

Default: 0 (follow codec maximum bitrate).

◆ startKeyframeCount

unsigned pj::AccountVideoConfig::startKeyframeCount

The number of keyframe to be sent after the stream is created.

Default: PJMEDIA_VID_STREAM_START_KEYFRAME_CNT

◆ startKeyframeInterval

unsigned pj::AccountVideoConfig::startKeyframeInterval

The keyframe sending interval after the stream is created.

Default: PJMEDIA_VID_STREAM_START_KEYFRAME_INTERVAL_MSEC


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.