public interface CallParams
Call
. Call.acceptWithParams(org.linphone.core.CallParams)
Core.inviteAddressWithParams(org.linphone.core.Address, org.linphone.core.CallParams)
.Core.createCallParams(org.linphone.core.Call)
, using null forCallParams
are available: yours, yourCall.getCurrentParams()
, Call.getRemoteParams()
and Call.getParams()
Modifier and Type | Method | 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. |
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. |
Account |
getAccount() |
Get the
Account that is used for the call. |
MediaDirection |
getAudioDirection() |
Get the audio stream direction.
|
ConferenceLayout |
getConferenceVideoLayout() |
Set video layout for conference.
|
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.
|
java.lang.String |
getFromHeader() |
Get the from header in the CallParams.
|
AudioDevice |
getInputAudioDevice() |
Gets the default input audio device for a call that will be created using this
call params. |
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.
|
long |
getNativePointer() |
Gets the native pointer used by this class to make native method calls.
|
AudioDevice |
getOutputAudioDevice() |
Gets the default output audio device for a call that will be created using this
call params. |
int |
getPrivacy() |
Get requested level of privacy for the call.
|
ProxyConfig |
getProxyConfig() |
Deprecated.
28/02/2021 Use
getAccount() instead. |
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).
|
SrtpSuite[] |
getSrtpSuites() |
Returns the list of enable srtp suite in the call (enforced only if SDES is the
selected encryption mode) |
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 |
hasCustomSdpAttribute(java.lang.String attributeName) |
Returns true if a custom SDP attribute that is related to all the streams is
present. |
boolean |
hasCustomSdpMediaAttribute(StreamType type,
java.lang.String attributeName) |
Indicates whether a custom SDP attribute that is related to a specific stream
is present or not. |
boolean |
isAudioEnabled() |
Tell whether audio is enabled or not.
|
boolean |
isAudioMulticastEnabled() |
Use to get multicast state of audio stream.
|
boolean |
isAvpfEnabled() |
Whether or not the feedback extension will be used for AVP.
|
boolean |
isCapabilityNegotiationReinviteEnabled() |
Deprecated.
16/12/2021 Use
#capabilityNegotiationReinviteEnabled instead. |
boolean |
isCapabilityNegotiationsEnabled() |
Indicates whether capability negotiations (RFC5939) is enabled.
|
boolean |
isEarlyMediaSendingEnabled() |
Indicate whether sending of early media was enabled.
|
boolean |
isLowBandwidthEnabled() |
Tell whether the call has been configured in low bandwidth mode or not.
|
boolean |
isMediaEncryptionSupported(MediaEncryption encryption) |
Returns the encryption is supported.
|
boolean |
isMicEnabled() |
Tells whether the microphone will be enabled when the call will be created.
|
boolean |
isRealtimeTextEnabled() |
Use to get real time text following rfc4103.
|
boolean |
isRecording() |
Indicates whether the call is being recorded.
|
boolean |
isRtpBundleEnabled() |
Indicates whether RTP bundle mode (also known as Media Multiplexing) is
enabled. |
boolean |
isToneIndicationsEnabled() |
Check if tone indications are enabled.
|
boolean |
isVideoEnabled() |
Tell whether video is enabled or not.
|
boolean |
isVideoMulticastEnabled() |
Use to get multicast state of video stream.
|
void |
setAccount(Account account) |
Set the
Account to use for the call. |
void |
setAudioBandwidthLimit(int bandwidth) |
Refine bandwidth settings for this call by setting a bandwidth limit for audio
streams. |
void |
setAudioDirection(MediaDirection direction) |
Set the audio stream direction.
|
void |
setAudioEnabled(boolean enabled) |
Enable audio stream.
|
void |
setAudioMulticastEnabled(boolean yesno) |
Use to enable multicast rtp for audio stream.
|
void |
setAvpfEnabled(boolean enable) |
Toggle feedback extension for AVP.
|
void |
setCapabilityNegotiationReinviteEnabled(boolean enable) |
Define whether capability negotiation (RFC5939) reINVITE is enabled.
|
void |
setCapabilityNegotiationsEnabled(boolean enabled) |
Enable capability negotiations (RFC5939).
|
void |
setConferenceVideoLayout(ConferenceLayout layout) |
Set video layout for conference.
|
void |
setEarlyMediaSendingEnabled(boolean enabled) |
Enable sending of real early media (during outgoing calls).
|
void |
setFromHeader(java.lang.String fromValue) |
Force the from header of a call when instanciating it (if set, it precludes the
search in proxy and primary contact) |
void |
setInputAudioDevice(AudioDevice audioDevice) |
Sets the given
AudioDevice as default input for a call to be createdlater. |
void |
setLowBandwidthEnabled(boolean enabled) |
Indicate low bandwith mode.
|
void |
setMediaEncryption(MediaEncryption encryption) |
Set requested media encryption for a call.
|
void |
setMicEnabled(boolean enable) |
Enable or disable the microphone at the call creation.
|
void |
setOutputAudioDevice(AudioDevice audioDevice) |
Sets the given
AudioDevice as default output for a call to be createdlater. |
void |
setPrivacy(int privacy) |
Set requested level of privacy for the call.
|
void |
setProxyConfig(ProxyConfig proxyConfig) |
Deprecated.
28/02/2021 Use
setAccount(org.linphone.core.Account) instead. |
int |
setRealtimeTextEnabled(boolean yesno) |
Use to enable real time text following rfc4103.
|
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 |
setRtpBundleEnabled(boolean value) |
Deprecated.
This property can no longer be controlled via
CallParams .Use AccountParams#enableRtpBundle . |
void |
setSessionName(java.lang.String name) |
Set the session name of the media session (ie in SDP).
|
void |
setSrtpSuites(SrtpSuite[] srtpSuites) |
Sets the list of srtp suite enabled(enforced only when SDES is the encryption
mode) |
void |
setTcapLineMergingEnabled(boolean enabled) |
Enable merging of tcap lines with consecutive indexes if capability
negotiations (RFC5939) is enabled. |
void |
setToneIndicationsEnabled(boolean enable) |
Define whether tone indications are enabled.
|
void |
setUserData(java.lang.Object data) |
Sets the object to store in this object user's data
|
void |
setVideoDirection(MediaDirection direction) |
Set the video stream direction.
|
void |
setVideoEnabled(boolean enabled) |
Enable video stream.
|
void |
setVideoMulticastEnabled(boolean yesno) |
Use to enable multicast rtp for video stream.
|
boolean |
tcapLinesMerged() |
Indicates whether tcap lines with consecutive indexes are going to be merged or
not if capability negotiations (RFC5939) is enabled. |
java.lang.String |
toString() |
@Nullable Account getAccount()
Account
for the call, or null if none has beenvoid setAccount(@Nullable Account account)
account
- The Account
to use, or null if none has been selected.CallParams
keeps a reference to it and removes the previous one, ifvoid setAudioBandwidthLimit(int bandwidth)
bandwidth
- The audio bandwidth limit to set in kbit/s. MediaDirection getAudioDirection()
MediaDirection
associated with the callvoid setAudioDirection(MediaDirection direction)
direction
- The audio stream MediaDirection
associated with thisboolean isAudioEnabled()
void setAudioEnabled(boolean enabled)
enabled
- A boolean value telling whether to enable audio or not. boolean isAudioMulticastEnabled()
Core.setAudioMulticastAddr(java.lang.String)
void setAudioMulticastEnabled(boolean yesno)
boolean isAvpfEnabled()
void setAvpfEnabled(boolean enable)
enable
- wether or not AVPF should be enabled @Deprecated boolean isCapabilityNegotiationReinviteEnabled()
#capabilityNegotiationReinviteEnabled
void setCapabilityNegotiationReinviteEnabled(boolean enable)
enable
- true to enable capability negotiation reINVITE; false otherwise. boolean isCapabilityNegotiationsEnabled()
void setCapabilityNegotiationsEnabled(boolean enabled)
enabled
- A boolean value telling whether to enable capabilityConferenceLayout getConferenceVideoLayout()
void setConferenceVideoLayout(ConferenceLayout layout)
layout
- ConferenceLayout
to use as default when creating a@NonNull Content[] getCustomContents()
Content
set if exists, null otherwise. boolean isEarlyMediaSendingEnabled()
void setEarlyMediaSendingEnabled(boolean enabled)
enabled
- A boolean value telling whether to enable early media sending or@Nullable java.lang.String getFromHeader()
void setFromHeader(@Nullable java.lang.String fromValue)
fromValue
- The value of the forced from, null to delete it. @Nullable AudioDevice getInputAudioDevice()
Call.getInputAudioDevice()
AudioDevice
that will be used by default as input when thevoid setInputAudioDevice(@Nullable AudioDevice audioDevice)
AudioDevice
as default input for a call to be createdCall.setInputAudioDevice(org.linphone.core.AudioDevice)
when call has been created. audioDevice
- The AudioDevice
. null does nothing. boolean isRecording()
boolean getLocalConferenceMode()
Core.getConference()
boolean isLowBandwidthEnabled()
#enableLowBandwidth
. When enabled, this param may transform a callvoid setLowBandwidthEnabled(boolean enabled)
enabled
- A boolean value telling whether to activate the low bandwidthMediaEncryption getMediaEncryption()
MediaEncryption
selected for the call. void setMediaEncryption(MediaEncryption encryption)
encryption
- The MediaEncryption
to use for the call. boolean isMicEnabled()
Call.getMicrophoneMuted()
void setMicEnabled(boolean enable)
Call.setMicrophoneMuted(boolean)
when call has been created. enable
- true to enable the microphone, false to disable it. @Nullable AudioDevice getOutputAudioDevice()
Call.getOutputAudioDevice()
AudioDevice
that will be used by default as output when thevoid setOutputAudioDevice(@Nullable AudioDevice audioDevice)
AudioDevice
as default output for a call to be createdCall.setOutputAudioDevice(org.linphone.core.AudioDevice)
when call has been created. audioDevice
- The AudioDevice
. null does nothing. int getPrivacy()
void setPrivacy(int privacy)
privacy
- The LinphonePrivacyMask to used for the call. @Deprecated @Nullable ProxyConfig getProxyConfig()
getAccount()
instead. ProxyConfig
for the call, or null if none has been@Deprecated void setProxyConfig(@Nullable ProxyConfig proxyConfig)
setAccount(org.linphone.core.Account)
instead. proxyConfig
- The ProxyConfig
to use, or null if none has beenCallParams
keep a reference on it and remove the older ifboolean isRealtimeTextEnabled()
int setRealtimeTextEnabled(boolean yesno)
yesno
- if yes, subsequent outgoing calls will propose rtt int getRealtimeTextKeepaliveInterval()
void setRealtimeTextKeepaliveInterval(int interval)
interval
- The keep alive interval for real time text, 25000 by default. float getReceivedFramerate()
@Nullable VideoDefinition getReceivedVideoDefinition()
VideoDefinition
or null. @Nullable java.lang.String getRecordFile()
void setRecordFile(@Nullable java.lang.String path)
Call.startRecording()
and linphone_call_pause_recording(). path
- A string containing the path and filename of the file whereboolean isRtpBundleEnabled()
@Deprecated void setRtpBundleEnabled(boolean value)
CallParams
.AccountParams#enableRtpBundle
.value
- a boolean to indicate whether the feature is to be enabled. @NonNull java.lang.String getRtpProfile()
float getSentFramerate()
@Nullable VideoDefinition getSentVideoDefinition()
VideoDefinition
or null. @Nullable java.lang.String getSessionName()
getCustomHeader(java.lang.String)
void setSessionName(@Nullable java.lang.String name)
name
- The session name to be used. @NonNull SrtpSuite[] getSrtpSuites()
void setSrtpSuites(@NonNull SrtpSuite[] srtpSuites)
srtpSuites
- list with the list of SRTP encryption suites enabled in avoid setTcapLineMergingEnabled(boolean enabled)
enabled
- A boolean value telling whether to merge tcap lines boolean isToneIndicationsEnabled()
void setToneIndicationsEnabled(boolean enable)
enable
- true to enable tone indications; false otherwise. @Nullable PayloadType getUsedAudioPayloadType()
PayloadType
. null is returned if no audio payload@Nullable PayloadType getUsedTextPayloadType()
PayloadType
. null is returned if no text payload@Nullable PayloadType getUsedVideoPayloadType()
PayloadType
. null is returned if no video payloadMediaDirection getVideoDirection()
MediaDirection
associated with the callvoid setVideoDirection(MediaDirection direction)
direction
- The video stream MediaDirection
associated with thisboolean isVideoEnabled()
void setVideoEnabled(boolean enabled)
enabled
- A boolean value telling whether to enable video or not. boolean isVideoMulticastEnabled()
Core.setVideoMulticastAddr(java.lang.String)
void setVideoMulticastEnabled(boolean yesno)
Core.getVideoMulticastAddr()
yesno
- if yes, subsequent outgoing calls will propose multicast ip set byCore.setVideoMulticastAddr(java.lang.String)
void addCustomContent(@NonNull Content content)
content
- The Content
to be added. void addCustomHeader(@NonNull java.lang.String headerName, @Nullable java.lang.String headerValue)
headerName
- The name of the header to add. headerValue
- The content of the header to add. void addCustomSdpAttribute(@NonNull java.lang.String attributeName, @Nullable java.lang.String attributeValue)
attributeName
- The name of the attribute to add. attributeValue
- The content value of the attribute to add. void addCustomSdpMediaAttribute(StreamType type, @NonNull java.lang.String attributeName, @Nullable java.lang.String attributeValue)
type
- The type of the stream to add a custom SDP attribute to. attributeName
- The name of the attribute to add. 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. @NonNull CallParams copy()
CallParams
object. @Nullable java.lang.String getCustomHeader(@NonNull java.lang.String headerName)
headerName
- The name of the header to get. @Nullable java.lang.String getCustomSdpAttribute(@NonNull java.lang.String attributeName)
attributeName
- The name of the attribute to get. @Nullable java.lang.String getCustomSdpMediaAttribute(StreamType type, @NonNull java.lang.String attributeName)
type
- The type of the stream to add a custom SDP attribute to. attributeName
- The name of the attribute to get. boolean hasCustomSdpAttribute(@NonNull java.lang.String attributeName)
attributeName
- The name of the attribute to get. boolean hasCustomSdpMediaAttribute(StreamType type, @NonNull java.lang.String attributeName)
type
- The type of the stream to add a custom SDP attribute to. attributeName
- The name of the attribute to get. boolean isMediaEncryptionSupported(MediaEncryption encryption)
encryption
- The MediaEncryption
to check whether is supported boolean tcapLinesMerged()
void setUserData(java.lang.Object data)
data
- the object to storejava.lang.Object getUserData()
long getNativePointer()
java.lang.String toString()
toString
in class java.lang.Object