pjsua_media_config class final
This structure describes media configuration, which will be specified when calling #pjsua_init(). Application MUST initialize this structure by calling #pjsua_media_config_default().
- Inheritance
- Implemented types
- Available extensions
Constructors
Properties
-
address
→ Pointer<
T> -
Available on T, provided by the StructAddress extension
The memory address of the underlying data.no setter - audio_frame_ptime ↔ int
-
Specify audio frame ptime. The value here will affect the
samples per frame of both the sound device and the conference
bridge. Specifying lower ptime will normally reduce the
latency.
getter/setter pair
- channel_count ↔ int
-
Channel count be applied when opening the sound device and
conference bridge.
getter/setter pair
- clock_rate ↔ int
-
Clock rate to be applied to the conference bridge.
If value is zero, default clock rate will be used
(PJSUA_DEFAULT_CLOCK_RATE, which by default is 16KHz).
getter/setter pair
- ec_options ↔ int
-
Echo canceller options (see #pjmedia_echo_create()).
Specify PJMEDIA_ECHO_USE_SW_ECHO here if application wishes
to use software echo canceller instead of device EC.
getter/setter pair
- ec_tail_len ↔ int
-
Echo canceller tail length, in miliseconds.
getter/setter pair
- enable_ice ↔ int
-
Enable ICE
getter/setter pair
- enable_turn ↔ int
-
Enable TURN relay candidate in ICE.
getter/setter pair
- has_ioqueue ↔ int
-
Specify whether the media manager should manage its own
ioqueue for the RTP/RTCP sockets. If yes, ioqueue will be created
and at least one worker thread will be created too. If no,
the RTP/RTCP sockets will share the same ioqueue as SIP sockets,
and no worker thread is needed.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- ice_always_update ↔ int
-
Send re-INVITE/UPDATE every after ICE connectivity check regardless
the default ICE transport address is changed or not. When this is set
to PJ_FALSE, re-INVITE/UPDATE will be sent only when the default ICE
transport address is changed.
getter/setter pair
- ice_max_host_cands ↔ int
-
Set the maximum number of host candidates.
getter/setter pair
- ice_no_rtcp ↔ int
-
Disable RTCP component.
getter/setter pair
- ice_opt ↔ pj_ice_sess_options
-
ICE session options.
getter/setter pair
- ilbc_mode ↔ int
-
iLBC mode (20 or 30).
getter/setter pair
- jb_discard_algo ↔ int
-
Set the algorithm the jitter buffer uses to discard frames in order to
adjust the latency.
getter/setter pair
- jb_init ↔ int
-
Jitter buffer initial prefetch delay in msec. The value must be
between jb_min_pre and jb_max_pre below. If the value is 0,
prefetching will be disabled.
getter/setter pair
- jb_max ↔ int
-
Set maximum delay that can be accomodated by the jitter buffer msec.
getter/setter pair
- jb_max_pre ↔ int
-
Jitter buffer maximum prefetch delay in msec.
getter/setter pair
- jb_min_pre ↔ int
-
Jitter buffer minimum prefetch delay in msec.
getter/setter pair
- max_media_ports ↔ int
-
Specify maximum number of media ports to be created in the
conference bridge. Since all media terminate in the bridge
(calls, file player, file recorder, etc), the value must be
large enough to support all of them. However, the larger
the value, the more computations are performed.
getter/setter pair
- no_rtcp_sdes_bye ↔ int
-
Omit RTCP SDES and BYE in outgoing RTCP packet, this setting will be
applied for both audio and video streams. Note that, when RTCP SDES
and BYE are set to be omitted, RTCP SDES will still be sent once when
the stream starts/stops and RTCP BYE will be sent once when the stream
stops.
getter/setter pair
- no_smart_media_update ↔ int
-
Disable smart media update (ticket #1568). The smart media update
will check for any changes in the media properties after a successful
SDP negotiation and the media will only be reinitialized when any
change is found. When it is disabled, media streams will always be
reinitialized after a successful SDP negotiation.
getter/setter pair
- no_vad ↔ int
-
Disable VAD?
getter/setter pair
-
on_aud_prev_play_frame
↔ Pointer<
NativeFunction< Void Function(Pointer< >pjmedia_frame> frame)> -
Optional callback for audio frame preview right before queued to
the speaker.
Notes:
getter/setter pair
-
on_aud_prev_rec_frame
↔ Pointer<
NativeFunction< Void Function(Pointer< >pjmedia_frame> frame)> -
Optional callback for audio frame preview recorded from the microphone
before being processed by any media component such as software echo
canceller.
Notes:
getter/setter pair
- ptime ↔ int
-
Specify default codec ptime.
getter/setter pair
- quality ↔ int
-
Media quality, 0-10, according to this table:
5-10: resampling use large filter,
3-4: resampling use small filter,
1-2: resampling use linear.
The media quality also sets speex codec quality/complexity to the
number.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- rx_drop_pct ↔ int
-
Percentage of RTP packet to drop in RX direction
(to simulate packet lost).
getter/setter pair
- snd_auto_close_time ↔ int
-
Specify idle time of sound device before it is automatically closed,
in seconds. Use value -1 to disable the auto-close feature of sound
device
getter/setter pair
- snd_clock_rate ↔ int
-
Clock rate to be applied when opening the sound device.
If value is zero, conference bridge clock rate will be used.
getter/setter pair
- snd_play_latency ↔ int
-
Audio playback buffer length, in milliseconds.
getter/setter pair
- snd_rec_latency ↔ int
-
Audio capture buffer length, in milliseconds.
getter/setter pair
- thread_cnt ↔ int
-
Specify the number of worker threads to handle incoming RTP
packets. A value of one is recommended for most applications.
getter/setter pair
- turn_auth_cred ↔ pj_stun_auth_cred
-
Specify the credential to authenticate with the TURN server.
getter/setter pair
- turn_conn_type ↔ int
-
Specify the connection type to be used to the TURN server. Valid
values are PJ_TURN_TP_UDP, PJ_TURN_TP_TCP or PJ_TURN_TP_TLS.
getter/setter pair
- turn_server ↔ pj_str_t
-
Specify TURN domain name or host name, in in "DOMAIN:PORT" or
"HOST:PORT" format.
getter/setter pair
- turn_tls_setting ↔ pj_turn_sock_tls_cfg
-
This specifies TLS settings for TLS transport. It is only be used
when this TLS is used to connect to the TURN server.
getter/setter pair
- tx_drop_pct ↔ int
-
Percentage of RTP packet to drop in TX direction
(to simulate packet lost).
getter/setter pair
- vid_preview_enable_native ↔ int
-
Specify whether built-in/native preview should be used if available.
In some systems, video input devices have built-in capability to show
preview window of the device. Using this built-in preview is preferable
as it consumes less CPU power. If built-in preview is not available,
the library will perform software rendering of the input. If this
field is set to PJ_FALSE, software preview will always be used.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited