org.linphone.core

Interface LinphoneCallParams

public interface 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.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCustomHeader(String name, String value) Add a custom header to be used for the call for which these call params are used.
void	addCustomSdpAttribute(String name, String value) Add a custom attribute related to all the streams in the SDP exchanged within SIP messages during a call.
void	addCustomSdpMediaAttribute(LinphoneCore.StreamType type, String name, String value) Add a custom attribute related to a specific stream in the SDP exchanged within SIP messages during a call.
boolean	audioMulticastEnabled() Use to get multicast state of audio stream.
void	clearCustomSdpAttributes() Clear the custom SDP attributes related to all the streams in the SDP exchanged within SIP messages during a call.
void	clearCustomSdpMediaAttributes(LinphoneCore.StreamType type) Clear the custom SDP attributes related to a specific stream in the SDP exchanged within SIP messages during a call.
void	enableAudioMulticast(boolean yesno) Use to enable multicast rtp for audio stream
void	enableLowBandwidth(boolean enable) Indicate low bandwith mode.
void	enableRealTimeText(boolean yesno) Use to enable real time text following rfc4103.
void	enableVideoMulticast(boolean yesno) Use to enable multicast rtp for video stream.
LinphoneCore.MediaDirection	getAudioDirection() Get the audio stream direction.
String	getCustomHeader(String name) Returns the value of a custom header given its name.
String	getCustomSdpAttribute(String name) Get a custom SDP attribute that is related to all the streams.
String	getCustomSdpMediaAttribute(LinphoneCore.StreamType type, String name) Get a custom SDP attribute that is related to a specific stream.
LinphoneCore.MediaEncryption	getMediaEncryption() return selected media encryption
int	getPrivacy() Get the privacy mask requested for this call.
VideoSize	getReceivedVideoSize() Gets the size of the video that is received.
VideoSize	getSentVideoSize() Gets the size of the video that is sent.
String	getSessionName() Get the session name of the media session (ie in SDP).
PayloadType	getUsedAudioCodec() Get the currently used audio codec
PayloadType	getUsedVideoCodec() Get the currently used video codec
LinphoneCore.MediaDirection	getVideoDirection() Get the video stream direction.
boolean	getVideoEnabled()
boolean	isLowBandwidthEnabled() Use to know if this call has been configured in low bandwidth mode.
boolean	realTimeTextEnabled() Use to get real time text following rfc4103.
void	setAudioBandwidth(int value) set audio bandwidth in kbits/s
void	setAudioDirection(LinphoneCore.MediaDirection dir) Set the audio stream direction.
void	setMediaEnctyption(LinphoneCore.MediaEncryption menc) set media encryption (rtp) to use
void	setPrivacy(int privacy_mask) Set the privacy for the call.
void	setRecordFile(String path) Set a path to file where the call will be recorded.
void	setSessionName(String name) Set the session name of the media session (ie in SDP).
void	setVideoDirection(LinphoneCore.MediaDirection dir) Set the video stream direction.
void	setVideoEnabled(boolean b)
boolean	videoMulticastEnabled() Use to get multicast state of video stream.

Method Detail

setVideoEnabled

void setVideoEnabled(boolean b)

getVideoEnabled

boolean getVideoEnabled()

setAudioBandwidth

void setAudioBandwidth(int value)

set audio bandwidth in kbits/s

Parameters:

value - 0 to disable limitation

getMediaEncryption

LinphoneCore.MediaEncryption getMediaEncryption()

return selected media encryption

Returns:

MediaEncryption.None MediaEncryption.SRTP or MediaEncryption.ZRTP

setMediaEnctyption

void setMediaEnctyption(LinphoneCore.MediaEncryption menc)

set media encryption (rtp) to use

Parameters:

menc - MediaEncryption.None, MediaEncryption.SRTP or MediaEncryption.ZRTP

getUsedAudioCodec

PayloadType getUsedAudioCodec()

Get the currently used audio codec

Returns:

PayloadType or null

getUsedVideoCodec

PayloadType getUsedVideoCodec()

Get the currently used video codec

Returns:

PayloadType or null

enableLowBandwidth

void enableLowBandwidth(boolean enable)

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.

isLowBandwidthEnabled

boolean isLowBandwidthEnabled()

Use to know if this call has been configured in low bandwidth mode.
When enabled, this param may transform a call request with video in audio only mode.

Returns:

true if low bandwidth has been configured/detected

setRecordFile

void setRecordFile(String path)

Set a path to file where the call will be recorded. Actual start of the recording is controlled by LinphoneCall.startRecording().

Parameters:

path - Path to the file where the call will be recorded. If it is a WAV file, only audio will be written whereas if it is a MKV file, audio and video will be written.

addCustomHeader

void addCustomHeader(String name,
                   String value)

Add a custom header to be used for the call for which these call params are used.

Parameters:

name - header name

value - header value

getCustomHeader

String getCustomHeader(String name)

Returns the value of a custom header given its name. If no header with that name exists, then null is returned.

Returns:

value for the header, or null if it doesn't exist.

addCustomSdpAttribute

void addCustomSdpAttribute(String name,
                         String value)

Add a custom attribute related to all the streams in the SDP exchanged within SIP messages during a call.

Parameters:

name - The name of the attribute to add.

value - The content value of the attribute to add.

addCustomSdpMediaAttribute

void addCustomSdpMediaAttribute(LinphoneCore.StreamType type,
                              String name,
                              String value)

Add a custom attribute related to a specific stream in the SDP exchanged within SIP messages during a call.

Parameters:

type - The type of the stream to add a custom SDP attribute to.

name - The name of the attribute to add.

value - The content value of the attribute to add.

getCustomSdpAttribute

String getCustomSdpAttribute(String name)

Get a custom SDP attribute that is related to all the streams.

Parameters:

name - The name of the attribute to get.

Returns:

The content value of the attribute or null if not found.

getCustomSdpMediaAttribute

String getCustomSdpMediaAttribute(LinphoneCore.StreamType type,
                                String name)

Get a custom SDP attribute that is related to a specific stream.

Parameters:

type - The type of the stream to add a custom SDP attribute to.

name - The name of the attribute to get.

Returns:

The content value of the attribute or null if not found.

clearCustomSdpAttributes

void clearCustomSdpAttributes()

Clear the custom SDP attributes related to all the streams in the SDP exchanged within SIP messages during a call.

clearCustomSdpMediaAttributes

void clearCustomSdpMediaAttributes(LinphoneCore.StreamType type)

Clear the custom SDP attributes related to a specific stream in the SDP exchanged within SIP messages during a call.

Parameters:

type - The type of the stream to clear custom SDP attributes from.

setPrivacy

void setPrivacy(int privacy_mask)

Set the privacy for the call.

Parameters:

privacy_mask - a or'd int of values defined in interface Privacy

getPrivacy

int getPrivacy()

Get the privacy mask requested for this call.

Returns:

the privacy mask as defined in interface Privacy

setSessionName

void setSessionName(String name)

Set the session name of the media session (ie in SDP). Subject from the SIP message can be retrieved using linphone_call_params_get_custom_header().

Parameters:

name - the session name

getSessionName

String getSessionName()

Get the session name of the media session (ie in SDP). Subject from the SIP message can be retrieved using linphone_call_params_get_custom_header().

Returns:

the session name

getSentVideoSize

VideoSize getSentVideoSize()

Gets the size of the video that is sent.

Returns:

The sent video size.

getReceivedVideoSize

VideoSize getReceivedVideoSize()

Gets the size of the video that is received.

Returns:

The received video size.

enableAudioMulticast

void enableAudioMulticast(boolean yesno)

Use to enable multicast rtp for audio stream. * If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr into audio cline. In case of outgoing call audio stream is sent to this multicast address.
For incoming calls behavior is unchanged.

Parameters:

yesno - if yes, subsequent calls will propose multicast ip set by LinphoneCore.setAudioMulticastAddr

audioMulticastEnabled

boolean audioMulticastEnabled()

Use to get multicast state of audio stream.

Returns:

true if subsequent calls will propose multicast ip set by LinphoneCore.setAudioMulticastAddr

enableVideoMulticast

void enableVideoMulticast(boolean yesno)

Use to enable multicast rtp for video stream. If enabled, outgoing calls put a multicast address from #linphone_core_get_video_multicast_addr into video cline. In case of outgoing call video stream is sent to this multicast address.
For incoming calls behavior is unchanged.

Parameters:

yesno - if yes, subsequent outgoing calls will propose multicast ip set by LinphoneCore.setVideoMulticastAddr

videoMulticastEnabled

boolean videoMulticastEnabled()

Use to get multicast state of video stream.

Returns:

true if subsequent calls will propose multicast ip set by LinphoneCore.setVideoMulticastAddr

enableRealTimeText

void enableRealTimeText(boolean yesno)

Use to enable real time text following rfc4103. If enabled, outgoing calls put a m=text line in SDP offer .

Parameters:

yesno - if yes, subsequent outgoing calls will propose rtt

realTimeTextEnabled

boolean realTimeTextEnabled()

Use to get real time text following rfc4103.

Returns:

returns true if call rtt is activated.

getAudioDirection

LinphoneCore.MediaDirection getAudioDirection()

Get the audio stream direction.

Returns:

The audio stream direction associated with the call params.

getVideoDirection

LinphoneCore.MediaDirection getVideoDirection()

Get the video stream direction.

Returns:

The video stream direction associated with the call params.

setAudioDirection

void setAudioDirection(LinphoneCore.MediaDirection dir)

Set the audio stream direction.

Parameters:

dir - The audio stream direction associated with this call params.

setVideoDirection

void setVideoDirection(LinphoneCore.MediaDirection dir)

Set the video stream direction.

Parameters:

dir - The video stream direction associated with this call params.