public interface CallParams
CallParams
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.Modifier and Type | Method and Description |
---|---|
void |
addCustomContent(Content content)
Adds a
Content to be added to the INVITE SDP. |
void |
addCustomHeader(java.lang.String headerName,
java.lang.String headerValue)
Add a custom SIP header in the INVITE for a call.
|
void |
addCustomSdpAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Add a custom attribute related to all the streams in the SDP exchanged within
SIP messages during a call.
|
void |
addCustomSdpMediaAttribute(StreamType type,
java.lang.String attributeName,
java.lang.String attributeValue)
Add a custom attribute related to a specific stream in the SDP exchanged within
SIP messages during a call.
|
boolean |
audioEnabled()
Tell whether audio is enabled or not.
|
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(StreamType type)
Clear the custom SDP attributes related to a specific stream in the SDP
exchanged within SIP messages during a call.
|
CallParams |
copy()
Copy an existing
CallParams object to a new CallParams object. |
boolean |
earlyMediaSendingEnabled()
Indicate whether sending of early media was enabled.
|
void |
enableAudio(boolean enabled)
Enable audio stream.
|
void |
enableAudioMulticast(boolean yesno)
Use to enable multicast rtp for audio stream.
|
void |
enableAvpf(boolean enable)
Set the video stream direction.
|
void |
enableEarlyMediaSending(boolean enabled)
Enable sending of real early media (during outgoing calls).
|
void |
enableLowBandwidth(boolean enabled)
Indicate low bandwith mode.
|
int |
enableRealtimeText(boolean yesno)
Use to enable real time text following rfc4103.
|
void |
enableRtpBundle(boolean value)
Enables or disables RTP bundle mode (Media Multiplexing).
|
void |
enableVideo(boolean enabled)
Enable video stream.
|
void |
enableVideoMulticast(boolean yesno)
Use to enable multicast rtp for video stream.
|
MediaDirection |
getAudioDirection()
Get the audio stream direction.
|
Content[] |
getCustomContents()
Gets a list of
Content set if exists. |
java.lang.String |
getCustomHeader(java.lang.String headerName)
Get a custom SIP header.
|
java.lang.String |
getCustomSdpAttribute(java.lang.String attributeName)
Get a custom SDP attribute that is related to all the streams.
|
java.lang.String |
getCustomSdpMediaAttribute(StreamType type,
java.lang.String attributeName)
Get a custom SDP attribute that is related to a specific stream.
|
boolean |
getLocalConferenceMode()
Tell whether the call is part of the locally managed conference.
|
MediaEncryption |
getMediaEncryption()
Get the kind of media encryption selected for the call.
|
int |
getPrivacy()
Get requested level of privacy for the call.
|
int |
getRealtimeTextKeepaliveInterval()
Use to get keep alive interval of real time text following rfc4103.
|
float |
getReceivedFramerate()
Get the framerate of the video that is received.
|
VideoDefinition |
getReceivedVideoDefinition()
Get the definition of the received video.
|
java.lang.String |
getRecordFile()
Get the path for the audio recording of the call.
|
java.lang.String |
getRtpProfile()
Get the RTP profile being used.
|
float |
getSentFramerate()
Get the framerate of the video that is sent.
|
VideoDefinition |
getSentVideoDefinition()
Get the definition of the sent video.
|
java.lang.String |
getSessionName()
Get the session name of the media session (ie in SDP).
|
PayloadType |
getUsedAudioPayloadType()
Get the audio payload type that has been selected by a call.
|
PayloadType |
getUsedTextPayloadType()
Get the text payload type that has been selected by a call.
|
PayloadType |
getUsedVideoPayloadType()
Get the video payload type that has been selected by a call.
|
java.lang.Object |
getUserData()
Gets the object stored in this object user's data
|
MediaDirection |
getVideoDirection()
Get the video stream direction.
|
boolean |
lowBandwidthEnabled()
Tell whether the call has been configured in low bandwidth mode or not.
|
boolean |
realtimeTextEnabled()
Use to get real time text following rfc4103.
|
boolean |
rtpBundleEnabled()
Indicates whether RTP bundle mode (also known as Media Multiplexing) is
enabled.
|
void |
setAudioBandwidthLimit(int bw)
Refine bandwidth settings for this call by setting a bandwidth limit for audio
streams.
|
void |
setAudioDirection(MediaDirection dir)
Set the audio stream direction.
|
void |
setMediaEncryption(MediaEncryption enc)
Set requested media encryption for a call.
|
void |
setPrivacy(int privacy)
Set requested level of privacy for the call.
|
void |
setRealtimeTextKeepaliveInterval(int interval)
Use to set keep alive interval for real time text following rfc4103.
|
void |
setRecordFile(java.lang.String path)
Enable recording of the call.
|
void |
setSessionName(java.lang.String name)
Set the session name of the media session (ie in SDP).
|
void |
setUserData(java.lang.Object data)
Sets the object to store in this object user's data
|
void |
setVideoDirection(MediaDirection dir)
Set the video stream direction.
|
boolean |
videoEnabled()
Tell whether video is enabled or not.
|
boolean |
videoMulticastEnabled()
Use to get multicast state of video stream.
|
void setAudioBandwidthLimit(int bw)
bw
- The audio bandwidth limit to set in kbit/s.MediaDirection getAudioDirection()
void setAudioDirection(MediaDirection dir)
dir
- The audio stream direction associated with this call params.boolean audioEnabled()
void enableAudio(boolean enabled)
enabled
- A boolean value telling whether to enable audio or not.boolean audioMulticastEnabled()
void enableAudioMulticast(boolean yesno)
void enableAvpf(boolean enable)
enable
- wether or not AVPF should be enabled for this callboolean earlyMediaSendingEnabled()
void enableEarlyMediaSending(boolean enabled)
enabled
- A boolean value telling whether to enable early media sending or
not.boolean getLocalConferenceMode()
Core.getConference()
return a non-null pointer.boolean lowBandwidthEnabled()
enableLowBandwidth(boolean)
. When enabled, this param may
transform a call request with video in audio only mode.void enableLowBandwidth(boolean enabled)
enabled
- A boolean value telling whether to activate the low bandwidth
mode or not.MediaEncryption getMediaEncryption()
void setMediaEncryption(MediaEncryption enc)
enc
- The media encryption to use for the call.int getPrivacy()
void setPrivacy(int privacy)
privacy
- The privacy mode to used for the call.boolean realtimeTextEnabled()
int enableRealtimeText(boolean yesno)
yesno
- if yes, subsequent outgoing calls will propose rttint getRealtimeTextKeepaliveInterval()
void setRealtimeTextKeepaliveInterval(int interval)
interval
- The keep alive interval for real time text, 25000 by default.float getReceivedFramerate()
VideoDefinition getReceivedVideoDefinition()
VideoDefinition
java.lang.String getRecordFile()
void setRecordFile(java.lang.String path)
Call.startRecording()
and linphone_call_pause_recording().path
- A string containing the path and filename of the file where
audio/video streams are to be written. The filename must have either .mkv or
.wav extention. The video stream will be written only if a MKV file is given.boolean rtpBundleEnabled()
void enableRtpBundle(boolean value)
value
- a boolean to indicate whether the feature is to be enabled.java.lang.String getRtpProfile()
float getSentFramerate()
VideoDefinition getSentVideoDefinition()
VideoDefinition
java.lang.String getSessionName()
getCustomHeader(java.lang.String)
and is different.void setSessionName(java.lang.String name)
name
- The session name to be used.PayloadType getUsedAudioPayloadType()
PayloadType getUsedTextPayloadType()
PayloadType getUsedVideoPayloadType()
MediaDirection getVideoDirection()
void setVideoDirection(MediaDirection dir)
dir
- The video stream direction associated with this call params.boolean videoEnabled()
void enableVideo(boolean enabled)
enabled
- A boolean value telling whether to enable video or not.boolean videoMulticastEnabled()
void enableVideoMulticast(boolean yesno)
yesno
- if yes, subsequent outgoing calls will propose multicast ip set by
linphone_core_set_video_multicast_addrvoid addCustomContent(Content content)
Content
to be added to the INVITE SDP.content
- The Content
to be added.void addCustomHeader(java.lang.String headerName, java.lang.String headerValue)
headerValue
- The content of the header to add.void addCustomSdpAttribute(java.lang.String attributeName, java.lang.String attributeValue)
attributeValue
- The content value of the attribute to add.void addCustomSdpMediaAttribute(StreamType type, java.lang.String attributeName, java.lang.String attributeValue)
attributeValue
- The content value of the attribute to add.void clearCustomSdpAttributes()
void clearCustomSdpMediaAttributes(StreamType type)
type
- The type of the stream to clear the custom SDP attributes from.CallParams copy()
CallParams
object to a new CallParams
object.CallParams
object.java.lang.String getCustomHeader(java.lang.String headerName)
headerName
- The name of the header to get.java.lang.String getCustomSdpAttribute(java.lang.String attributeName)
attributeName
- The name of the attribute to get.java.lang.String getCustomSdpMediaAttribute(StreamType type, java.lang.String attributeName)
attributeName
- The name of the attribute to get.void setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()