WARNING: The online documentation has moved to https://docs.pjsip.org.

Visit the new documentation at https://docs.pjsip.org:

BLOG | DOCUMENTATION | GITHUB

Home --> Documentations --> PJSIP Reference

pjsua_call Struct Reference

#include <pjsua_internal.h>

Data Fields

unsigned index
 
pjsua_call_setting opt
 
pj_bool_t opt_inited
 
pjsip_inv_sessioninv
 
void * user_data
 
pjsip_status_code last_code
 
pj_str_t last_text
 
pj_time_val start_time
 
pj_time_val res_time
 
pj_time_val conn_time
 
pj_time_val dis_time
 
pjsua_acc_id acc_id
 
int secure_level
 
pjsua_call_hold_type call_hold_type
 
pj_bool_t local_hold
 
void * hold_msg
 
pj_str_t cname
 
char cname_buf [16]
 
unsigned med_cnt
 
pjsua_call_media media [PJMEDIA_MAX_SDP_MEDIA]
 
unsigned med_prov_cnt
 
pjsua_call_media media_prov [PJMEDIA_MAX_SDP_MEDIA]
 
pj_bool_t med_update_success
 
pj_bool_t hanging_up
 
int audio_idx
 
pj_mutex_tmed_ch_mutex
 
pjsua_med_tp_state_cb med_ch_cb
 
pjsua_med_tp_state_info med_ch_info
 
pjsip_evsubxfer_sub
 
pj_stun_nat_type rem_nat_type
 
char last_text_buf_ [128]
 
struct {
   int   retry_cnt
 
lock_codec
 
struct {
   pjsip_dialog *   dlg
 
   pjmedia_sdp_session *   rem_sdp
 
   pj_pool_t *   pool_prov
 
   pj_bool_t   med_ch_deinit
 
   union {
      struct {
         pjsua_msg_data *   msg_data
 
         pj_bool_t   hangup
 
      }   out_call
 
      struct {
         call_answer   answers
 
         pj_bool_t   hangup
 
         pjsip_dialog *   replaced_dlg
 
      }   inc_call
 
   }   call_var
 
async_call
 
pj_bool_t rem_offerer
 
unsigned rem_aud_cnt
 
unsigned rem_vid_cnt
 
pj_bool_t rx_reinv_async
 
pj_timer_entry reinv_timer
 
pj_bool_t reinv_pending
 
pj_bool_t reinv_ice_sent
 
pjsip_rx_dataincoming_data
 
struct {
   pj_bool_t   enabled
 
   pj_bool_t   remote_sup
 
   pj_bool_t   remote_dlg_est
 
   pjsua_op_state   trickling
 
   int   retrans18x_count
 
   pj_bool_t   pending_info
 
   pj_timer_entry   timer
 
trickle_ice
 
pj_timer_entry hangup_timer
 
unsigned hangup_retry
 
unsigned hangup_code
 
pj_str_t hangup_reason
 
pjsua_msg_datahangup_msg_data
 

Detailed Description

Structure to be attached to invite dialog. Given a dialog "dlg", application can retrieve this structure by accessing dlg->mod_data[pjsua.mod.id].

This is the private header used by pjsua library implementation. Applications should not include this file. Forward decl of pjsua call

Field Documentation

◆ index

unsigned pjsua_call::index

Index in pjsua array.

◆ opt

pjsua_call_setting pjsua_call::opt

Call setting.

◆ opt_inited

pj_bool_t pjsua_call::opt_inited

Initial call setting has been set, to avoid different opt in answer.

◆ inv

pjsip_inv_session* pjsua_call::inv

The invite session.

◆ user_data

void* pjsua_call::user_data

User/application data.

◆ last_code

pjsip_status_code pjsua_call::last_code

Last status code seen.

◆ last_text

pj_str_t pjsua_call::last_text

Last status text seen.

◆ start_time

pj_time_val pjsua_call::start_time

First INVITE sent/received.

◆ res_time

pj_time_val pjsua_call::res_time

First response sent/received.

◆ conn_time

pj_time_val pjsua_call::conn_time

Connected/confirmed time.

◆ dis_time

pj_time_val pjsua_call::dis_time

Disconnect time.

◆ acc_id

pjsua_acc_id pjsua_call::acc_id

Account index being used.

◆ secure_level

int pjsua_call::secure_level

Signaling security level.

◆ call_hold_type

pjsua_call_hold_type pjsua_call::call_hold_type

How to do call hold.

◆ local_hold

pj_bool_t pjsua_call::local_hold

Flag for call-hold by local.

◆ hold_msg

void* pjsua_call::hold_msg

Outgoing hold tx_data.

◆ cname

pj_str_t pjsua_call::cname

RTCP CNAME.

◆ cname_buf

char pjsua_call::cname_buf[16]

cname buffer.

◆ med_cnt

unsigned pjsua_call::med_cnt

Number of media in SDP.

◆ media

Array of media

◆ med_prov_cnt

unsigned pjsua_call::med_prov_cnt

Number of provisional media.

◆ media_prov

pjsua_call_media pjsua_call::media_prov[PJMEDIA_MAX_SDP_MEDIA]

Array of provisional media.

◆ med_update_success

pj_bool_t pjsua_call::med_update_success

Is media update successful?

◆ hanging_up

pj_bool_t pjsua_call::hanging_up

Is call in the process of hangup?

◆ audio_idx

int pjsua_call::audio_idx

First active audio media.

◆ med_ch_mutex

pj_mutex_t* pjsua_call::med_ch_mutex

Media channel callback's mutex.

◆ med_ch_cb

pjsua_med_tp_state_cb pjsua_call::med_ch_cb

Media channel callback.

◆ med_ch_info

pjsua_med_tp_state_info pjsua_call::med_ch_info

Media channel info.

◆ xfer_sub

pjsip_evsub* pjsua_call::xfer_sub

Xfer server subscription, if this call was triggered by xfer.

◆ rem_nat_type

pj_stun_nat_type pjsua_call::rem_nat_type

NAT type of remote endpoint.

◆ last_text_buf_

char pjsua_call::last_text_buf_[128]

Buffer for last_text.

◆ retry_cnt

int pjsua_call::retry_cnt

Retry count.

◆ 

struct { ... } pjsua_call::lock_codec

Data for codec locking when answer contains multiple codecs.

◆ dlg

pjsip_dialog* pjsua_call::dlg

Call dialog.

◆ rem_sdp

pjmedia_sdp_session* pjsua_call::rem_sdp

Remote SDP.

◆ pool_prov

pj_pool_t* pjsua_call::pool_prov

Provisional pool.

◆ med_ch_deinit

pj_bool_t pjsua_call::med_ch_deinit

Media channel de-init-ed?

◆ msg_data

pjsua_msg_data* pjsua_call::msg_data

Headers for outgoing INVITE.

◆ hangup

pj_bool_t pjsua_call::hangup

Call is hangup?

◆ answers

call_answer pjsua_call::answers

A list of call answers.

◆ replaced_dlg

pjsip_dialog* pjsua_call::replaced_dlg

Replaced dialog.

◆ 

struct { ... } pjsua_call::async_call

Temporary storage for async outgoing/incoming call.

◆ rem_offerer

pj_bool_t pjsua_call::rem_offerer

Was remote SDP offerer?

◆ rem_aud_cnt

unsigned pjsua_call::rem_aud_cnt

No of active audio in last remote offer.

◆ rem_vid_cnt

unsigned pjsua_call::rem_vid_cnt

No of active video in last remote offer.

◆ rx_reinv_async

pj_bool_t pjsua_call::rx_reinv_async

on_call_rx_reinvite() async.

◆ reinv_timer

pj_timer_entry pjsua_call::reinv_timer

Reinvite retry timer.

◆ reinv_pending

pj_bool_t pjsua_call::reinv_pending

Pending until CONFIRMED state.

◆ reinv_ice_sent

pj_bool_t pjsua_call::reinv_ice_sent

Has reinvite for ICE upd sent?

◆ incoming_data

pjsip_rx_data* pjsua_call::incoming_data

Cloned incoming call rdata. On pjsua2, when handling incoming call, onCreateMediaTransport() will not be called since the call isn't created yet. This temporary variable is used to handle such case, see ticket #1916.

◆ hangup_timer

pj_timer_entry pjsua_call::hangup_timer

Hangup retry timer.

◆ hangup_retry

unsigned pjsua_call::hangup_retry

Number of hangup retries.

◆ hangup_code

unsigned pjsua_call::hangup_code

Hangup code.

◆ hangup_reason

pj_str_t pjsua_call::hangup_reason

Hangup reason.

◆ hangup_msg_data

pjsua_msg_data* pjsua_call::hangup_msg_data

Hangup message data.


The documentation for this struct was generated from the following file:
  • pjsua_internal.h

 


PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
Copyright (C) 2006-2008 Teluu Inc.