External: LinphoneCallParams

LinphoneCallParams

The LinphoneCallParams is an object containing various call related parameters. It can be used to retrieve parameters from a currently running call or modify the call's characteristics dynamically.
Source:

Members

audioBandwidthLimit :number

Refine bandwidth settings for this call by setting a bandwidth limit for audio streams. As a consequence, codecs whose bitrates are not compatible with this limit won't be used.
Type:
  • number
Source:

earlyMediaSendingEnabled :boolean

Enable sending of real early media (during outgoing calls).
Type:
  • boolean
Source:

<readonly> localConferenceMode :boolean

Tell whether the call is part of the locally managed conference.
Type:
  • boolean
Source:

lowBandwidthEnabled :boolean

Indicate low bandwith mode. Configuring a call to low bandwidth mode will result in the core to activate several settings for the call in order to ensure that bitrate usage is lowered to the minimum possible. Typically, ptime (packetization time) will be increased, audio codec's output bitrate will be targetted to 20kbit/s provided that it is achievable by the codec selected after SDP handshake. Video is automatically disabled.
Type:
  • boolean
Source:

mediaEncryption :linphone.MediaEncryption

Set requested media encryption for a call.
Type:
Source:

privacy :external:LinphonePrivacyMask

Set requested level of privacy for the call.
Type:
  • external:LinphonePrivacyMask
Source:

<readonly> receivedFramerate :number

Get the framerate of the video that is received.
Type:
  • number
Source:

<readonly> receivedVideoSize :external:MSVideoSize

Get the size of the video that is received.
Type:
  • external:MSVideoSize
Source:

recordFile :string

Enable recording of the call. This function must be used before the call parameters are assigned to the call. The call recording can be started and paused after the call is established with
Type:
  • string
Source:

<readonly> rtpProfile :string

Get the RTP profile being used.
Type:
  • string
Source:

<readonly> sentFramerate :number

Get the framerate of the video that is sent.
Type:
  • number
Source:

<readonly> sentVideoSize :external:MSVideoSize

Gets the size of the video that is sent.
Type:
  • external:MSVideoSize
Source:

sessionName :string

Set the session name of the media session (ie in SDP). Subject from the SIP message (which is different) can be set using linphone_call_params_set_custom_header().
Type:
  • string
Source:

<readonly> usedAudioCodec :external:LinphonePayloadType

Get the audio codec used in the call, described as a LinphonePayloadType object.
Type:
Source:

<readonly> usedVideoCodec :external:LinphonePayloadType

Get the video codec used in the call, described as a LinphonePayloadType structure.
Type:
Source:

videoEnabled :boolean

Enable video stream.
Type:
  • boolean
Source:

Methods

addCustomHeader(header_name, header_value) → {void}

Add a custom SIP header in the INVITE for a call.
Parameters:
Name Type Description
header_name string The name of the header to add.
header_value string The content of the header to add.
Source:
Returns:
Type
void

copy() → {external:LinphoneCallParams}

Copy an existing LinphoneCallParams object to a new LinphoneCallParams object.
Source:
Returns:
Type
external:LinphoneCallParams

getCustomHeader(header_name) → {string}

Get a custom SIP header.
Parameters:
Name Type Description
header_name string The name of the header to get.
Source:
Returns:
Type
string