sofia-sip/soa_tag.h File Reference


Detailed Description

Tags for SDP Offer/Answer Application Interface.

Author:
Pekka Pessi <Pekka.Pessi@nokia-email.address.hidden>
Date:
Created: Mon Aug 1 15:43:53 EEST 2005 ppessi

#include <sofia-sip/su_tag.h>
#include <sofia-sip/sdp_tag.h>

Include dependency graph for soa_tag.h:

Go to the source code of this file.

Defines

#define SOATAG_ANY()
 Filter tag matching any soa tag.
#define SOATAG_USER_SDP(x)
 Pass parsed user session description to soa session object.
#define SOATAG_USER_SDP_STR(x)
 Pass media description file name to the NUA stack.
#define SOATAG_CAPS_SDP(x)
 Pass parsed capability description to soa session object.
#define SOATAG_CAPS_SDP_STR(x)
 Pass capability description to soa session object.
#define SOATAG_REMOTE_SDP(x)
 Pass parsed remote session description to soa session object.
#define SOATAG_REMOTE_SDP_STR(x)
 Pass media description file name to the NUA stack.
#define SOATAG_AF(x)
 Preferred address family for media.
#define SOATAG_ADDRESS(x)
 Pass media address.
#define SOATAG_RTP_SELECT(x)
 When generating answer or second offer, soa can include all the supported codec, only one codec, or only the codecs supported by both ends in the list of payload types on the m= line.
#define SOATAG_RTP_SORT(x)
 When selecting the common codecs, soa can either select first local codec supported by remote end, or first remote codec supported by local codecs.
#define SOATAG_RTP_MISMATCH(x)
 Accept media line even if the SDP negotation code determines that there are no common codecs between local and remote media.
#define SOATAG_ACTIVE_AUDIO(x)
 Audio session status.
#define SOATAG_ACTIVE_VIDEO(x)
 Video session status.
#define SOATAG_ACTIVE_IMAGE(x)
 Active image session status.
#define SOATAG_ACTIVE_CHAT(x)
 Active chat session status.
#define SOATAG_SRTP_ENABLE(x)
 Enable SRTP.
#define SOATAG_SRTP_CONFIDENTIALITY(x)
 Enable SRTP confidentiality.
#define SOATAG_SRTP_INTEGRITY(x)
 Enable SRTP integrity protection.
#define SOATAG_HOLD(x)
 Hold & unhold.

Enumerations

enum  {
  SOA_ACTIVE_REJECTED,
  SOA_ACTIVE_DISABLED,
  SOA_ACTIVE_INACTIVE,
  SOA_ACTIVE_SENDONLY,
  SOA_ACTIVE_RECVONLY,
  SOA_ACTIVE_SENDRECV
}
 Media states. More...

Variables

SOFIA_BEGIN_DECLS SOFIAPUBVAR
tagi_t 
soa_tag_list []
 List of base SOA tags (defined in base SOA module).


Define Documentation

#define SOATAG_ACTIVE_AUDIO (  ) 

Audio session status.

Used with
Parameter type
enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED, SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY, SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
Values
SOA_ACTIVE_REJECTED (-8)
SOA_ACTIVE_INACTIVE (0)
SOA_ACTIVE_SENDONLY (1)
SOA_ACTIVE_RECVONLY (2)
SOA_ACTIVE_SENDRECV (3)
Corresponding tag taking reference parameter is SOATAG_ACTIVE_AUDIO_REF()

#define SOATAG_ACTIVE_CHAT (  ) 

Active chat session status.

Used with
Parameter type
enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED, SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY, SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
Values
SOA_ACTIVE_REJECTED (-8)
SOA_ACTIVE_INACTIVE (0)
SOA_ACTIVE_SENDONLY (1)
SOA_ACTIVE_RECVONLY (2)
SOA_ACTIVE_SENDRECV (3)
Corresponding tag taking reference parameter is SOATAG_ACTIVE_CHAT_REF()

#define SOATAG_ACTIVE_IMAGE (  ) 

Active image session status.

Used with
nua_i_active
nua_i_state
Parameter type
enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED, SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY, SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
Values
SOA_ACTIVE_REJECTED (-8)
SOA_ACTIVE_INACTIVE (0)
SOA_ACTIVE_SENDONLY (1)
SOA_ACTIVE_RECVONLY (2)
SOA_ACTIVE_SENDRECV (3)
Parameter type
enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED, SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY, SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
Values
SOA_ACTIVE_REJECTED (-8)
SOA_ACTIVE_INACTIVE (0)
SOA_ACTIVE_SENDONLY (1)
SOA_ACTIVE_RECVONLY (2)
SOA_ACTIVE_SENDRECV (3)
Corresponding tag taking reference parameter is SOATAG_ACTIVE_IMAGE_REF()

#define SOATAG_ACTIVE_VIDEO (  ) 

Video session status.

Used with
Parameter type
enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED, SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY, SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
Values
SOA_ACTIVE_REJECTED (-8)
SOA_ACTIVE_INACTIVE (0)
SOA_ACTIVE_SENDONLY (1)
SOA_ACTIVE_RECVONLY (2)
SOA_ACTIVE_SENDRECV (3)
Corresponding tag taking reference parameter is SOATAG_ACTIVE_VIDEO_REF()

#define SOATAG_ADDRESS (  ) 

Pass media address.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_respond()
Parameter type
char const *
Values
NULL terminated character string containing a domain name, IPv4 address, or IPv6 address.
Corresponding tag taking reference parameter is SOATAG_ADDRESS_REF()

#define SOATAG_AF (  ) 

Preferred address family for media.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_respond()
Parameter type
unsigned int
Values
SOATAG_AF_ANY (default) (0) any address family
SOATAG_AF_IP4_ONLY (1) only IP version 4
SOATAG_AF_IP6_ONLY (2) only IP version 6
SOATAG_AF_IP4_IP6 (3) either IP version 4 or 6, version 4 preferred
SOATAG_AF_IP6_IP4 (4) either IP version 4 or 6, version 6 preferred
Corresponding tag taking reference parameter is SOATAG_AF_REF()

#define SOATAG_CAPS_SDP (  ) 

Pass parsed capability description to soa session object.

Used with
nua_set_params()
nua_get_params()
nua_create()
Parameter type
char const *
Values
NULL terminated character string
Corresponding tag taking reference parameter is SOATAG_CAPS_SDP_REF()

#define SOATAG_CAPS_SDP_STR (  ) 

Pass capability description to soa session object.

Pass name of media description file that contains media templates (normally mss.sdp) to the NUA stack.

Used with
nua_set_params()
nua_get_params()
nua_create()
Parameter type
char const *
Values
NULL terminated character string
Corresponding tag taking reference parameter is SOATAG_CAPS_SDP_STR_REF()

#define SOATAG_HOLD (  ) 

Hold & unhold.

Used with
nua_invite()
nua_update()
Parameter type
unsigned int
Values
1 hold call
0 unhold call
Corresponding tag taking reference parameter is SOATAG_HOLD_REF()

#define SOATAG_REMOTE_SDP (  ) 

Pass parsed remote session description to soa session object.

Used with
soa_set_params(), soa_get_params(), soa_get_paramlist()
Parameter type
char const *
Values
pointer to sdp_session_t.
Corresponding tag taking reference parameter is SOATAG_REMOTE_SDP_REF()

#define SOATAG_REMOTE_SDP_STR (  ) 

Pass media description file name to the NUA stack.

Pass name of media description file that contains media templates (normally mss.sdp) to the NUA stack.

Used with
nua_set_params()
nua_get_params()
nua_create()
Parameter type
char const *
Values
NULL terminated character string
Corresponding tag taking reference parameter is SOATAG_REMOTE_SDP_STR_REF()

#define SOATAG_RTP_MISMATCH (  ) 

Accept media line even if the SDP negotation code determines that there are no common codecs between local and remote media.

Normally, if the soa determines there are no common codecs, the media line is rejected.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_update()
nua_respond()
Parameter type
Boolean (int)
Values
0 - reject media if there are no common codecs
1 (!= 0) - accept media even if there are no common codecs
Default value is 0.

Corresponding tag taking reference parameter is SOATAG_RTP_MISMATCH_REF()

#define SOATAG_RTP_SELECT (  ) 

When generating answer or second offer, soa can include all the supported codec, only one codec, or only the codecs supported by both ends in the list of payload types on the m= line.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_update()
nua_respond()
Parameter type
integer in range 0..2
Values
0 - select the best common codec
1 - select all common codecs
2 - select all local codecs
The default value is 0, only one RTP codec is selected. Note, however, that if there is no common codec (no local codec is supported by remote end), all the codecs are included in the list. In that case the media line is rejected, too, unless SOATAG_RTP_MISMATCH(1) has been used.

Corresponding tag taking a reference parameter is SOATAG_RTP_SELECT_REF()

#define SOATAG_RTP_SORT (  ) 

When selecting the common codecs, soa can either select first local codec supported by remote end, or first remote codec supported by local codecs.

The preference is indicated with ordering: the preferred codec is first and so on.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_update()
nua_respond()
Parameter type
Boolean (int)
Values
0 - select by local preference if media is recvonly, remote preference othewise
1 - always select by local preference
2 - always select by remote preference
The default value is 0.

Corresponding tag taking reference parameter is SOATAG_RTP_SORT_REF()

#define SOATAG_SRTP_CONFIDENTIALITY (  ) 

Enable SRTP confidentiality.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_respond()
Parameter type
int
Values
1 hold call
0 unhold call
Corresponding tag taking reference parameter is SOATAG_SRTP_CONFIDENTIALITY_REF()

#define SOATAG_SRTP_ENABLE (  ) 

Enable SRTP.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_respond()
Parameter type
unsigned int
Values
1 hold call
0 unhold call
Corresponding tag taking reference parameter is SOATAG_SRTP_ENABLE_REF()

#define SOATAG_SRTP_INTEGRITY (  ) 

Enable SRTP integrity protection.

Used with
nua_set_params()
nua_get_params()
nua_invite()
nua_respond()
Parameter type
int
Values
!=0 enable 0 disable
Corresponding tag taking reference parameter is SOATAG_SRTP_INTEGRITY_REF()

#define SOATAG_USER_SDP (  ) 

Pass parsed user session description to soa session object.

Used with
soa_set_params(), soa_get_params(), soa_get_paramlist()
Parameter type
char const *
Values
pointer to sdp_session_t.
Corresponding tag taking reference parameter is SOATAG_USER_SDP_REF()

#define SOATAG_USER_SDP_STR (  ) 

Pass media description file name to the NUA stack.

Pass name of media description file that contains media templates (normally mss.sdp) to the NUA stack.

Used with
nua_set_params()
nua_get_params()
nua_create()
Parameter type
char const *
Values
NULL terminated character string
Corresponding tag taking reference parameter is SOATAG_USER_SDP_STR_REF()


Enumeration Type Documentation

anonymous enum

Media states.

Enumerator:
SOA_ACTIVE_REJECTED  Media rejected in negotiation.
SOA_ACTIVE_DISABLED  Media not negotiated.
SOA_ACTIVE_INACTIVE  Media is inactive: no RTP.
SOA_ACTIVE_SENDONLY  Media is sent only.
SOA_ACTIVE_RECVONLY  Media is received only.
SOA_ACTIVE_SENDRECV  Media is bidirectional.


Sofia-SIP 1.12.1 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.