pj::CallSetting Struct Reference

#include <call.hpp>

Public Member Functions
	CallSetting (bool useDefaultValues=false)
bool	isEmpty () const
void	fromPj (const pjsua_call_setting &prm)
pjsua_call_setting	toPj () const

Data Fields
unsigned	flag
unsigned	reqKeyframeMethod
unsigned	audioCount
unsigned	videoCount
MediaDirVector	mediaDir

Detailed Description

Call settings.

Constructor & Destructor Documentation

CallSetting()

pj::CallSetting::CallSetting

(

bool

useDefaultValues = false

)

Default constructor initializes with empty or default values.

Member Function Documentation

isEmpty()

bool pj::CallSetting::isEmpty

(

)

const

Check if the settings are set with empty values.

Returns

True if the settings are empty.

fromPj()

void pj::CallSetting::fromPj

(

const pjsua_call_setting &

prm

)

Convert from pjsip

toPj()

pjsua_call_setting pj::CallSetting::toPj

(

)

const

Convert to pjsip

Field Documentation

flag

unsigned pj::CallSetting::flag

Bitmask of pjsua_call_flag constants.

Default: PJSUA_CALL_INCLUDE_DISABLED_MEDIA

reqKeyframeMethod

unsigned pj::CallSetting::reqKeyframeMethod

This flag controls what methods to request keyframe are allowed on the call. Value is bitmask of pjsua_vid_req_keyframe_method.

Default: PJSUA_VID_REQ_KEYFRAME_SIP_INFO | PJSUA_VID_REQ_KEYFRAME_RTCP_PLI

audioCount

unsigned pj::CallSetting::audioCount

Number of simultaneous active audio streams for this call. Setting this to zero will disable audio in this call.

Default: 1

videoCount

unsigned pj::CallSetting::videoCount

Number of simultaneous active video streams for this call. Setting this to zero will disable video in this call.

Default: 1 (if video feature is enabled, otherwise it is zero)

mediaDir

MediaDirVector pj::CallSetting::mediaDir

Media direction. This setting will only be used if the flag PJSUA_CALL_SET_MEDIA_DIR is set, and it will persist for subsequent offers or answers. For example, a media that is set as PJMEDIA_DIR_ENCODING can only mark the stream in the SDP as sendonly or inactive, but will not become sendrecv in subsequent offers and answers. Application can update the media direction in any API or callback that accepts CallSetting as a parameter, such as via Call::reinvite/update() or in onCallRxOffer/Reinvite() callback.

The index of the media dir will correspond to the provisional media in CallInfo.provMedia. For offers that involve adding new medias (such as initial offer), the index will correspond to all new audio media first, then video. For example, for a new call with 2 audios and 1 video, mediaDir[0] and mediaDir[1] will be for the audios, and mediaDir[2] video.

Default: empty vector

---

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

• call.hpp