FlutterPjsipBindings class

Bindings for src/flutter_pjsip.h.

Regenerate bindings with flutter pub run ffigen --config ffigen.yaml.

Constructors

FlutterPjsipBindings.new(DynamicLibrary dynamicLibrary)
The symbols are looked up in dynamicLibrary.
FlutterPjsipBindings.fromLookup(Pointer<T> lookup<T extends NativeType>(String symbolName))
The symbols are looked up with lookup.

Properties

hashCode → int
The hash code for this object.
no setterinherited
pjsip_info_method → pjsip_method
no setter
pjsip_message_method → pjsip_method
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pjsua_acc_add(Pointer<pjsua_acc_config> acc_cfg, int is_default, Pointer<pjsua_acc_id> p_acc_id) → int
Add a new account to pjsua. PJSUA must have been initialized (with #pjsua_init()) before calling this function. If registration is configured for this account, this function would also start the SIP registration session with the SIP registrar server. This SIP registration session will be maintained internally by the library, and application doesn't need to do anything to maintain the registration session.
pjsua_acc_add_local(int tid, int is_default, Pointer<pjsua_acc_id> p_acc_id) → int
Add a local account. A local account is used to identify local endpoint instead of a specific user, and for this reason, a transport ID is needed to obtain the local address information.
pjsua_acc_config_default(Pointer<pjsua_acc_config> cfg) → void
Call this function to initialize account config with default values.
pjsua_acc_config_dup(Pointer<pj_pool_t> pool, Pointer<pjsua_acc_config> dst, Pointer<pjsua_acc_config> src) → void
Duplicate account config.
pjsua_acc_create_request(int acc_id, Pointer<pjsip_method> method, Pointer<pj_str_t> target, Pointer<Pointer<pjsip_tx_data>> p_tdata) → int
Create arbitrary requests using the account. Application should only use this function to create auxiliary requests outside dialog, such as OPTIONS, and use the call or presence API to create dialog related requests.
pjsua_acc_create_uac_contact(Pointer<pj_pool_t> pool, Pointer<pj_str_t> contact, int acc_id, Pointer<pj_str_t> uri) → int
Create a suitable Contact header value, based on the specified target URI for the specified account.
pjsua_acc_create_uas_contact(Pointer<pj_pool_t> pool, Pointer<pj_str_t> contact, int acc_id, Pointer<pjsip_rx_data> rdata) → int
Create a suitable Contact header value, based on the information in the incoming request.
pjsua_acc_del(int acc_id) → int
Delete an account. This will unregister the account from the SIP server, if necessary, and terminate server side presence subscriptions associated with this account.
pjsua_acc_enum_info(Pointer<pjsua_acc_info> info, Pointer<UnsignedInt> count) → int
Enumerate account informations.
pjsua_acc_find_for_incoming(Pointer<pjsip_rx_data> rdata) → int
This is an internal function to find the most appropriate account to be used to handle incoming calls.
pjsua_acc_find_for_outgoing(Pointer<pj_str_t> url) → int
This is an internal function to find the most appropriate account to used to reach to the specified URL.
pjsua_acc_get_config(int acc_id, Pointer<pj_pool_t> pool, Pointer<pjsua_acc_config> acc_cfg) → int
Get current config for the account. This will copy current account setting to the specified parameter. Note that all pointers in the settings will point to the original settings in the account and application must not modify the values in any way. Application must also take care that these data is only valid until the account is destroyed.
pjsua_acc_get_count() → int
Get number of current accounts.
pjsua_acc_get_default() → int
Get default account to be used when receiving incoming requests (calls), when the destination of the incoming call doesn't match any other accounts.
pjsua_acc_get_info(int acc_id, Pointer<pjsua_acc_info> info) → int
Get information about the specified account.
pjsua_acc_get_user_data(int acc_id) → Pointer<Void>
Retrieve arbitrary data associated with the account.
pjsua_acc_is_valid(int acc_id) → int
Check if the specified account ID is valid.
pjsua_acc_modify(int acc_id, Pointer<pjsua_acc_config> acc_cfg) → int
Modify account configuration setting. This function may trigger unregistration (of old account setting) and re-registration (of the new account setting), e.g: changing account ID, credential, registar, or proxy setting.
pjsua_acc_set_default(int acc_id) → int
Set default account to be used when incoming and outgoing requests doesn't match any accounts.
pjsua_acc_set_online_status(int acc_id, int is_online) → int
Modify account's presence status to be advertised to remote/presence subscribers. This would trigger the sending of outgoing NOTIFY request if there are server side presence subscription for this account, and/or outgoing PUBLISH if presence publication is enabled for this account.
pjsua_acc_set_online_status2(int acc_id, int is_online, Pointer<pjrpid_element> pr) → int
Modify account's presence status to be advertised to remote/presence subscribers. This would trigger the sending of outgoing NOTIFY request if there are server side presence subscription for this account, and/or outgoing PUBLISH if presence publication is enabled for this account.
pjsua_acc_set_registration(int acc_id, int renew) → int
Update registration or perform unregistration. If registration is configured for this account, then initial SIP REGISTER will be sent when the account is added with #pjsua_acc_add(). Application normally only need to call this function if it wants to manually update the registration or to unregister from the server.
pjsua_acc_set_transport(int acc_id, int tp_id) → int
Lock/bind this account to a specific transport/listener. Normally application shouldn't need to do this, as transports will be selected automatically by the stack according to the destination.
pjsua_acc_set_user_data(int acc_id, Pointer<Void> user_data) → int
Set arbitrary data to be associated with the account.
pjsua_buddy_add(Pointer<pjsua_buddy_config> buddy_cfg, Pointer<pjsua_buddy_id> p_buddy_id) → int
Add new buddy to the buddy list. If presence subscription is enabled for this buddy, this function will also start the presence subscription session immediately.
pjsua_buddy_config_default(Pointer<pjsua_buddy_config> cfg) → void
Set default values to the buddy config.
pjsua_buddy_del(int buddy_id) → int
Delete the specified buddy from the buddy list. Any presence subscription to this buddy will be terminated.
pjsua_buddy_find(Pointer<pj_str_t> uri) → int
Find the buddy ID with the specified URI.
pjsua_buddy_get_info(int buddy_id, Pointer<pjsua_buddy_info> info) → int
Get detailed buddy info.
pjsua_buddy_get_user_data(int buddy_id) → Pointer<Void>
Get the user data associated with the budy object.
pjsua_buddy_is_valid(int buddy_id) → int
Check if buddy ID is valid.
pjsua_buddy_set_user_data(int buddy_id, Pointer<Void> user_data) → int
Set the user data associated with the buddy object.
pjsua_buddy_subscribe_pres(int buddy_id, int subscribe) → int
Enable/disable buddy's presence monitoring. Once buddy's presence is subscribed, application will be informed about buddy's presence status changed via \a on_buddy_state() callback.
pjsua_buddy_update_pres(int buddy_id) → int
Update the presence information for the buddy. Although the library periodically refreshes the presence subscription for all buddies, some application may want to refresh the buddy's presence subscription immediately, and in this case it can use this function to accomplish this.
pjsua_call_answer(int call_id, int code, Pointer<pj_str_t> reason, Pointer<pjsua_msg_data> msg_data) → int
Send response to incoming INVITE request. Depending on the status code specified as parameter, this function may send provisional response, establish the call, or terminate the call. See also #pjsua_call_answer2().
pjsua_call_answer2(int call_id, Pointer<pjsua_call_setting> opt, int code, Pointer<pj_str_t> reason, Pointer<pjsua_msg_data> msg_data) → int
Send response to incoming INVITE request with call setting param. Depending on the status code specified as parameter, this function may send provisional response, establish the call, or terminate the call. Notes about call setting:
pjsua_call_answer_with_sdp(int call_id, Pointer<pjmedia_sdp_session> sdp, Pointer<pjsua_call_setting> opt, int code, Pointer<pj_str_t> reason, Pointer<pjsua_msg_data> msg_data) → int
Same as #pjsua_call_answer2() but this function will set the SDP answer first before sending the response.
pjsua_call_aud_stream_modify_codec_param(int call_id, int med_idx, Pointer<pjmedia_codec_param> param) → int
Modify the audio stream's codec parameter after the codec is opened. Note that not all codec parameters can be modified during run-time. Currently, only Opus codec supports changing key codec parameters such as bitrate and bandwidth, while other codecs may only be able to modify minor settings such as VAD or PLC.
pjsua_call_dial_dtmf(int call_id, Pointer<pj_str_t> digits) → int
Send DTMF digits to remote using RFC 2833 payload formats. Use #pjsua_call_send_dtmf() to send DTMF using SIP INFO or other method in \a pjsua_dtmf_method. App can use \a on_dtmf_digit() or \a on_dtmf_digit2() callback to monitor incoming DTMF.
pjsua_call_dump(int call_id, int with_media, Pointer<Char> buffer, int maxlen, Pointer<Char> indent) → int
Dump call and media statistics to string.
pjsua_call_get_conf_port(int call_id) → int
Get the conference port identification associated with the call.
pjsua_call_get_count() → int
Get the number of current calls. The number includes active calls (pjsua_call_is_active(call_id) == PJ_TRUE), as well as calls that are no longer active but still in the process of hanging up.
pjsua_call_get_info(int call_id, Pointer<pjsua_call_info> info) → int
Obtain detail information about the specified call.
pjsua_call_get_max_count() → int
Get maximum number of calls configured in pjsua.
pjsua_call_get_med_transport_info(int call_id, int med_idx, Pointer<pjmedia_transport_info> t) → int
Get media transport info for the specified media index.
pjsua_call_get_rem_nat_type(int call_id, Pointer<Int32> p_type) → int
Get the NAT type of remote's endpoint. This is a proprietary feature of PJSUA-LIB which sends its NAT type in the SDP when \a nat_type_in_sdp is set in #pjsua_config.
pjsua_call_get_stream_info(int call_id, int med_idx, Pointer<pjsua_stream_info> psi) → int
Get media stream info for the specified media index.
pjsua_call_get_stream_stat(int call_id, int med_idx, Pointer<pjsua_stream_stat> stat) → int
Get media stream statistic for the specified media index.
pjsua_call_get_user_data(int call_id) → Pointer<Void>
Get user data attached to the call, which has been previously set with #pjsua_call_set_user_data().
pjsua_call_get_vid_conf_port(int call_id, int dir) → int
Get the video conference port identification associated with the call. Note that this function will only evaluate the first video stream in the call, to query any other video stream, use pjsua_call_get_info().
pjsua_call_get_vid_stream_idx(int call_id) → int
Get the media stream index of the default video stream in the call. Typically this will just retrieve the stream index of the first activated video stream in the call. If none is active, it will return the first inactive video stream.
pjsua_call_get_vid_win(int call_id) → int
Get the video window associated with the call. Note that this function will only evaluate the first video stream in the call, to query any other video stream, use pjsua_call_get_info().
pjsua_call_hangup(int call_id, int code, Pointer<pj_str_t> reason, Pointer<pjsua_msg_data> msg_data) → int
Hangup call by using method that is appropriate according to the call state. This function is different than answering the call with 3xx-6xx response (with #pjsua_call_answer()), in that this function will hangup the call regardless of the state and role of the call, while #pjsua_call_answer() only works with incoming calls on EARLY state.
pjsua_call_hangup_all() → void
Terminate all calls. This will initiate #pjsua_call_hangup() for all currently active calls.
pjsua_call_has_media(int call_id) → int
Check if call has an active media session.
pjsua_call_is_active(int call_id) → int
Check if the specified call has active INVITE session and the INVITE session has not been disconnected.
pjsua_call_make_call(int acc_id, Pointer<pj_str_t> dst_uri, Pointer<pjsua_call_setting> opt, Pointer<Void> user_data, Pointer<pjsua_msg_data> msg_data, Pointer<pjsua_call_id> p_call_id) → int
Make outgoing call to the specified URI using the specified account.
pjsua_call_process_redirect(int call_id, int cmd) → int
Accept or reject redirection response. Application MUST call this function after it signaled PJSIP_REDIRECT_PENDING in the \a on_call_redirected() callback, to notify the call whether to accept or reject the redirection to the current target. Application can use the combination of PJSIP_REDIRECT_PENDING command in \a on_call_redirected() callback and this function to ask for user permission before redirecting the call.
pjsua_call_reinvite(int call_id, int options, Pointer<pjsua_msg_data> msg_data) → int
Send re-INVITE request or release hold. The final status of the request itself will be reported on the \a on_call_media_state() callback, which inform the application that the media state of the call has changed.
pjsua_call_reinvite2(int call_id, Pointer<pjsua_call_setting> opt, Pointer<pjsua_msg_data> msg_data) → int
Send re-INVITE request or release hold. The final status of the request itself will be reported on the \a on_call_media_state() callback, which inform the application that the media state of the call has changed.
pjsua_call_remote_has_cap(int call_id, int htype, Pointer<pj_str_t> hname, Pointer<pj_str_t> token) → int
Check if remote peer support the specified capability.
pjsua_call_send_dtmf(int call_id, Pointer<pjsua_call_send_dtmf_param> param) → int
Send DTMF digits to remote. Use this method to send DTMF using the method in \a pjsua_dtmf_method. This method will call #pjsua_call_dial_dtmf() when sending DTMF using \a PJSUA_DTMF_METHOD_RFC2833. Note that \a on_dtmf_digit() callback can only monitor incoming DTMF using RFC 2833. App can use \a on_dtmf_digit2() to monitor incoming DTMF using the method in \a pjsua_dtmf_method. Note that \a on_dtmf_digit() will not be called once \a on_dtmf_digit2() is implemented.
pjsua_call_send_dtmf_param_default(Pointer<pjsua_call_send_dtmf_param> param) → void
Initialize send DTMF param with default values.
pjsua_call_send_im(int call_id, Pointer<pj_str_t> mime_type, Pointer<pj_str_t> content, Pointer<pjsua_msg_data> msg_data, Pointer<Void> user_data) → int
Send instant messaging inside INVITE session.
pjsua_call_send_request(int call_id, Pointer<pj_str_t> method, Pointer<pjsua_msg_data> msg_data) → int
Send arbitrary request with the call. This is useful for example to send INFO request. Note that application should not use this function to send requests which would change the invite session's state, such as re-INVITE, UPDATE, PRACK, and BYE.
pjsua_call_send_typing_ind(int call_id, int is_typing, Pointer<pjsua_msg_data> msg_data) → int
Send IM typing indication inside INVITE session.
pjsua_call_set_hold(int call_id, Pointer<pjsua_msg_data> msg_data) → int
Put the specified call on hold. This will send re-INVITE with the appropriate SDP to inform remote that the call is being put on hold. The final status of the request itself will be reported on the \a on_call_media_state() callback, which inform the application that the media state of the call has changed.
pjsua_call_set_hold2(int call_id, int options, Pointer<pjsua_msg_data> msg_data) → int
Put the specified call on hold. This will send re-INVITE with the appropriate SDP to inform remote that the call is being put on hold. The final status of the request itself will be reported on the \a on_call_media_state() callback, which inform the application that the media state of the call has changed.
pjsua_call_set_user_data(int call_id, Pointer<Void> user_data) → int
Attach application specific data to the call. Application can then inspect this data by calling #pjsua_call_get_user_data().
pjsua_call_set_vid_strm(int call_id, int op, Pointer<pjsua_call_vid_strm_op_param> param) → int
Add, remove, modify, and/or manipulate video media stream for the specified call. This may trigger a re-INVITE or UPDATE to be sent for the call.
pjsua_call_setting_default(Pointer<pjsua_call_setting> opt) → void
Initialize call settings.
pjsua_call_update(int call_id, int options, Pointer<pjsua_msg_data> msg_data) → int
Send UPDATE request.
pjsua_call_update2(int call_id, Pointer<pjsua_call_setting> opt, Pointer<pjsua_msg_data> msg_data) → int
Send UPDATE request.
pjsua_call_vid_stream_is_running(int call_id, int med_idx, int dir) → int
Determine if video stream for the specified call is currently running (i.e. has been created, started, and not being paused) for the specified direction.
pjsua_call_vid_stream_modify_codec_param(int call_id, int med_idx, Pointer<pjmedia_vid_codec_param> param) → int
Modify the video stream's codec parameter after the codec is opened. Note that not all codec backends support modifying parameters during runtime and only certain parameters can be changed.
pjsua_call_vid_strm_op_param_default(Pointer<pjsua_call_vid_strm_op_param> param) → void
Initialize video stream operation param with default values.
pjsua_call_xfer(int call_id, Pointer<pj_str_t> dest, Pointer<pjsua_msg_data> msg_data) → int
Initiate call transfer to the specified address. This function will send REFER request to instruct remote call party to initiate a new INVITE session to the specified destination/target.
pjsua_call_xfer_replaces(int call_id, int dest_call_id, int options, Pointer<pjsua_msg_data> msg_data) → int
Initiate attended call transfer. This function will send REFER request to instruct remote call party to initiate new INVITE session to the URL of \a dest_call_id. The party at \a dest_call_id then should "replace" the call with us with the new call from the REFER recipient.
pjsua_cancel_stun_resolution(Pointer<Void> token, int notify_cb) → int
Cancel pending STUN resolution which match the specified token.
pjsua_cancel_timer(Pointer<pj_timer_entry> entry) → void
Cancel the previously scheduled timer.
pjsua_codec_get_param(Pointer<pj_str_t> codec_id, Pointer<pjmedia_codec_param> param) → int
Get codec parameters.
pjsua_codec_set_param(Pointer<pj_str_t> codec_id, Pointer<pjmedia_codec_param> param) → int
Set codec parameters.
pjsua_codec_set_priority(Pointer<pj_str_t> codec_id, int priority) → int
Change codec priority.
pjsua_conf_add_port(Pointer<pj_pool_t> pool, Pointer<pjmedia_port> port, Pointer<pjsua_conf_port_id> p_id) → int
Add arbitrary media port to PJSUA's conference bridge. Application can use this function to add the media port that it creates. For media ports that are created by PJSUA-LIB (such as calls, file player, or file recorder), PJSUA-LIB will automatically add the port to the bridge.
pjsua_conf_adjust_rx_level(int slot, double level) → int
Adjust the signal level to be received from the specified port (to the bridge) by making it louder or quieter.
pjsua_conf_adjust_tx_level(int slot, double level) → int
Adjust the signal level to be transmitted from the bridge to the specified port by making it louder or quieter.
pjsua_conf_connect(int source, int sink) → int
Establish unidirectional media flow from souce to sink. One source may transmit to multiple destinations/sink. And if multiple sources are transmitting to the same sink, the media will be mixed together. Source and sink may refer to the same ID, effectively looping the media.
pjsua_conf_connect2(int source, int sink, Pointer<pjsua_conf_connect_param> prm) → int
Establish unidirectional media flow from source to sink. One source may transmit to multiple destinations/sink. And if multiple sources are transmitting to the same sink, the media will be mixed together. Source and sink may refer to the same ID, effectively looping the media.
pjsua_conf_connect_param_default(Pointer<pjsua_conf_connect_param> prm) → void
Initialize pjsua_conf_connect_param with default values.
pjsua_conf_disconnect(int source, int sink) → int
Disconnect media flow from the source to destination port.
pjsua_conf_get_active_ports() → int
Get current number of active ports in the bridge.
pjsua_conf_get_max_ports() → int
Get maxinum number of conference ports.
pjsua_conf_get_port_info(int port_id, Pointer<pjsua_conf_port_info> info) → int
Get information about the specified conference port
pjsua_conf_get_signal_level(int slot, Pointer<UnsignedInt> tx_level, Pointer<UnsignedInt> rx_level) → int
Get last signal level transmitted to or received from the specified port. The signal level is an integer value in zero to 255, with zero indicates no signal, and 255 indicates the loudest signal level.
pjsua_conf_remove_port(int port_id) → int
Remove arbitrary slot from the conference bridge. Application should only call this function if it registered the port manually with previous call to #pjsua_conf_add_port().
pjsua_config_default(Pointer<pjsua_config> cfg) → void
Use this function to initialize pjsua config.
pjsua_config_dup(Pointer<pj_pool_t> pool, Pointer<pjsua_config> dst, Pointer<pjsua_config> src) → void
Duplicate pjsua_config.
pjsua_create() → int
Instantiate pjsua application. Application must call this function before calling any other functions, to make sure that the underlying libraries are properly initialized. Once this function has returned success, application must call pjsua_destroy() before quitting.
pjsua_destroy() → int
Destroy pjsua. Application is recommended to perform graceful shutdown before calling this function (such as unregister the account from the SIP server, terminate presense subscription, and hangup active calls), however, this function will do all of these if it finds there are active sessions that need to be terminated. This function will approximately block for one second to wait for replies from remote.
pjsua_destroy2(int flags) → int
Variant of destroy with additional flags.
pjsua_detect_nat_type() → int
This is a utility function to detect NAT type in front of this endpoint. Once invoked successfully, this function will complete asynchronously and report the result in \a on_nat_detect() callback of pjsua_callback.
pjsua_dump(int detail) → void
This is a utility function to dump the stack states to log, using verbosity level 3.
pjsua_enum_accs(Pointer<pjsua_acc_id> ids, Pointer<UnsignedInt> count) → int
Enumerate all account currently active in the library. This will fill the array with the account Ids, and application can then query the account information for each id with #pjsua_acc_get_info().
pjsua_enum_aud_devs(Pointer<pjmedia_aud_dev_info> info, Pointer<UnsignedInt> count) → int
Enum all audio devices installed in the system.
pjsua_enum_buddies(Pointer<pjsua_buddy_id> ids, Pointer<UnsignedInt> count) → int
Enumerate all buddy IDs in the buddy list. Application then can use #pjsua_buddy_get_info() to get the detail information for each buddy id.
pjsua_enum_calls(Pointer<pjsua_call_id> ids, Pointer<UnsignedInt> count) → int
Enumerate all active calls. Application may then query the information and state of each call by calling #pjsua_call_get_info().
pjsua_enum_codecs(Pointer<pjsua_codec_info> id, Pointer<UnsignedInt> count) → int
Enum all supported codecs in the system.
pjsua_enum_conf_ports(Pointer<pjsua_conf_port_id> id, Pointer<UnsignedInt> count) → int
Enumerate all conference ports.
pjsua_enum_snd_devs(Pointer<pjmedia_snd_dev_info> info, Pointer<UnsignedInt> count) → int
Enum all sound devices installed in the system (old API).
pjsua_enum_transports(Pointer<pjsua_transport_id> id, Pointer<UnsignedInt> count) → int
Enumerate all transports currently created in the system. This function will return all transport IDs, and application may then call #pjsua_transport_get_info() function to retrieve detailed information about the transport.
pjsua_ext_snd_dev_create(Pointer<pjmedia_snd_port_param> param, Pointer<Pointer<pjsua_ext_snd_dev>> p_snd) → int
Create an extra sound device and register it to conference bridge.
pjsua_ext_snd_dev_destroy(Pointer<pjsua_ext_snd_dev> snd) → int
Destroy an extra sound device and unregister it from conference bridge.
pjsua_ext_snd_dev_get_conf_port(Pointer<pjsua_ext_snd_dev> snd) → int
Get conference port ID of an extra sound device.
pjsua_ext_snd_dev_get_snd_port(Pointer<pjsua_ext_snd_dev> snd) → Pointer<pjmedia_snd_port>
Get sound port instance of an extra sound device.
pjsua_get_buddy_count() → int
Get total number of buddies.
pjsua_get_ec_stat(Pointer<pjmedia_echo_stat> p_stat) → int
Get echo canceller statistics.
pjsua_get_ec_tail(Pointer<UnsignedInt> p_tail_ms) → int
Get current echo canceller tail length.
pjsua_get_nat_type(Pointer<Int32> type) → int
Get the NAT type as detected by #pjsua_detect_nat_type() function. This function will only return useful NAT type after #pjsua_detect_nat_type() has completed successfully and \a on_nat_detect() callback has been called.
pjsua_get_pjmedia_endpt() → Pointer<pjmedia_endpt>
Internal function to get media endpoint instance. Only valid after #pjsua_init() is called.
pjsua_get_pjsip_endpt() → Pointer<pjsip_endpoint>
Internal function to get SIP endpoint instance of pjsua, which is needed for example to register module, create transports, etc. Only valid after #pjsua_init() is called.
pjsua_get_pool_factory() → Pointer<pj_pool_factory>
Internal function to get PJSUA pool factory. Only valid after #pjsua_create() is called.
pjsua_get_snd_dev(Pointer<Int> capture_dev, Pointer<Int> playback_dev) → int
Get currently active sound devices. If sound devices has not been created (for example when pjsua_start() is not called), it is possible that the function returns PJ_SUCCESS with -1 as device IDs. See also #pjsua_snd_dev_id constants.
pjsua_get_snd_dev2(Pointer<pjsua_snd_dev_param> snd_param) → int
Get sound device parameters such as playback & capture device IDs and mode.
pjsua_get_state() → int
Retrieve pjsua state.
pjsua_handle_events(int msec_timeout) → int
Poll pjsua for events, and if necessary block the caller thread for the specified maximum interval (in miliseconds).
pjsua_handle_ip_change(Pointer<pjsua_ip_change_param> param) → int
Inform the stack that IP address change event was detected. The stack will:
pjsua_ice_config_dup(Pointer<pj_pool_t> pool, Pointer<pjsua_ice_config> dst, Pointer<pjsua_ice_config> src) → void
Clone. If the \a pool argument is NULL, a simple memcpy() will be used.
pjsua_ice_config_from_media_config(Pointer<pj_pool_t> pool, Pointer<pjsua_ice_config> dst, Pointer<pjsua_media_config> src) → void
Initialize ICE config from a media config. If the \a pool argument is NULL, a simple memcpy() will be used.
pjsua_im_send(int acc_id, Pointer<pj_str_t> to, Pointer<pj_str_t> mime_type, Pointer<pj_str_t> content, Pointer<pjsua_msg_data> msg_data, Pointer<Void> user_data) → int
Send instant messaging outside dialog, using the specified account for route set and authentication.
pjsua_im_typing(int acc_id, Pointer<pj_str_t> to, int is_typing, Pointer<pjsua_msg_data> msg_data) → int
Send typing indication outside dialog.
pjsua_init(Pointer<pjsua_config> ua_cfg, Pointer<pjsua_logging_config> log_cfg, Pointer<pjsua_media_config> media_cfg) → int
Initialize pjsua with the specified settings. All the settings are optional, and the default values will be used when the config is not specified.
pjsua_ip_change_param_default(Pointer<pjsua_ip_change_param> param) → void
Call this function to initialize \a pjsua_ip_change_param with default values.
pjsua_logging_config_default(Pointer<pjsua_logging_config> cfg) → void
Use this function to initialize logging config.
pjsua_logging_config_dup(Pointer<pj_pool_t> pool, Pointer<pjsua_logging_config> dst, Pointer<pjsua_logging_config> src) → void
Use this function to duplicate logging config.
pjsua_media_config_default(Pointer<pjsua_media_config> cfg) → void
Use this function to initialize media config.
pjsua_msg_data_clone(Pointer<pj_pool_t> pool, Pointer<pjsua_msg_data> rhs) → Pointer<pjsua_msg_data>
Clone message data.
pjsua_msg_data_init(Pointer<pjsua_msg_data> msg_data) → void
Initialize message data.
pjsua_perror(Pointer<Char> sender, Pointer<Char> title, int status) → void
This is a utility function to display error message for the specified error code. The error message will be sent to the log.
pjsua_player_create(Pointer<pj_str_t> filename, int options, Pointer<pjsua_player_id> p_id) → int
Create a file player, and automatically add this player to the conference bridge.
pjsua_player_destroy(int id) → int
Close the file of playlist, remove the player from the bridge, and free resources associated with the file player or playlist.
pjsua_player_get_conf_port(int id) → int
Get conference port ID associated with player or playlist.
pjsua_player_get_info(int id, Pointer<pjmedia_wav_player_info> info) → int
Get additional info about the file player. This operation is not valid for playlist.
pjsua_player_get_port(int id, Pointer<Pointer<pjmedia_port>> p_port) → int
Get the media port for the player or playlist.
pjsua_player_get_pos(int id) → int
Get playback position. This operation is not valid for playlist.
pjsua_player_set_pos(int id, int samples) → int
Set playback position. This operation is not valid for playlist.
pjsua_playlist_create(Pointer<pj_str_t> file_names, int file_count, Pointer<pj_str_t> label, int options, Pointer<pjsua_player_id> p_id) → int
Create a file playlist media port, and automatically add the port to the conference bridge.
pjsua_pool_create(Pointer<Char> name, int init_size, int increment) → Pointer<pj_pool_t>
Create memory pool to be used by the application. Once application finished using the pool, it must be released with pj_pool_release().
pjsua_pres_dump(int verbose) → void
Dump presence subscriptions to log.
pjsua_pres_notify(int acc_id, Pointer<pjsua_srv_pres> srv_pres, int state, Pointer<pj_str_t> state_str, Pointer<pj_str_t> reason, int with_body, Pointer<pjsua_msg_data> msg_data) → int
Send NOTIFY to inform account presence status or to terminate server side presence subscription. If application wants to reject the incoming request, it should set the \a state to PJSIP_EVSUB_STATE_TERMINATED.
pjsua_reconfigure_logging(Pointer<pjsua_logging_config> c) → int
Application can call this function at any time (after pjsua_create(), of course) to change logging settings.
pjsua_recorder_create(Pointer<pj_str_t> filename, int enc_type, Pointer<Void> enc_param, int max_size, int options, Pointer<pjsua_recorder_id> p_id) → int
Create a file recorder, and automatically connect this recorder to the conference bridge. The recorder currently supports recording WAV file. The type of the recorder to use is determined by the extension of the file (e.g. ".wav").
pjsua_recorder_destroy(int id) → int
Destroy recorder (this will complete recording).
pjsua_recorder_get_conf_port(int id) → int
Get conference port associated with recorder.
pjsua_recorder_get_port(int id, Pointer<Pointer<pjmedia_port>> p_port) → int
Get the media port for the recorder.
pjsua_resolve_stun_servers(int count, Pointer<pj_str_t> srv, int wait, Pointer<Void> token, pj_stun_resolve_cb cb) → int
Auxiliary function to resolve and contact each of the STUN server entries (sequentially) to find which is usable. The #pjsua_init() must have been called before calling this function.
pjsua_schedule_timer2_dbg(Pointer<NativeFunction<Void Function(Pointer<Void> user_data)>> cb, Pointer<Void> user_data, int msec_delay, Pointer<Char> src_file, int src_line) → int
pjsua_schedule_timer_dbg(Pointer<pj_timer_entry> entry, Pointer<pj_time_val> delay, Pointer<Char> src_file, int src_line) → int
pjsua_set_ec(int tail_ms, int options) → int
Change the echo cancellation settings.
pjsua_set_no_snd_dev() → Pointer<pjmedia_port>
Disconnect the main conference bridge from any sound devices, and let application connect the bridge to it's own sound device/master port.
pjsua_set_null_snd_dev() → int
Set pjsua to use null sound device. The null sound device only provides the timing needed by the conference bridge, and will not interract with any hardware.
pjsua_set_snd_dev(int capture_dev, int playback_dev) → int
Select or change sound device. Application may call this function at any time to replace current sound device.
pjsua_set_snd_dev2(Pointer<pjsua_snd_dev_param> snd_param) → int
Select or change sound device according to the specified param.
pjsua_snd_dev_param_default(Pointer<pjsua_snd_dev_param> prm) → void
Initialize pjsua_snd_dev_param with default values.
pjsua_snd_get_setting(int cap, Pointer<Void> pval) → int
Retrieve a sound device setting. If sound device is currently active, the function will forward the request to the sound device. If sound device is currently inactive, and if application had previously set the setting and mark the setting as kept, then that setting will be returned. Otherwise, this function will return error.
pjsua_snd_is_active() → int
Check whether the sound device is currently active. The sound device may be inactive if the application has set the auto close feature to non-zero (the snd_auto_close_time setting in #pjsua_media_config), or if null sound device or no sound device has been configured via the #pjsua_set_no_snd_dev() function.
pjsua_snd_set_setting(int cap, Pointer<Void> pval, int keep) → int
Configure sound device setting to the sound device being used. If sound device is currently active, the function will forward the setting to the sound device instance to be applied immediately, if it supports it.
pjsua_srtp_opt_default(Pointer<pjsua_srtp_opt> cfg) → void
Call this function to initialize SRTP config with default values.
pjsua_srtp_opt_dup(Pointer<pj_pool_t> pool, Pointer<pjsua_srtp_opt> dst, Pointer<pjsua_srtp_opt> src, int check_str) → void
Duplicate SRTP transport setting. If the \a pool argument is NULL, a simple memcpy() will be used.
pjsua_start() → int
Application is recommended to call this function after all initialization is done, so that the library can do additional checking set up additional
pjsua_stop_worker_threads() → void
Signal all worker threads to quit. This will only wait until internal threads are done.
pjsua_tpfactory_register(Pointer<pjsip_tpfactory> tf, Pointer<pjsua_transport_id> p_id) → int
Register transport factory that has been created by application. This function is useful if application wants to implement custom SIP transport and use it with pjsua.
pjsua_transport_close(int id, int force) → int
Close the transport. The system will wait until all transactions are closed while preventing new users from using the transport, and will close the transport when it is safe to do so.
pjsua_transport_config_default(Pointer<pjsua_transport_config> cfg) → void
Call this function to initialize UDP config with default values.
pjsua_transport_config_dup(Pointer<pj_pool_t> pool, Pointer<pjsua_transport_config> dst, Pointer<pjsua_transport_config> src) → void
Duplicate transport config.
pjsua_transport_create(int type, Pointer<pjsua_transport_config> cfg, Pointer<pjsua_transport_id> p_id) → int
Create and start a new SIP transport according to the specified settings.
pjsua_transport_get_info(int id, Pointer<pjsua_transport_info> info) → int
Get information about transports.
pjsua_transport_lis_start(int id, Pointer<pjsua_transport_config> cfg) → int
Start the listener of the transport. This is useful when listener is not automatically started when creating the transport.
pjsua_transport_register(Pointer<pjsip_transport> tp, Pointer<pjsua_transport_id> p_id) → int
Register transport that has been created by application. This function is useful if application wants to implement custom SIP transport and use it with pjsua.
pjsua_transport_set_enable(int id, int enabled) → int
Disable a transport or re-enable it. By default transport is always enabled after it is created. Disabling a transport does not necessarily close the socket, it will only discard incoming messages and prevent the transport from being used to send outgoing messages.
pjsua_turn_config_dup(Pointer<pj_pool_t> pool, Pointer<pjsua_turn_config> dst, Pointer<pjsua_turn_config> src) → void
Clone. If the \a pool argument is NULL, a simple memcpy() will be used.
pjsua_turn_config_from_media_config(Pointer<pj_pool_t> pool, Pointer<pjsua_turn_config> dst, Pointer<pjsua_media_config> src) → void
Initialize TURN config from a media config. If the \a pool argument is NULL, a simple memcpy() will be used.
pjsua_update_stun_servers(int count, Pointer<pj_str_t> srv, int wait) → int
Update the STUN servers list. The #pjsua_init() must have been called before calling this function.
pjsua_verify_sip_url(Pointer<Char> url) → int
This is a utility function to verify that valid SIP url is given. If the URL is a valid SIP/SIPS scheme, PJ_SUCCESS will be returned.
pjsua_verify_url(Pointer<Char> url) → int
This is a utility function to verify that valid URI is given. Unlike pjsua_verify_sip_url(), this function will return PJ_SUCCESS if tel: URI is given.
pjsua_vid_codec_get_param(Pointer<pj_str_t> codec_id, Pointer<pjmedia_vid_codec_param> param) → int
Get video codec parameters.
pjsua_vid_codec_set_param(Pointer<pj_str_t> codec_id, Pointer<pjmedia_vid_codec_param> param) → int
Set video codec parameters.
pjsua_vid_codec_set_priority(Pointer<pj_str_t> codec_id, int priority) → int
Change video codec priority.
pjsua_vid_conf_add_port(Pointer<pj_pool_t> pool, Pointer<pjmedia_port> port, Pointer<Void> param, Pointer<pjsua_conf_port_id> p_id) → int
Add arbitrary video media port to PJSUA's video conference bridge. Application can use this function to add the media port that it creates. For media ports that are created by PJSUA-LIB (such as calls, AVI player), PJSUA-LIB will automatically add the port to the bridge.
pjsua_vid_conf_connect(int source, int sink, Pointer<Void> param) → int
Establish unidirectional video flow from souce to sink. One source may transmit to multiple destinations/sink. And if multiple sources are transmitting to the same sink, the video will be mixed together (currently, each source will be resized down so all sources will occupy the same portion in the sink video frame). Source and sink may refer to the same ID, effectively looping the media.
pjsua_vid_conf_disconnect(int source, int sink) → int
Disconnect video flow from the source to destination port.
pjsua_vid_conf_enum_ports(Pointer<pjsua_conf_port_id> id, Pointer<UnsignedInt> count) → int
Enumerate all video conference ports.
pjsua_vid_conf_get_active_ports() → int
Get current number of active ports in the bridge.
pjsua_vid_conf_get_port_info(int port_id, Pointer<pjsua_vid_conf_port_info> info) → int
Get information about the specified video conference port
pjsua_vid_conf_remove_port(int port_id) → int
Remove arbitrary slot from the video conference bridge. Application should only call this function if it registered the port manually with previous call to #pjsua_vid_conf_add_port().
pjsua_vid_conf_update_port(int port_id) → int
Update or refresh port states from video port info. Some port may change its port info in the middle of a session, for example when a video stream decoder learns that incoming video size or frame rate has changed, video conference needs to be informed to update its internal states.
pjsua_vid_dev_count() → int
Get the number of video devices installed in the system.
pjsua_vid_dev_get_info(int id, Pointer<pjmedia_vid_dev_info> vdi) → int
Retrieve the video device info for the specified device index.
pjsua_vid_dev_get_setting(int id, int cap, Pointer<Void> pval) → int
Retrieve the value of a video capture device setting. If the device is currently active (i.e. if there is a video call using the device or a video preview has been started), the function will forward the request to the video device. If video device is currently inactive, and if application had previously set the setting and mark the setting as kept, then that setting will be returned. Otherwise, this function will return error. The function only works for video capture device.
pjsua_vid_dev_is_active(int id) → int
Check whether the video capture device is currently active, i.e. if a video preview has been started or there is a video call using the device. This function will return PJ_FALSE for video renderer device.
pjsua_vid_dev_set_setting(int id, int cap, Pointer<Void> pval, int keep) → int
Configure the capability of a video capture device. If the device is currently active (i.e. if there is a video call using the device or a video preview has been started), the function will forward the setting to the video device instance to be applied immediately, if it supports it.
pjsua_vid_enum_codecs(Pointer<pjsua_codec_info> id, Pointer<UnsignedInt> count) → int
Enum all supported video codecs in the system.
pjsua_vid_enum_devs(Pointer<pjmedia_vid_dev_info> info, Pointer<UnsignedInt> count) → int
Enum all video devices installed in the system.
pjsua_vid_enum_wins(Pointer<pjsua_vid_win_id> wids, Pointer<UnsignedInt> count) → int
Enumerates all video windows.
pjsua_vid_preview_get_vid_conf_port(int id) → int
Get video conference slot ID of the specified capture device, if any.
pjsua_vid_preview_get_win(int id) → int
Get the preview window handle associated with the capture device, if any.
pjsua_vid_preview_has_native(int id) → int
Determine if the specified video input device has built-in native preview capability. This is a convenience function that is equal to querying device's capability for PJMEDIA_VID_DEV_CAP_INPUT_PREVIEW capability.
pjsua_vid_preview_param_default(Pointer<pjsua_vid_preview_param> p) → void
Initialize pjsua_vid_preview_param
pjsua_vid_preview_start(int id, Pointer<pjsua_vid_preview_param> p) → int
Start video preview window for the specified capture device.
pjsua_vid_preview_stop(int id) → int
Stop video preview.
pjsua_vid_win_get_info(int wid, Pointer<pjsua_vid_win_info> wi) → int
Get window info.
pjsua_vid_win_rotate(int wid, int angle) → int
Rotate the video window. This function will change the video orientation and also possibly the video window size (width and height get swapped). This operation is not valid for native windows (pjsua_vid_win_info.is_native =PJ_TRUE), on which native windowing API must be used instead.
pjsua_vid_win_set_fullscreen(int wid, int mode) → int
Set video window full-screen. This operation is valid only when the underlying video device supports PJMEDIA_VID_DEV_CAP_OUTPUT_FULLSCREEN capability. Currently it is only supported on SDL backend.
pjsua_vid_win_set_pos(int wid, Pointer<pjmedia_coord> pos) → int
Set video window position. This operation is not valid for native windows (pjsua_vid_win_info.is_native=PJ_TRUE), on which native windowing API must be used instead.
pjsua_vid_win_set_show(int wid, int show1) → int
Show or hide window. This operation is not valid for native windows (pjsua_vid_win_info.is_native=PJ_TRUE), on which native windowing API must be used instead.
pjsua_vid_win_set_size(int wid, Pointer<pjmedia_rect_size> size) → int
Resize window. This operation is not valid for native windows (pjsua_vid_win_info.is_native=PJ_TRUE), on which native windowing API must be used instead.
pjsua_vid_win_set_win(int wid, Pointer<pjmedia_vid_dev_hwnd> win) → int
Set output window. This operation is valid only when the underlying video device supports PJMEDIA_VIDEO_DEV_CAP_OUTPUT_WINDOW capability AND allows the output window to be changed on-the-fly. Currently it is only supported on Android.
sum(int a, int b) → int
A very short-lived native function.
sum_long_running(int a, int b) → int
A longer lived native function, which occupies the thread calling it.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited