BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJSIP Reference

pj::AccountMediaConfig Struct Reference

#include <account.hpp>

Inheritance diagram for pj::AccountMediaConfig:
pj::PersistentObject

Public Member Functions

 AccountMediaConfig ()
 
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

TransportConfig transportConfig
 
bool lockCodecEnabled
 
bool streamKaEnabled
 
pjmedia_srtp_use srtpUse
 
int srtpSecureSignaling
 
SrtpOpt srtpOpt
 
pjsua_ipv6_use ipv6Use
 
bool rtcpMuxEnabled
 
RtcpFbConfig rtcpFbConfig
 
bool useLoopMedTp
 
bool enableLoopback
 

Detailed Description

Account media config (applicable for both audio and video). This will be specified in AccountConfig.

Constructor & Destructor Documentation

◆ AccountMediaConfig()

pj::AccountMediaConfig::AccountMediaConfig ( )
inline

Default constructor

References pj::AccountRegConfig::readObject().

Member Function Documentation

◆ readObject()

virtual void pj::AccountMediaConfig::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::AccountMediaConfig::writeObject ( ContainerNode node) const
virtual

Write this object to a container node.

Parameters
nodeContainer to write values to.

Implements pj::PersistentObject.

Field Documentation

◆ transportConfig

TransportConfig pj::AccountMediaConfig::transportConfig

Media transport (RTP) configuration.

For port and portRange settings, RTCP port is selected as RTP port+1. Example: port=5000, portRange=4

  • Available ports: 5000, 5002, 5004 (Media/RTP transport) 5001, 5003, 5005 (Media/RTCP transport)

◆ lockCodecEnabled

bool pj::AccountMediaConfig::lockCodecEnabled

If remote sends SDP answer containing more than one format or codec in the media line, send re-INVITE or UPDATE with just one codec to lock which codec to use.

Default: True (Yes).

◆ streamKaEnabled

bool pj::AccountMediaConfig::streamKaEnabled

Specify whether stream keep-alive and NAT hole punching with non-codec-VAD mechanism (see PJMEDIA_STREAM_ENABLE_KA) is enabled for this account.

Default: False

◆ srtpUse

pjmedia_srtp_use pj::AccountMediaConfig::srtpUse

Specify whether secure media transport should be used for this account. Valid values are PJMEDIA_SRTP_DISABLED, PJMEDIA_SRTP_OPTIONAL, and PJMEDIA_SRTP_MANDATORY.

Default: PJSUA_DEFAULT_USE_SRTP

◆ srtpSecureSignaling

int pj::AccountMediaConfig::srtpSecureSignaling

Specify whether SRTP requires secure signaling to be used. This option is only used when use_srtp option above is non-zero.

Valid values are: 0: SRTP does not require secure signaling 1: SRTP requires secure transport such as TLS 2: SRTP requires secure end-to-end transport (SIPS)

Default: PJSUA_DEFAULT_SRTP_SECURE_SIGNALING

◆ srtpOpt

SrtpOpt pj::AccountMediaConfig::srtpOpt

Specify SRTP settings, like cryptos and keying methods.

◆ ipv6Use

pjsua_ipv6_use pj::AccountMediaConfig::ipv6Use

Specify whether IPv6 should be used on media. Default is not used.

◆ rtcpMuxEnabled

bool pj::AccountMediaConfig::rtcpMuxEnabled

Enable RTP and RTCP multiplexing.

◆ rtcpFbConfig

RtcpFbConfig pj::AccountMediaConfig::rtcpFbConfig

RTCP Feedback settings.

◆ useLoopMedTp

bool pj::AccountMediaConfig::useLoopMedTp

Use loopback media transport. This may be useful if application doesn't want PJSUA2 to create real media transports/sockets, such as when using third party media.

Default: false

◆ enableLoopback

bool pj::AccountMediaConfig::enableLoopback

Enable local loopback when useLoopMedTp is set to TRUE. If enabled, packets sent to the transport will be sent back to the streams attached to the transport.

Default: false


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.