flutter_pjsip_bindings_generated library

Classes

FlutterPjsipBindings

Bindings for src/flutter_pjsip.h.

in6_addr

IPv6 address

in_addr

Internet address (a structure for historical reasons)

pj_addr_hdr

This structure describes common attributes found in transport addresses. If PJ_SOCKADDR_HAS_LEN is not zero, then sa_zero_len member is added to this struct. As far the application is concerned, the value of this member will always be zero. Internally, PJLIB may modify the value before calling OS socket API, and reset the value back to zero before returning the struct to application.

pj_atomic_t

pj_grp_lock_t

pj_ice_sess_options

This structure describes various ICE session options. Application configure the ICE session with these options by calling #pj_ice_sess_set_options().

pj_ice_sess_trickle

This enumeration describes the modes of trickle ICE.

pj_ice_strans_op

Transport operation types to be reported on \a on_status() callback

pj_ioqueue_op_key_t

This structure describes operation specific key to be submitted to I/O Queue when performing the asynchronous operation. This key will be returned to the application when completion callback is called.

pj_ioqueue_t

pj_lock_t

pj_mutex_t

pj_pool_block

This class, which is used internally by the pool, describes a single block of memory from which user memory allocations will be allocated from.

pj_pool_factory

This structure contains the declaration for pool factory interface.

pj_pool_factory_policy

This structure declares pool factory interface.

pj_pool_t

This structure describes the memory pool. Only implementors of pool factory need to care about the contents of this structure.

pj_qos_params

QoS parameters to be set or retrieved to/from the socket.

pj_qos_type

High level traffic classification.

pj_qos_wmm_prio

Standard WMM priorities.

pj_sockaddr

This union describes a generic socket address.

pj_sockaddr_in

This structure describes Internet socket address. If PJ_SOCKADDR_HAS_LEN is not zero, then sin_zero_len member is added to this struct. As far the application is concerned, the value of this member will always be zero. Internally, PJLIB may modify the value before calling OS socket API, and reset the value back to zero before returning the struct to application.

pj_sockaddr_in6

This structure describes IPv6 socket address. If PJ_SOCKADDR_HAS_LEN is not zero, then sin_zero_len member is added to this struct. As far the application is concerned, the value of this member will always be zero. Internally, PJLIB may modify the value before calling OS socket API, and reset the value back to zero before returning the struct to application.

pj_sockopt_params

Options to be set for the socket.

pj_ssl_cert_info

Describe structure of certificate info.

pj_ssl_cert_name_type

Type of SSL certificate name.

pj_ssl_cipher

Cipher suites enumeration.

pj_ssl_curve

Elliptic curves enumeration.

pj_ssl_entropy

Entropy enumeration

pj_ssl_sock_cb

This structure contains the callbacks to be called by the secure socket.

pj_ssl_sock_param

Definition of secure socket creation parameters.

pj_ssl_sock_t

pj_str_t

/ / Data structure types. / /** This type is used as replacement to legacy C string, and used throughout the library. By convention, the string is NOT null terminated.

pj_stun_attr_hdr

pj_stun_auth_cred

This structure contains the descriptions needed to perform server side authentication. Depending on the \a type set in the structure, application may specify a static username/password combination, or to have callbacks called by the function to authenticate the credential dynamically.

pj_stun_auth_cred_type

Type of authentication data in the credential.

pj_stun_msg

This structure describes a parsed STUN message. All integral fields in this structure (including IP addresses) will be in the host byte order.

pj_stun_msg_hdr

pj_stun_nat_detect_result

This structure contains the result of NAT classification function.

pj_stun_nat_type

This enumeration describes the NAT types, as specified by RFC 3489 Section 5, NAT Variations.

pj_stun_passwd_type

Type of encoding applied to the password stored in the credential.

pj_stun_resolve_result

This structure is used to represent the result of the STUN server resolution and testing, the #pjsua_resolve_stun_servers() function. This structure will be passed in #pj_stun_resolve_cb callback.

pj_time_val

Representation of time value in this library. This type can be used to represent either an interval or a specific time or date.

pj_timer_entry

This structure represents an entry to the timer.

pj_timer_heap_t

pj_timestamp

This structure represents high resolution (64bit) time value. The time values represent time in cycles, which is retrieved by calling #pj_get_timestamp().

pj_turn_sock_tls_cfg

TLS transport settings.

pj_turn_tp_type

TURN transport types, which will be used both to specify the connection type for reaching TURN server and the type of allocation transport to be requested to server (the REQUESTED-TRANSPORT attribute).

pj_xml_attr

This structure declares XML attribute.

pj_xml_node

This structure describes XML node.

pj_xml_node_head

This structure describes XML node head inside XML node structure.

pjmedia_aud_dev_cap

This enumeration identifies various audio device capabilities. These audio capabilities indicates what features are supported by the underlying audio device implementation.

pjmedia_aud_dev_info

Device information structure returned by #pjmedia_aud_dev_get_info().

pjmedia_aud_dev_route

This enumeration describes audio routing/source setting.

pjmedia_aud_param

This structure specifies the parameters to open the audio stream.

pjmedia_audio_format_detail

This structure is put in \a detail field of #pjmedia_format to describe detail information about an audio media.

pjmedia_clock_src

Media clock source.

pjmedia_codec_fmtp

Structure of codec specific parameters which contains name=value pairs. The codec specific parameters are to be used with SDP according to the standards (e.g: RFC 3555) in SDP 'a=fmtp' attribute.

pjmedia_codec_info

Identification used to search for codec factory that supports specific codec specification.

pjmedia_codec_param

Detailed codec attributes used in configuring a codec and in querying the capability of codec factories. Default attributes of any codecs could be queried using #pjmedia_codec_mgr_get_default_param() and modified using #pjmedia_codec_mgr_set_default_param().

pjmedia_coord

This structure represent a coordinate.

pjmedia_dir

Media direction.

pjmedia_echo_stat

Echo cancellation statistics.

pjmedia_endpt

pjmedia_event

This structure describes a media event. It consists mainly of the event type and additional data/parameters for the event. Applications can use #pjmedia_event_init() to initialize this event structure with basic information about the event.

pjmedia_event_aud_dev_err_data

Additional data/parameters for audio device error event.

pjmedia_event_dummy_data

Additional data/parameters are not needed.

pjmedia_event_fmt_changed_data

Additional data/parameters for media format changed event (PJMEDIA_EVENT_FMT_CHANGED).

pjmedia_event_media_tp_err_data

Additional data/parameters for media transmit error event.

pjmedia_event_rx_rtcp_fb_data

Event data for incoming RTCP Feedback message event (PJMEDIA_EVENT_RX_RTCP_FB).

pjmedia_event_type

This enumeration describes list of media events.

pjmedia_event_vid_dev_err_data

Additional data/parameters for video device error event.

pjmedia_event_wnd_closing_data

Additional data/parameters for window closing event.

pjmedia_event_wnd_resized_data

Additional data/parameters for window resized event (PJMEDIA_EVENT_WND_RESIZED).

pjmedia_format

This structure contains all the information needed to completely describe a media.

pjmedia_format_detail_type

This enumeration specifies what type of detail is included in a #pjmedia_format structure.

pjmedia_format_id

This enumeration uniquely identify audio sample and/or video pixel formats. Some well known formats are listed here. The format ids are built by combining four character codes, similar to FOURCC. The format id is extensible, as application may define and use format ids not declared on this enumeration.

pjmedia_frame

This structure describes a media frame.

pjmedia_frame_type

Types of media frame.

pjmedia_jb_discard_algo

Enumeration of jitter buffer discard algorithm. The jitter buffer continuously calculates the jitter level to get the optimum latency at any time and in order to adjust the latency, the jitter buffer may need to discard some frames.

pjmedia_port

Port interface.

pjmedia_port_info

Port info.

pjmedia_ratio

This structure is used to represent rational numbers.

pjmedia_rect_size

This structure represents rectangle size.

pjmedia_rtcp_fb_cap

This structure declare RTCP Feedback capability.

pjmedia_rtcp_fb_info

This structure declares RTCP Feedback information.

pjmedia_rtcp_fb_nack

This structure declares RTCP Feedback Generic NACK message.

pjmedia_rtcp_fb_rpsi

This structure declares RTCP Feedback Reference Picture Selection Indication (RPSI) message.

pjmedia_rtcp_fb_setting

This structure declares RTCP Feedback configuration settings.

pjmedia_rtcp_fb_sli

This structure declares RTCP Feedback Slice Loss Indication (SLI) message.

pjmedia_rtcp_fb_type

Enumeration of RTCP Feedback types. Each feedback type may have subtypes, which should be specified in feedback parameters.

pjmedia_sdp_attr

Generic representation of attribute.

pjmedia_sdp_bandw

This structure describes SDP bandwidth info ("b=" line).

pjmedia_sdp_conn

This structure describes SDP connection info ("c=" line).

pjmedia_sdp_media

This structure describes SDP media descriptor. A SDP media descriptor starts with "m=" line and contains the media attributes and optional connection line.

pjmedia_sdp_session

This structure describes SDP session description. A SDP session descriptor contains complete information about a session, and normally is exchanged with remote media peer using signaling protocol such as SIP.

pjmedia_snd_dev_info

Device information structure returned by #pjmedia_snd_get_dev_info.

pjmedia_snd_port

pjmedia_snd_port_param

This structure specifies the parameters to create the sound port. Use pjmedia_snd_port_param_default() to initialize this structure with default values (mostly zeroes)

pjmedia_sock_info

Media socket info is used to describe the underlying sockets to be used as media transport.

pjmedia_srtp_cb

Structure containing callbacks to receive SRTP notifications.

pjmedia_srtp_crypto

This structure describes an individual crypto setting.

pjmedia_srtp_keying_method

This enumeration specifies SRTP keying methods.

pjmedia_srtp_roc

RTP sequence rollover counter settings.

pjmedia_srtp_setting

Settings to be given when creating SRTP transport. Application should call #pjmedia_srtp_setting_default() to initialize this structure with its default values.

pjmedia_srtp_use

This enumeration specifies the behavior of the SRTP transport regarding media security offer and answer.

pjmedia_stream

pjmedia_stream_info

This structure describes media stream information. Each media stream corresponds to one "m=" line in SDP session descriptor, and it has its own RTP/RTCP socket pair.

pjmedia_tp_cb_param

This structure describes the data passed when calling #rtp_cb2().

pjmedia_tp_proto

Media transport protocol and profile.

pjmedia_transport

This structure declares media transport. A media transport is called by the stream to transmit a packet, and will notify stream when incoming packet is arrived.

pjmedia_transport_attach_param

This structure describes the data passed when calling #pjmedia_transport_attach2().

pjmedia_transport_info

This structure describes transport informations, including general socket information and specific information of single transport or stacked transports (e.g: SRTP stacked on top of UDP)

pjmedia_transport_op

This structure describes the operations for the stream transport.

pjmedia_transport_specific_info

This structure describes storage buffer of transport specific info. The actual transport specific info contents will be defined by transport implementation. Note that some transport implementations do not need to provide specific info, since the general socket info is enough.

pjmedia_transport_type

Media transport type.

pjmedia_type

Top most media type. See also #pjmedia_type_name().

pjmedia_vid_codec_info

Identification used to search for codec factory that supports specific codec specification.

pjmedia_vid_codec_param

Detailed codec attributes used in configuring a codec and in querying the capability of codec factories. Default attributes of any codecs could be queried using #pjmedia_vid_codec_mgr_get_default_param() and modified using #pjmedia_vid_codec_mgr_set_default_param().

pjmedia_vid_dev_cap

This enumeration identifies various video device capabilities. These video capabilities indicates what features are supported by the underlying video device implementation.

pjmedia_vid_dev_fullscreen_flag

Enumeration of window fullscreen flags.

pjmedia_vid_dev_hwnd

Type for window handle.

pjmedia_vid_dev_hwnd_type

Enumeration of window handle type.

pjmedia_vid_dev_info

Device information structure returned by #pjmedia_vid_dev_get_info().

pjmedia_vid_packing

This enumeration specifies the packetization property of video encoding process. The value is bitmask, and smaller value will have higher priority to be used.

pjmedia_vid_stream_info

This structure describes video stream information. Each video stream corresponds to one "m=" line in SDP session descriptor, and it has its own RTP/RTCP socket pair.

pjmedia_vid_stream_rc_config

Structure of configuration settings for video stream sending rate control.

pjmedia_vid_stream_rc_method

Enumeration of video stream sending rate control.

pjmedia_vid_stream_sk_config

Structure of configuration settings for video stream sending keyframe after it is created.

pjmedia_video_format_detail

This structure is put in \a detail field of #pjmedia_format to describe detail information about a video media.

pjmedia_wav_player_info

Additional information about the WAV player.

pjrpid_activity

This enumeration describes subset of standard activities as described by RFC 4480, RPID: Rich Presence Extensions to the Presence Information Data Format (PIDF).

pjrpid_element

This structure describes person information in RPID document.

pjrpid_element_type

This enumeration describes types of RPID element.

pjsip_auth_clt_pref

This structure describes client authentication session preference. The preference can be set by calling #pjsip_auth_clt_set_prefs().

pjsip_buffer

General purpose buffer.

pjsip_cid_hdr

Call-ID header.

pjsip_clen_hdr

/ /** Content-Length header.

pjsip_contact_hdr

Contact header. In this library, contact header only contains single URI. If a message has multiple URI in the Contact header, the URI will be put in separate Contact headers.

pjsip_cred_info

This structure describes credential information. A credential information is a static, persistent information that identifies username and password required to authorize to a specific realm.

pjsip_cseq_hdr

/ /** CSeq header.

pjsip_ctype_hdr

/ /** Content-Type.

pjsip_dialog_cap_status

Dialog capability status.

pjsip_digest_challenge

This structure describes authentication challenge used in Proxy-Authenticate or WWW-Authenticate for digest authentication scheme.

pjsip_digest_credential

This structure describe credential used in Authorization and Proxy-Authorization header for digest authentication scheme.

pjsip_endpoint

pjsip_event

This structure describe event descriptor to fully identify a SIP event.

pjsip_event_id_e

Event IDs.

pjsip_evsub

pjsip_evsub_state

This enumeration describes basic subscription state as described in the RFC 3265. The standard specifies that extensions may define additional states. In the case where the state is not known, the subscription state will be set to PJSIP_EVSUB_STATE_UNKNOWN, and the token will be kept in state_str member of the susbcription structure.

pjsip_fromto_hdr

/ /** To or From header.

pjsip_generic_array_hdr

Generic array of string header.

pjsip_generic_int_hdr

Generic SIP header, which contains hname and an integer ivalue.

pjsip_hdr

Generic SIP header structure, for generic manipulation for headers in the message. All header fields can be typecasted to this type.

pjsip_hdr_e

Header types, as defined by RFC3261.

pjsip_hdr_vptr

This structure provides the pointer to basic functions that are needed for generic header operations. All header fields will have pointer to this structure, so that they can be manipulated uniformly.

pjsip_host_info

Host information.

pjsip_host_port

General host:port pair, used for example as Via sent-by.

pjsip_inv_state

This enumeration describes invite session state.

pjsip_media_type

This structure describes SIP media type, as used for example in Accept and Content-Type header..

pjsip_method

This structure represents a SIP method. Application must always use either #pjsip_method_init or #pjsip_method_set to make sure that method name is initialized correctly. This way, the name member will always contain a valid method string regardless whether the ID is recognized or not.

pjsip_method_e

This enumeration declares SIP methods as described by RFC3261. Additional methods do exist, and they are described by corresponding RFCs for the SIP extentensions. Since they won't alter the characteristic of the processing of the message, they don't need to be explicitly mentioned here.

pjsip_module

The declaration for SIP module. This structure would be passed to #pjsip_endpt_register_module() to register the module to PJSIP.

pjsip_msg

This structure describes a SIP message.

pjsip_msg_body

Generic abstraction to message body. When an incoming message is parsed (pjsip_parse_msg()), the parser fills in all members with the appropriate value. The 'data' and 'len' member will describe portion of incoming packet which denotes the message body. When application needs to attach message body to outgoing SIP message, it must fill in all members of this structure.

pjsip_msg_type_e

Message type (request or response).

pjsip_multipart_part

This structure describes the individual body part inside a multipart message body. It mainly contains the message body itself and optional headers.

pjsip_name_addr

SIP name-addr, which typically appear in From, To, and Contact header. The SIP name-addr contains a generic URI and a display name.

pjsip_param

Generic parameter, normally used in other_param or header_param.

pjsip_parser_err_report

This structure is used to get error reporting from parser.

pjsip_pres_status

This structure describes presence status of a presentity.

pjsip_publishc_opt

Client publication options. Application should initialize this structure with its default values by calling #pjsip_publishc_opt_default()

pjsip_redirect_op

These enumerations specify the action to be performed to a redirect response.

pjsip_regc

pjsip_regc_cbparam

Structure to hold parameters when calling application's callback. The application's callback is called when the client registration process has finished.

pjsip_request_line

This structure describes SIP request line.

pjsip_response_addr

This structure describes destination information to send response. It is initialized by calling #pjsip_get_response_addr().

pjsip_role_e

Transaction role.

pjsip_routing_hdr

/ /** Record-Route and Route headers.

pjsip_rx_data

Incoming message buffer. This structure keep all the information regarding the received message. This buffer lifetime is only very short, normally after the transaction has been called, this buffer will be deleted/recycled. So care must be taken when allocating storage from the pool of this buffer.

pjsip_rx_data_op_key

A customized ioqueue async operation key which is used by transport to locate rdata when a pending read operation completes.

pjsip_server_address_record

Address records.

pjsip_server_addresses

The server addresses returned by the resolver.

pjsip_ssl_method

SSL protocol method constants.

pjsip_status_code

This enumeration lists standard SIP status codes according to RFC 3261. In addition, it also declares new status class 7xx for errors generated by the stack. This status class however should not get transmitted on the wire.

pjsip_status_line

This structure describes SIP status line.

pjsip_timer_setting

This structure describes Session Timers settings in an invite session.

pjsip_tls_on_accept_fail_param

This structure describe the parameter passed from on_accept_fail_cb().

pjsip_tls_on_verify_param

This structure describe the parameter passed from on_verify_cb().

pjsip_tls_setting

TLS transport settings.

pjsip_tpfactory

A transport factory is normally used for connection oriented transports (such as TCP or TLS) to create instances of transports. It registers a new transport type to the transport manager, and the transport manager would ask the factory to create a transport instance when it received command from application to send a SIP message using the specified transport type.

pjsip_tpmgr

pjsip_tpselector

This structure describes the transport/listener preference to be used when sending outgoing requests.

pjsip_tpselector_ip_ver

This enumerator describes the IP version criteria for pjsip_tpselector.

pjsip_tpselector_type

This structure describes the type of data in pjsip_tpselector.

pjsip_transaction

This structure describes SIP transaction object. The transaction object is used to handle both UAS and UAC transaction.

pjsip_transport

This structure represent the "public" interface of a SIP transport. Applications normally extend this structure to include transport specific members.

pjsip_transport_dir

Enumeration of transport direction types.

pjsip_transport_key

This structure describes transport key to be registered to hash table.

pjsip_transport_state

Enumeration of transport state types.

pjsip_transport_state_info

Structure of transport state info passed by #pjsip_tp_state_callback.

pjsip_transport_type_e

Transport types.

pjsip_tsx_state_e

This enumeration represents transaction state.

pjsip_tx_data

Data structure for sending outgoing message. Application normally creates this buffer by calling #pjsip_endpt_create_tdata.

pjsip_tx_data_op_key

Customized ioqueue async operation key, used by transport to keep callback parameters.

pjsip_uri

The declaration of 'base class' for all URI scheme.

pjsip_uri_context_e

URI context.

pjsip_uri_vptr

URI 'virtual' function table. All types of URI in this library (such as sip:, sips:, tel:, and name-addr) will have pointer to this table as their first struct member. This table provides polimorphic behaviour to the URI.

pjsip_via_hdr

/ /** SIP Via header. In this implementation, Via header can only have one element in each header. If a message arrives with multiple elements in a single Via, then they will be split up into multiple Via headers.

pjsua_100rel_use

This constants controls the use of 100rel extension.

pjsua_acc_config

This structure describes account configuration to be specified when adding a new account with #pjsua_acc_add(). Application MUST initialize this structure first by calling #pjsua_acc_config_default().

pjsua_acc_info

Account info. Application can query account info by calling #pjsua_acc_get_info().

pjsua_buddy_config

This structure describes buddy configuration when adding a buddy to the buddy list with #pjsua_buddy_add(). Application MUST initialize the structure with #pjsua_buddy_config_default() to initialize this structure with default configuration.

pjsua_buddy_info

This structure describes buddy info, which can be retrieved by calling #pjsua_buddy_get_info().

pjsua_buddy_status

This enumeration describes basic buddy's online status.

pjsua_call_flag

Flags to be given to various call APIs. More than one flags may be specified by bitmasking them.

pjsua_call_hold_type

This enumeration specifies how we should offer call hold request to remote peer. The default value is set by compile time constant PJSUA_CALL_HOLD_TYPE_DEFAULT, and application may control the setting on per-account basis by manipulating \a call_hold_type field in #pjsua_acc_config.

pjsua_call_info

This structure describes the information and current status of a call.

pjsua_call_media_info

Call media information.

pjsua_call_media_status

This enumeration specifies the media status of a call, and it's part of pjsua_call_info structure.

pjsua_call_send_dtmf_param

Parameters for sending DTMF. Application should use #pjsua_call_send_dtmf_param_default() to initialize this structure with its default values.

pjsua_call_setting

Call settings.

pjsua_call_vid_strm_op

This enumeration represents video stream operation on a call. See also #pjsua_call_vid_strm_op_param for further info.

pjsua_call_vid_strm_op_param

Parameters for video stream operation on a call. Application should use #pjsua_call_vid_strm_op_param_default() to initialize this structure with its default values.

pjsua_callback

This structure describes application callback to receive various event notification from PJSUA-API. All of these callbacks are OPTIONAL, although definitely application would want to implement some of the important callbacks (such as \a on_incoming_call).

pjsua_codec_info

This structure describes codec information, which can be retrieved by calling #pjsua_enum_codecs().

pjsua_conf_connect_param

This structure specifies the parameters for conference ports connection. Use pjsua_conf_connect_param_default() to initialize this structure with default values.

pjsua_conf_port_info

This structure describes information about a particular media port that has been registered into the conference bridge. Application can query this info by calling #pjsua_conf_get_port_info().

pjsua_config

This structure describes the settings to control the API and user agent behavior, and can be specified when calling #pjsua_init(). Before setting the values, application must call #pjsua_config_default() to initialize this structure with the default values.

pjsua_contact_rewrite_method

This enumeration specifies the contact rewrite method.

pjsua_create_media_transport_flag

This enumeration specifies the options for custom media transport creation.

pjsua_destroy_flag

Flags to be given to pjsua_destroy2()

pjsua_dtmf_event

This will contain the information of the callback \a on_dtmf_event.

pjsua_dtmf_info

This will contain the information of the callback \a on_dtmf_digit2.

pjsua_dtmf_method

This enumeration specifies DTMF method.

pjsua_ext_snd_dev

pjsua_ice_config

ICE setting. This setting is used in the pjsua_acc_config.

pjsua_ice_config_use

This enumeration controls the use of ICE settings in the account.

pjsua_invalid_id_const_

Constant to identify invalid ID for all sorts of IDs.

pjsua_ip_change_acc_cfg

This structure describe the account config specific to IP address change.

pjsua_ip_change_op

This enumeration specifies the operation when handling IP change.

pjsua_ip_change_op_info

This will contain the information of the callback \a on_ip_change_progress.

pjsua_ip_change_param

This structure describe the parameter passed to #pjsua_handle_ip_change().

pjsua_ipv6_use

Specify how IPv6 transport should be used in account config. IP version preference only applies for outgoing direction, for incoming direction, we will check the corresponding message/offer and match it.

pjsua_logging_config

Logging configuration, which can be (optionally) specified when calling #pjsua_init(). Application must call #pjsua_logging_config_default() to initialize this structure with the default values.

pjsua_med_tp_st

Enumeration of media transport state types.

pjsua_med_tp_state_info

Structure to be passed on media transport state callback.

pjsua_media_config

This structure describes media configuration, which will be specified when calling #pjsua_init(). Application MUST initialize this structure by calling #pjsua_media_config_default().

pjsua_media_transport

This structure holds information about custom media transport to be registered to pjsua.

pjsua_msg_data

This structure describes additional information to be sent with outgoing SIP message. It can (optionally) be specified for example with #pjsua_call_make_call(), #pjsua_call_answer(), #pjsua_call_hangup(), #pjsua_call_set_hold(), #pjsua_call_send_im(), and many more.

pjsua_mwi_info

Structure to be passed on MWI callback.

pjsua_nat64_opt

Specify NAT64 options to be used in account config.

pjsua_on_rejected_incoming_call_param

This will contain the information passed from the callback \a pjsua_on_rejected_incoming_call_cb.

pjsua_on_stream_created_param

Structure to be passed to on stream created callback. See on_stream_created2().

pjsua_on_stream_precreate_param

Structure to be passed to on stream precreate callback. See on_stream_precreate().

pjsua_reg_info

Structure to be passed on registration callback.

pjsua_sip_timer_use

This enumeration specifies the usage of SIP Session Timers extension.

pjsua_snd_dev_id

Sound device index constants.

pjsua_snd_dev_mode

This enumeration specifies the sound device mode.

pjsua_snd_dev_param

This structure specifies the parameters to set the sound device. Use pjsua_snd_dev_param_default() to initialize this structure with default values.

pjsua_srtp_opt

Specify SRTP media transport settings.

pjsua_srv_pres

pjsua_state

This enumeration represents pjsua state.

pjsua_stream_info

Media stream info.

pjsua_stream_stat

Media stream statistic.

pjsua_stun_use

This enumeration controls the use of STUN in the account.

pjsua_transport_config

Transport configuration for creating transports for both SIP and media. Before setting some values to this structure, application MUST call #pjsua_transport_config_default() to initialize its values with default settings.

pjsua_transport_info

This structure describes transport information returned by #pjsua_transport_get_info() function.

pjsua_turn_config

TURN setting. This setting is used in the pjsua_acc_config.

pjsua_turn_config_use

This enumeration controls the use of TURN settings in the account.

pjsua_upnp_use

This enumeration controls the use of UPnP in the account.

pjsua_vid_conf_port_info

This structure describes information about a particular video media port that has been registered into the video conference bridge. Application can query this info by calling #pjsua_vid_conf_get_port_info().

pjsua_vid_preview_param

Parameters for starting video preview with pjsua_vid_preview_start(). Application should initialize this structure with pjsua_vid_preview_param_default().

pjsua_vid_req_keyframe_method

Enumeration of video keyframe request methods. Keyframe request is triggered by decoder, usually when the incoming video stream cannot be decoded properly due to missing video keyframe.

pjsua_vid_win_info

This structure describes video window info.

port_data

Port data can be used by the port creator to attach arbitrary value to be associated with the port.

the_param

UnnamedStruct1

tp_info is part of rdata that remains static for the duration of the buffer. It is initialized when the buffer was created by transport.

UnnamedStruct11

The information from listener restart operation.

UnnamedStruct12

The information from shutdown transport.

UnnamedStruct13

The information from updating contact.

UnnamedStruct14

The information from hanging up call operation.

UnnamedStruct15

The information from re-Invite call operation.

UnnamedStruct16

Internal.

UnnamedStruct17

Timer event.

UnnamedStruct18

Transaction state has changed event.

UnnamedStruct19

Message transmission event.

UnnamedStruct2

Destination information, to be used to determine the network address of the message. For a request, this information is initialized when the request is sent with #pjsip_endpt_send_request_stateless() and network address is resolved. For CANCEL request, this information will be copied from the original INVITE to make sure that the CANCEL request goes to the same physical network address as the INVITE request.

UnnamedStruct20

Transmission error event.

UnnamedStruct21

Message arrival event.

UnnamedStruct22

User event.

UnnamedStruct23

Session origin (o= line)

UnnamedStruct24

Session time (t= line)

UnnamedStruct25

Media descriptor line ("m=" line)

UnnamedStruct26

Digest AKA credential information. Note that when AKA credential is being used, the \a data field of this #pjsip_cred_info is not used, but it still must be initialized to an empty string. Please see \ref PJSIP_AUTH_AKA_API for more information.

UnnamedStruct27

This structure contains static data for performing authentication. A non-empty realm indicates whether short term or long term credential is used.

UnnamedStruct28

This structure contains callback to be called by the framework to authenticate the incoming message.

UnnamedStruct29

Array of options to be applied.

UnnamedStruct3

Transport information, only valid during on_tx_request() and on_tx_response() callback.

UnnamedStruct30

UnnamedStruct31

UnnamedStruct32

UnnamedStruct33

UnnamedStruct34

UnnamedStruct35

UnnamedStruct36

Audio stream

UnnamedStruct37

Video stream

UnnamedStruct38

Internal

UnnamedStruct39

UnnamedStruct4

UnnamedStruct40

UnnamedStruct41

UnnamedStruct42

UnnamedStruct43

UnnamedStruct44

UnnamedStruct5

pkt_info is initialized by transport when it receives an incoming packet.

UnnamedStruct6

msg_info is initialized by transport mgr (tpmgr) before this buffer is passed to endpoint.

UnnamedStruct7

endpt_info is initialized by endpoint after this buffer reaches endpoint.

UnnamedUnion1

UnnamedUnion10

Extended data

UnnamedUnion11

This union contains the authentication data.

UnnamedUnion12

The specific media stream info.

UnnamedUnion13

The window handle.

UnnamedUnion2

The first line of the message can be either request line for request messages, or status line for response messages. It is represented here as a union.

UnnamedUnion3

Union representing the transport/listener/IP version criteria to be used.

UnnamedUnion4

Stream info (union).

UnnamedUnion5

Detail section to describe the media.

UnnamedUnion6

The event body as union, which fields depends on the event type. By convention, the first member of each struct in the union must be the pointer which is relevant to the event.

UnnamedUnion7

UnnamedUnion8

Additional data/parameters about the event. The type of data will be specific to the event type being reported.

UnnamedUnion9

Constants

DISABLED_FOR_TICKET_1185 → const int

PJSUA_ACC_MAX_PROXIES → const int

PJSUA_ACQUIRE_CALL_TIMEOUT → const int

PJSUA_ADD_ICE_TAGS → const int

PJSUA_CALL_HOLD_TYPE_DEFAULT → const int

PJSUA_CALL_SEND_DTMF_DURATION_DEFAULT → const int

PJSUA_CONTACT_REWRITE_METHOD → const int

PJSUA_DEFAULT_ACC_PRIORITY → const int

PJSUA_DEFAULT_AUDIO_FRAME_PTIME → const int

PJSUA_DEFAULT_CLOCK_RATE → const int

PJSUA_DEFAULT_EC_TAIL_LEN → const int

PJSUA_DEFAULT_ILBC_MODE → const int

PJSUA_DEFAULT_SRTP_SECURE_SIGNALING → const int

PJSUA_DEFAULT_USE_SRTP → const int

PJSUA_DISABLE_AUTO_SEND_100 → const int

PJSUA_DONT_INIT_VID_DEV_SUBSYS → const int

PJSUA_HAS_VIDEO → const int

PJSUA_ICE_TRANSPORT_OPTION → const int

PJSUA_LOCK_CODEC_DONT_USE_UPDATE → const int

PJSUA_MAX_VID_WINS → const int

PJSUA_MEDIA_HAS_PJMEDIA → const int

PJSUA_POOL_INC → const int

PJSUA_POOL_INC_ACC → const int

PJSUA_POOL_LEN → const int

PJSUA_POOL_LEN_ACC → const int

PJSUA_PRES_TIMER → const int

PJSUA_PUBLISH_EXPIRATION → const int

PJSUA_REG_AUTO_REG_REFRESH → const int

PJSUA_REG_INTERVAL → const int

PJSUA_REG_RETRY_INTERVAL → const int

PJSUA_REG_USE_ACC_PROXY → const int

PJSUA_REG_USE_OUTBOUND_PROXY → const int

PJSUA_SDP_SESS_HAS_CONN → const int

PJSUA_SEPARATE_WORKER_FOR_TIMER → const int

PJSUA_THIRD_PARTY_STREAM_HAS_GET_INFO → const int

PJSUA_THIRD_PARTY_STREAM_HAS_GET_STAT → const int

PJSUA_TRANSPORT_RESTART_DELAY_TIME → const int

PJSUA_TRICKLE_ICE_NEW_CAND_CHECK_INTERVAL → const int

PJSUA_UNKNOWN_DTMF_DURATION → const int

PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC → const int

PJSUA_UNREG_TIMEOUT → const int

PJSUA_VID_REQ_KEYFRAME_INTERVAL → const int

PJSUA_XFER_NO_REQUIRE_REPLACES → const int

Typedefs

in_addr_t = __uint32_t

pj_bool_t = Int

Boolean.

pj_in6_addr = in6_addr

This structure describes IPv6 address.

pj_in_addr = in_addr

This structure describes Internet address.

pj_int32_t = Int

Signed 32bit integer.

pj_pool_callback = NativeFunction<Void Function(Pointer<pj_pool_t> pool, pj_size_t size)>

The type for function to receive callback from the pool when it is unable to allocate memory. The elegant way to handle this condition is to throw exception, and this is what is expected by most of this library components.

pj_size_t = Size

Large unsigned integer.

pj_sock_t = Long

pj_sockaddr_t = Void

Generic socket address.

pj_ssize_t = Long

pj_ssl_cert_buffer = pj_str_t

The SSL certificate buffer.

pj_status_t = Int

Status code.

pj_stun_resolve_cb = Pointer<NativeFunction<Void Function(Pointer<pj_stun_resolve_result> result)>>

Typedef of callback to be registered to #pjsua_resolve_stun_servers() and to be called when STUN resolution completes.

pj_timer_heap_callback = NativeFunction<Void Function(Pointer<pj_timer_heap_t> timer_heap, Pointer<pj_timer_entry> entry)>

The type of callback function to be called by timer scheduler when a timer has expired.

pj_timer_id_t = Int

The type for internal timer ID.

pj_uint16_t = UnsignedShort

Unsigned 16bit integer.

pj_uint32_t = UnsignedInt

Unsigned 32bit integer.

pj_uint64_t = UnsignedLongLong

pj_uint8_t = UnsignedChar

Unsigned 8bit integer.

pj_uint_t = pj_uint64_t

pjmedia_aud_dev_index = pj_int32_t

Type for device index.

pjmedia_aud_play_cb = Pointer<NativeFunction<pj_status_t Function(Pointer<Void> user_data, Pointer<pjmedia_frame> frame)>>

This callback is called by player stream when it needs additional data to be played by the device. Application must fill in the whole of output buffer with audio samples.

pjmedia_aud_rec_cb = Pointer<NativeFunction<pj_status_t Function(Pointer<Void> user_data, Pointer<pjmedia_frame> frame)>>

This callback is called by recorder stream when it has captured the whole packet worth of audio samples.

pjmedia_event_keyframe_found_data = pjmedia_event_dummy_data

Additional parameters for keyframe found event

pjmedia_event_keyframe_missing_data = pjmedia_event_dummy_data

Additional parameters for keyframe missing event

pjmedia_event_mouse_btn_down_data = pjmedia_event_dummy_data

Additional parameters for mouse button down event

pjmedia_event_wnd_closed_data = pjmedia_event_dummy_data

Additional parameters for window changed event.

pjmedia_vid_dev_index = pj_int32_t

Type for device index.

pjsip_cred_cb = Pointer<NativeFunction<pj_status_t Function(Pointer<pj_pool_t> pool, Pointer<pjsip_digest_challenge> chal, Pointer<pjsip_cred_info> cred, Pointer<pj_str_t> method, Pointer<pjsip_digest_credential> auth)>>

Type of callback function to create authentication response. Application can specify this callback in \a cb field of the credential info (#pjsip_cred_info) and specifying PJSIP_CRED_DATA_DIGEST_CALLBACK as \a data_type. When this function is called, most of the fields in the \a auth authentication response will have been filled by the framework. Application normally should just need to calculate the response digest of the authentication response.

pjsip_from_hdr = pjsip_fromto_hdr

Alias for From header.

pjsip_max_fwd_hdr = pjsip_generic_int_hdr

/ /** Max-Forwards header.

pjsip_require_hdr = pjsip_generic_array_hdr

/ /** Require header.

pjsip_route_hdr = pjsip_routing_hdr

Alias for Route header.

pjsip_rr_hdr = pjsip_routing_hdr

Alias for Record-Route header.

pjsip_supported_hdr = pjsip_generic_array_hdr

/ /** Supported header.

pjsip_to_hdr = pjsip_fromto_hdr

Alias for To header.

pjsip_tp_state_callback = Pointer<NativeFunction<Void Function(Pointer<pjsip_transport> tp, Int32 state, Pointer<pjsip_transport_state_info> info)>>

Type of callback to receive transport state notifications, such as transport connected/disconnected. Application may shutdown the transport in this callback.

pjsip_tp_state_listener_key = Void

Definition of transport state listener key.

pjsip_transport_callback = Pointer<NativeFunction<Void Function(Pointer<pjsip_transport> tp, Pointer<Void> token, pj_ssize_t sent_bytes)>>

TRANSPORT

pjsua_acc_id = Int

Account identification

pjsua_buddy_id = Int

Buddy identification

pjsua_call_id = Int

Call identification

pjsua_conf_port_id = Int

Conference port identification

pjsua_med_tp_state_cb = Pointer<NativeFunction<pj_status_t Function(pjsua_call_id call_id, Pointer<pjsua_med_tp_state_info> info)>>

Type of callback to be called when media transport state is changed.

pjsua_on_rejected_incoming_call_cb = Pointer<NativeFunction<Void Function(Pointer<pjsua_on_rejected_incoming_call_param> param)>>

Type of callback to be called when incoming call is rejected.

pjsua_player_id = Int

File player identification

pjsua_recorder_id = Int

File recorder identification

pjsua_transport_id = Int

SIP transport identification.

pjsua_vid_win_id = Int

Video window ID.