Inheritance diagram for Linphone.Call:

Public Member Functions
void	Accept ()

void	AcceptEarlyMedia ()

void	AcceptEarlyMediaWithParams (Linphone.CallParams parameters)

void	AcceptTransfer ()

void	AcceptUpdate (Linphone.CallParams parameters)

void	AcceptWithParams (Linphone.CallParams parameters)

bool	AskedToAutoanswer ()

void	CancelDtmfs ()

void	CheckAuthenticationTokenSelected (string selectedValue)

void	ConfirmGoClear ()

IntPtr	CreateNativeVideoWindowId (IntPtr context)

IntPtr	CreateNativeVideoWindowId ()

Linphone.Event	CreateNotify (string ev)

void	Decline (Linphone.Reason reason)

int	DeclineWithErrorInfo (Linphone.ErrorInfo ei)

void	DeferUpdate ()

Linphone.CallStats	GetStats (Linphone.StreamType type)

string	GetToHeader (string headerName)

bool	HasTransferPending ()

bool	MediaInProgress ()

void	NotifyRinging ()

void	OglRender ()

void	Pause ()

void	Redirect (string redirectUri)

void	RedirectTo (Linphone.Address redirectAddress)

void	RequestNotifyNextVideoFrameDecoded ()

void	Resume ()

void	SendDtmf (sbyte dtmf)

void	SendDtmfs (string dtmfs)

void	SendInfoMessage (Linphone.InfoMessage info)

void	SendVfuRequest ()

void	SkipZrtpAuthentication ()

void	StartRecording ()

void	StopRecording ()

void	TakePreviewSnapshot (string filePath)

void	TakeVideoSnapshot (string filePath)

void	Terminate ()

void	TerminateWithErrorInfo (Linphone.ErrorInfo ei)

void	Transfer (string referTo)

void	TransferTo (Linphone.Address referTo)

void	TransferToAnother (Linphone.Call dest)

void	Update (Linphone.CallParams parameters)

void	Zoom (float zoomFactor, float cx, float cy)

Properties
string	NativeVideoWindowIdString `[get, set]`

CallListener	Listener `[get, set]`

Linphone.CallStats	AudioStats `[get]`

string	AuthenticationToken `[get]`

bool	AuthenticationTokenVerified `[get, set]`

float	AverageQuality `[get]`

bool	BaudotDetectionEnabled `[set]`

Linphone.BaudotMode	BaudotMode `[set]`

uint	BaudotPauseTimeout `[set]`

Linphone.BaudotStandard	BaudotSendingStandard `[set]`

Linphone.CallLog	CallLog `[get]`

bool	CameraEnabled `[get, set]`

Linphone.ChatRoom	ChatRoom `[get]`

Linphone.Conference	Conference `[get]`

Linphone.Core	Core `[get]`

Linphone.CallParams	CurrentParams `[get]`

float	CurrentQuality `[get]`

Linphone.CallDir	Dir `[get]`

Linphone.Address	DiversionAddress `[get]`

int	Duration `[get]`

bool	EchoCancellationEnabled `[get, set]`

bool	EchoLimiterEnabled `[get, set]`

Linphone.ErrorInfo	ErrorInfo `[get]`

Linphone.AudioDevice	InputAudioDevice `[get, set]`

bool	IsRecording `[get]`

string	LocalAuthenticationToken `[get]`

string	LocalTag `[get]`

bool	MicrophoneMuted `[get, set]`

float	MicrophoneVolumeGain `[get, set]`

IntPtr	NativeVideoWindowId `[get, set]`

Linphone.AudioDevice	OutputAudioDevice `[get, set]`

Linphone.CallParams	Params `[get, set]`

float	PlayVolume `[get]`

Linphone.Player	Player `[get]`

Linphone.Reason	Reason `[get]`

float	RecordVolume `[get]`

string	ReferTo `[get]`

Linphone.Address	ReferToAddress `[get]`

Linphone.Address	ReferredByAddress `[get]`

Linphone.Address	RemoteAddress `[get]`

string	RemoteAddressAsString `[get]`

IEnumerable< string >	RemoteAuthenticationTokens `[get]`

string	RemoteContact `[get]`

Linphone.Address	RemoteContactAddress `[get]`

Linphone.CallParams	RemoteParams `[get]`

string	RemoteTag `[get]`

string	RemoteUserAgent `[get]`

Linphone.Call	ReplacedCall `[get]`

Linphone.Address	RequestAddress `[get]`

bool	SpeakerMuted `[get, set]`

float	SpeakerVolumeGain `[get, set]`

Linphone.CallState	State `[get]`

int	StreamCount `[get]`

Linphone.CallStats	TextStats `[get]`

Linphone.Address	ToAddress `[get]`

Linphone.CallState	TransferState `[get]`

Linphone.Call	TransferTargetCall `[get]`

Linphone.Call	TransfererCall `[get]`

Linphone.VideoSourceDescriptor	VideoSource `[get, set]`

Linphone.CallStats	VideoStats `[get]`

bool	ZrtpCacheMismatchFlag `[get]`

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)

static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)

IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)

void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

This object represents a call issued or received by the Linphone.Core.

Linphone only allows at most one active call at any given time and it will be in Linphone.CallState.StreamsRunning. However, if the core is locally hosting a Linphone.Conference, you may have some or all the calls in the conference in Linphone.CallState.StreamsRunning as well as an additional active call outside of the conference in Linphone.CallState.StreamsRunning if the local participant of the Linphone.Conference is not part of it. You can get the Linphone.CallState of the call using Linphone.Call.State, it's current Linphone.CallParams with Linphone.Call.CurrentParams and the latest statistics by calling Linphone.Call.AudioStats or Linphone.Call.VideoStats. The application can receive the various kind of events occuring in a call through the Linphone.CallListener interface, see also Linphone.Call.AddListener().

Member Function Documentation

void Linphone.Call.Accept ( )

inline

Accepts an incoming call.

Basically, the application is notified of incoming calls within the call_state_changed callback of the LinphoneCoreVTable structure, where it will receive a Linphone.CallState.IncomingReceived event with the associated Linphone.Call object. The application can later accept the call using this method.

Returns: 0 on success, -1 on failure

void Linphone.Call.AcceptEarlyMedia ( )

inline

Accepts an early media session for an incoming call.

This is identical as calling Linphone.Call.AcceptEarlyMediaWithParams() with null parameters.

Returns: 0 if successful, -1 otherwise

See : Linphone.Call.AcceptEarlyMediaWithParams()

void Linphone.Call.AcceptEarlyMediaWithParams ( Linphone.CallParams parameters )

inline

When receiving an incoming, accepts to start a media session as early-media.

This means the call is not accepted but audio & video streams can be established if the remote party supports early media. However, unlike after call acceptance, mic and camera input are not sent during early-media, though received audio & video are played normally. The call can then later be fully accepted using Linphone.Call.Accept() or Linphone.Call.AcceptWithParams().

Parameters

parameters The call parameters to use (can be null).

Returns: 0 if successful, -1 otherwise

void Linphone.Call.AcceptTransfer ( )

inline

Accepts and execute a transfer (ie an incoming REFER request), to use when [sip] 'auto_accept_refer' property is false.

Default behaviour is to accept and execute the transfer automatically.

void Linphone.Call.AcceptUpdate ( Linphone.CallParams parameters )

inline

Accepts call modifications initiated by other end through an incoming reINVITE or UPDATE request.

Linphone.Call.AcceptUpdate() is typically used in response to a Linphone.CallState.UpdatedByRemote state notification. When such notification arrives, the application has several choices: -use Linphone.Call.DeferUpdate() so that it can have the time to prompt the user, and then later use Linphone.Call.AcceptUpdate() to answer -doing nothing, in which case Linphone.Call.AcceptUpdate() is internally called automatically to generate a default response. -immediately Linphone.Call.AcceptUpdate() to generate a response. An application may use Linphone.Call.RemoteParams to get information about the call parameters proposed by the other party (for example when he wants to add a video stream), in order to decide what to do, like for example requesting the end-user approval. The params argument must be constructed with Linphone.Core.CreateCallParams(). Linphone.Core.CreateCallParams() will initialize the returned Linphone.CallParams according to the offered parameters, previously used local parameters and local policies. For example, if the remote user-agent wants to add a video stream but the Linphone.VideoActivationPolicy of the Linphone.Core is to not automatically accept video, then the Linphone.CallParams will get its video stream disabled. The application is free to modify the Linphone.CallParams before passing it to Linphone.Call.AcceptUpdate(). Using null as params argument is allowed and equivalent to passing a Linphone.CallParams created by Linphone.Core.CreateCallParams() and left unmodified. The answer generated by Linphone.Call.AcceptUpdate() at first follows RFC3264 SDP offer answer model rules. The supplied Linphone.CallParams allows to give application instructions about the response to generate, such as accepting or not the enablement of new stream. Linphone.Call.AcceptUpdate() does not have the pretention to control every aspect of the generation of the answer of an SDP offer/answer procedure.

Parameters

parameters A Linphone.CallParams object describing the call parameters to accept.

Returns: 0 if successful, -1 otherwise (actually when this function call is performed outside ot Linphone.CallState.UpdatedByRemote state)

void Linphone.Call.AcceptWithParams ( Linphone.CallParams parameters )

inline

Accepts an incoming call, with parameters.

Basically, the application is notified of incoming calls within the call_state_changed callback of the LinphoneCoreVTable structure, where it will receive a Linphone.CallState.IncomingReceived event with the associated Linphone.Call object. The application can later accept the call using this method.

Parameters

parameters The specific parameters for this call, for example, whether video is accepted or not. Use null to use default parameters.

Returns: 0 on success, -1 on failure

bool Linphone.Call.AskedToAutoanswer ( )

inline

Tells whether a call has been asked to autoanswer.

Returns: A boolean value telling whether the call has been asked to autoanswer

void Linphone.Call.CancelDtmfs ( )

inline

Stops current DTMF sequence sending.

Please note that some DTMF could be already sent, depending on when this function call is delayed from Linphone.Call.SendDtmfs(). This function will be automatically called if call state change to anything but LinphoneCallStreamsRunning.

void Linphone.Call.CheckAuthenticationTokenSelected ( string selectedValue )

inline

Verifies that the half ZRTP short authentication string (SAS) selected by the user is correct, and set the verification result accordingly.

If the remote party also verifies his/her half code correctly, the ZRTP cache will be updated to prevent future verification requirements for these two users.

Parameters

selectedValue The ZRTP SAS selected by the user, or an empty string if the user cannot find the SAS

void Linphone.Call.ConfirmGoClear ( )

inline

Method to be called after the user confirm that he/she is notifed of the on going Go Clear procedure.

Warning : this operation must be imperatevely initiate by a user action on sending of the GoClear ACK

IntPtr Linphone.Call.CreateNativeVideoWindowId ( IntPtr context )

inline

Create a native video window id where the video is to be displayed.

See : linphone_core_set_native_video_window_id for a general discussion about window IDs.

A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used. A context can be used to prevent Linphone from allocating the container (MSOglContextInfo for MSOGL). null if not used.

Parameters

context preallocated Window ID (Used only for MSOGL)

Returns: the native video window id (type may vary depending on platform).

IntPtr Linphone.Call.CreateNativeVideoWindowId ( )

inline

Create a native video window id where the video is to be displayed.

See : linphone_core_set_native_video_window_id for a general discussion about window IDs.

Returns: the native video window id (type may vary depending on platform).

Linphone.Event Linphone.Call.CreateNotify ( string ev )

inline

Create a Linphone.Event in order to send NOTIFY requests through the SIP dialog created by the call.

The call state must have passed through Linphone.CallState.Connected.

Parameters

ev	The event type to be notified.

Returns: a new Linphone.Event

void Linphone.Call.Decline ( Linphone.Reason reason )

inline

Declines a pending incoming call, with a reason.

Parameters

reason The reason for rejecting the call: Linphone.Reason.Declined or Linphone.Reason.Busy

Returns: 0 on success, -1 on failure

int Linphone.Call.DeclineWithErrorInfo ( Linphone.ErrorInfo ei )

inline

Declines a pending incoming call, with a Linphone.ErrorInfo object.

Parameters

ei	Linphone.ErrorInfo containing more information on the call rejection.

Returns: 0 on success, -1 on failure

void Linphone.Call.DeferUpdate ( )

inline

When receiving a Linphone.CallState.UpdatedByRemote state notification, prevent Linphone.Core from performing an automatic answer.

When receiving a Linphone.CallState.UpdatedByRemote state notification (ie an incoming reINVITE), the default behaviour of Linphone.Core is defined by the "defer_update_default" option of the "sip" section of the config. If this option is 0 (the default) then the Linphone.Core automatically answers the reINIVTE with call parameters unchanged. However when for example when the remote party updated the call to propose a video stream, it can be useful to prompt the user before answering. This can be achieved by calling linphone_core_defer_call_update during the call state notification, to deactivate the automatic answer that would just confirm the audio but reject the video. Then, when the user responds to dialog prompt, it becomes possible to call Linphone.Call.AcceptUpdate() to answer the reINVITE, with video possibly enabled in the Linphone.CallParams argument. The Linphone.CallState.UpdatedByRemote notification can also happen when receiving an INVITE without SDP. In such case, an unchanged offer is made in the 200Ok, and when the ACK containing the SDP answer is received, Linphone.CallState.UpdatedByRemote is triggered to notify the application of possible changes in the media session. However in such case defering the update has no meaning since we just generated an offer.

Returns: 0 if successful, -1 if the Linphone.Call.DeferUpdate() was done outside a valid Linphone.CallState.UpdatedByRemote notification

Linphone.CallStats Linphone.Call.GetStats ( Linphone.StreamType type )

inline

Returns a copy of the call statistics for a particular stream type.

Parameters

type	the Linphone.StreamType

Returns: a Linphone.CallStats object for the given stream or null if stream isn't available.

string Linphone.Call.GetToHeader ( string headerName )

inline

Returns the value of the header name.

Parameters

headerName the name of the header to check.

Returns: the value of the header if exists.

Deprecated : 27/10/2020. Use Linphone.CallParams.CustomHeader on Linphone.Call.RemoteParams instead.

bool Linphone.Call.HasTransferPending ( )

inline

Returns if this calls has received a transfer that has not been executed yet.

Pending transfers are executed when this call is being paused or closed, locally or by remote endpoint. If the call is already paused while receiving the transfer request, the transfer immediately occurs.

Returns: true if transfer is pending, false otherwise.

bool Linphone.Call.MediaInProgress ( )

inline

Indicates whether an operation is in progress at the media side.

It can be a bad idea to initiate signaling operations (adding video, pausing the call, removing video, changing video parameters) while the media is busy in establishing the connection (typically ICE connectivity checks). It can result in failures generating loss of time in future operations in the call. Applications are invited to check this function after each call state change to decide whether certain operations are permitted or not.

Returns: true if media is busy in establishing the connection, false otherwise.

void Linphone.Call.NotifyRinging ( )

inline

Starts the process of replying 180 Ringing.

This function is used in conjonction with Linphone.Core.EnableAutoSendRinging(). If the automatic sending of the 180 Ringing is disabled, this function needs to be called manually before the call timeouts.

void Linphone.Call.OglRender ( )

inline

Calls generic OpenGL render for a given call.

void Linphone.Call.Pause ( )

inline

Pauses the call.

If a music file has been setup using Linphone.Core.PlayFile, this file will be played to the remote user. The only way to resume a paused call is to call Linphone.Call.Resume().

Returns: 0 on success, -1 on failure

See : Linphone.Call.Resume()

void Linphone.Call.Redirect ( string redirectUri )

inline

Redirect the specified call to the given redirect URI.

Parameters

redirectUri The URI to redirect the call to

Returns: 0 if successful, -1 on error.

Deprecated : 27/10/2020. Use Linphone.Call.RedirectTo() instead.

void Linphone.Call.RedirectTo ( Linphone.Address redirectAddress )

inline

Redirects the specified call to the given redirect Address.

Parameters

redirectAddress The Linphone.Address to redirect the call to

Returns: 0 if successful, -1 on error.

void Linphone.Call.RequestNotifyNextVideoFrameDecoded ( )

inline

Requests the callback passed to linphone_call_cbs_set_next_video_frame_decoded to be called the next time the video decoder properly decodes a video frame.

void Linphone.Call.Resume ( )

inline

Resumes a call.

The call needs to have been paused previously with Linphone.Call.Pause().

Returns: 0 on success, -1 on failure

See : Linphone.Call.Pause()

void Linphone.Call.SendDtmf ( sbyte dtmf )

inline

Sends the specified dtmf.

The dtmf is automatically played to the user.

See : Linphone.Core.UseRfc2833ForDtmf

Parameters

dtmf	The dtmf name specified as a char, such as '0', '#' etc...

Returns: 0 if successful, -1 on error.

void Linphone.Call.SendDtmfs ( string dtmfs )

inline

Sends a list of dtmf.

The dtmfs are automatically sent to remote, separated by some needed customizable delay. Sending is canceled if the call state changes to something not LinphoneCallStreamsRunning.

See : Linphone.Core.UseRfc2833ForDtmf

Parameters

dtmfs A dtmf sequence such as '123#123123'

Returns: -2 if there is already a DTMF sequence, -1 if call is not ready, 0 otherwise.

void Linphone.Call.SendInfoMessage ( Linphone.InfoMessage info )

inline

Sends an info message through an established call.

Parameters

info	the Linphone.InfoMessage to send

void Linphone.Call.SendVfuRequest ( )

inline

Requests remote side to send us a Video Fast Update.

void Linphone.Call.SkipZrtpAuthentication ( )

inline

If the user skips the ZRTP authentication check, stop the security alert.

void Linphone.Call.StartRecording ( )

inline

Starts call recording.

Video record is only available if this function is called in state StreamRunning. The output file where audio is recorded must be previously specified with Linphone.CallParams.RecordFile.

void Linphone.Call.StopRecording ( )

inline

Stops call recording.

void Linphone.Call.TakePreviewSnapshot ( string filePath )

inline

Takes a photo of currently captured video and write it into a jpeg file.

Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.

Parameters

filePath a path where to write the jpeg content.

Returns: 0 if successful, -1 otherwise (typically if jpeg format is not supported).

void Linphone.Call.TakeVideoSnapshot ( string filePath )

inline

Takes a photo of currently received video and write it into a jpeg file.

Note that the snapshot is asynchronous, an application shall not assume that the file is created when the function returns.

Parameters

filePath a path where to write the jpeg content.

Returns: 0 if successful, -1 otherwise (typically if jpeg format is not supported).

void Linphone.Call.Terminate ( )

inline

Terminates (ends) a call.

Returns: 0 on success, -1 on failure

void Linphone.Call.TerminateWithErrorInfo ( Linphone.ErrorInfo ei )

inline

Terminates a call with additional information, serialized as a Reason header.

Parameters

ei	Linphone.ErrorInfo

Returns: 0 on success, -1 on failure

void Linphone.Call.Transfer ( string referTo )

inline

Performs a simple call transfer to the specified destination.

The remote endpoint is expected to issue a new call to the specified destination. The current call remains active and thus can be later paused or terminated. It is possible to follow the progress of the transfer provided that transferee sends notification about it. In this case, the transfer_state_changed callback of the LinphoneCoreVTable is invoked to notify of the state of the new call at the other party. The notified states are Linphone.CallState.OutgoingInit, Linphone.CallState.OutgoingProgress, Linphone.CallState.OutgoingRinging and Linphone.CallState.Connected.

Parameters

referTo The destination the call is to be referred to.

Returns: 0 on success, -1 on failure

Deprecated : 27/10/2020. Use Linphone.Call.TransferTo() instead.

void Linphone.Call.TransferTo ( Linphone.Address referTo )

inline

Performs a simple call transfer to the specified destination.

The remote endpoint is expected to issue a new call to the specified destination. The current call remains active and thus can be later paused or terminated. It is possible to follow the progress of the transfer provided that transferee sends notification about it. In this case, the 'transfer state changed' callback of the Linphone.CoreListener is invoked to notify of the state of the new call to the other party. The notified states are Linphone.CallState.OutgoingInit , Linphone.CallState.OutgoingProgress, Linphone.CallState.OutgoingRinging and Linphone.CallState.Connected.

Parameters

referTo The Linphone.Address the call is to be referred to.

Returns: 0 on success, -1 on failure

void Linphone.Call.TransferToAnother ( Linphone.Call dest )

inline

Transfers a call to destination of another running call.

This is used for "attended transfer" scenarios. The transferred call is supposed to be in paused state, so that it is able to accept the transfer immediately. The destination call is a call previously established to introduce the transferred person. This method will send a transfer request to the transferred person. The phone of the transferred is then expected to automatically call to the destination of the transfer. The receiver of the transfer will then automatically close the call with us (the 'dest' call). It is possible to follow the progress of the transfer provided that transferee sends notification about it. In this case, the "transfer state changed" callback of the Linphone.CoreListener is invoked to notify of the state of the new call to the other party. The notified states are Linphone.CallState.OutgoingInit , Linphone.CallState.OutgoingProgress, Linphone.CallState.OutgoingRinging and Linphone.CallState.Connected.

Parameters

dest	A running call whose remote person will receive the transfer

Returns: 0 on success, -1 on failure

void Linphone.Call.Update ( Linphone.CallParams parameters )

inline

Updates a running call according to supplied call parameters or parameters changed in the LinphoneCore.

It triggers a SIP reINVITE in order to perform a new offer/answer of media capabilities. Changing the size of the transmitted video after calling linphone_core_set_preferred_video_size can be used by passing null as params argument. In case no changes are requested through the Linphone.CallParams argument, then this argument can be omitted and set to null. WARNING: Updating a call in the Linphone.CallState.Paused state will still result in a paused call even if the media directions set in the params are sendrecv. To resume a paused call, you need to call Linphone.Call.Resume().

Parameters

parameters The new call parameters to use (may be null).

Returns: 0 if successful, -1 otherwise.

void Linphone.Call.Zoom	(	float	zoomFactor,
		float	cx,
		float	cy
	)

inline

Performs a zoom of the video displayed during a call.

The zoom ensures that all the screen is fullfilled with the video.

Parameters

zoomFactor	a floating point number describing the zoom factor. A value 1.0 corresponds to no zoom applied.
cx	a floating point number pointing the horizontal center of the zoom to be applied. This value should be between 0.0 and 1.0.
cy	a floating point number pointing the vertical center of the zoom to be applied. This value should be between 0.0 and 1.0.

Property Documentation

Linphone.CallStats Linphone.Call.AudioStats

get

Returns a copy of the call statistics for the audio stream.

Returns: a Linphone.CallStats object for the audio stream or null if it isn't available.

string Linphone.Call.AuthenticationToken

get

Returns the ZRTP authentication token to verify.

Returns: the authentication token to verify or null if ZRTP isn't enabled.

bool Linphone.Call.AuthenticationTokenVerified

getset

Returns whether ZRTP authentication token is verified.

If not, it must be verified by users as described in ZRTP procedure. Once done, the application must inform of the results with Linphone.Call.AuthenticationTokenVerified.

Returns: true if authentication token is verifed, false otherwise.

float Linphone.Call.AverageQuality

get

Returns call quality averaged over all the duration of the call.

See Linphone.Call.CurrentQuality for more details about quality measurement.

Returns: the call average quality since tbe beginning of the call.

bool Linphone.Call.BaudotDetectionEnabled

set

Indicates whether received Baudot tones should be detected.

The Baudot functionality is to be enabled first by calling Linphone.Core.EnableBaudot().

Parameters

enabled wether or not to detect received Baudot tones.

Linphone.BaudotMode Linphone.Call.BaudotMode

set

Defines the Baudot mode for the call.

The Baudot functionality is to be enabled first by calling Linphone.Core.EnableBaudot().

Parameters

mode	The Baudot mode to use for the call.

uint Linphone.Call.BaudotPauseTimeout

set

Set the Baudot significant pause timeout after which a LETTERS tone is retransmitted before resuming transmission (in seconds).

Default is 5s. The Baudot functionality is to be enabled first by calling Linphone.Core.EnableBaudot().

Parameters

seconds The significant pause timeout in seconds.

Linphone.BaudotStandard Linphone.Call.BaudotSendingStandard

set

Defines the Baudot standard to use for sending Baudot tones in the call.

The Baudot functionality is to be enabled first by calling Linphone.Core.EnableBaudot().

Parameters

standard The Baudot standard to use for sending Baudot tones.

Linphone.CallLog Linphone.Call.CallLog

get

Gets the call log associated to this call.

Returns: The Linphone.CallLog associated with the specified Linphone.Call.

bool Linphone.Call.CameraEnabled

getset

Returns if camera pictures are allowed to be sent to the remote party.

Returns: true if local video stream is being sent, false otherwise.

Linphone.ChatRoom Linphone.Call.ChatRoom

get

Obtain a chat room for real time messaging from a call if not already existing, else return existing one.

No reference is given to the caller: the chat room will be deleted when the call is ended. The call must have been accepted with a real time text stream (see Linphone.CallParams.EnableRealtimeText()).

Returns: Linphone.ChatRoom where real time messaging can take place or null if chat room couldn't be created.

Linphone.Conference Linphone.Call.Conference

get

Returns the associated conference object if any.

Returns: A pointer on Linphone.Conference or null if the call is not part of any conference.

Linphone.Core Linphone.Call.Core

get

Gets the core that has created the specified call.

Returns: The Linphone.Core object that has created the specified call.

Linphone.CallParams Linphone.Call.CurrentParams

get

Returns current parameters associated to the call.

Returns: the current Linphone.CallParams of this call.

float Linphone.Call.CurrentQuality

get

Obtains real-time quality rating of the call.

Based on local RTP statistics and RTCP feedback, a quality rating is computed and updated during all the duration of the call. This function returns its value at the time of the function call. It is expected that the rating is updated at least every 5 seconds or so. The rating is a floating point number comprised between 0 and 5. 4-5 = good quality 3-4 = average quality 2-3 = poor quality 1-2 = very poor quality 0-1 = can't be worse, mostly unusable

Returns: The function returns -1 if no quality measurement is available, for example if no active audio stream exist. Otherwise it returns the quality rating.

Linphone.CallDir Linphone.Call.Dir

get

Returns direction of the call (incoming or outgoing).

Returns: the Linphone.CallDir

Linphone.Address Linphone.Call.DiversionAddress

get

Returns the diversion address associated to this call.

Returns: the diversion address as Linphone.Address or null.

int Linphone.Call.Duration

get

Returns call's duration in seconds.

Returns: the call's duration in seconds.

bool Linphone.Call.EchoCancellationEnabled

getset

Returns if echo cancellation is enabled.

See : Linphone.Core.EnableEchoCancellation().

Returns: true if echo cancellation is enabled, false otherwise.

bool Linphone.Call.EchoLimiterEnabled

getset

Returns if echo limiter is enabled.

See : Linphone.Core.EnableEchoLimiter().

Returns: true if echo limiter is enabled, false otherwise.

Linphone.ErrorInfo Linphone.Call.ErrorInfo

get

Returns full details about call errors or termination reasons.

Returns: Linphone.ErrorInfo object holding the reason error.

Linphone.AudioDevice Linphone.Call.InputAudioDevice

getset

Gets the current input device for this call.

Returns: the Linphone.AudioDevice used by this call as input or null if there is currently no soundcard configured (depending on the state of the call)

bool Linphone.Call.IsRecording

get

Returns whether or not the call is currently being recorded.

Returns: true if recording is in progress, false otherwise

Deprecated : 15/09/2021 Use Linphone.CallParams.IsRecording() instead.

string Linphone.Call.LocalAuthenticationToken

get

Returns the local ZRTP authentication token to verify by the remote.

Returns: the local authentication token to verify or null if ZRTP isn't enabled.

string Linphone.Call.LocalTag

get

Returns the local tag of the Linphone.Call.

Returns: the local tag.

bool Linphone.Call.MicrophoneMuted

getset

Gets microphone muted state.

Note that the microphone may be disabled globally if false was given to Linphone.Core.EnableMic().

Returns: The microphone muted state.

Warning : This method returns state of the mute capability of the call passed as argument. If this call is part of a conference, it is strongly recommended to call Linphone.Conference.MicrophoneMuted to know whether this device is muted or not.

float Linphone.Call.MicrophoneVolumeGain

getset

Gets microphone volume gain.

If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.

Returns: double Percentage of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned

IntPtr Linphone.Call.NativeVideoWindowId

getset

Get the native window handle of the video window, casted as an unsigned long.

See : linphone_core_set_native_video_window_id for a general discussion about window IDs.

Returns: the native video window id (type may vary depending on platform).

Linphone.AudioDevice Linphone.Call.OutputAudioDevice

getset

Gets the current output device for this call.

Returns: the Linphone.AudioDevice used by this call as output or null if there is currently no soundcard configured (depending on the state of the call)

Linphone.CallParams Linphone.Call.Params

getset

Returns read-only local parameters associated with the call.

This is typically the parameters passed at call initiation to Linphone.Core.InviteAddressWithParams() or Linphone.Call.AcceptWithParams(), or some default parameters if no Linphone.CallParams was explicitely passed during call initiation.

Returns: the call's local parameters.

Linphone.Player Linphone.Call.Player

get

Gets a player associated with the call to play a local file and stream it to the remote peer.

Returns: A Linphone.Player object.

float Linphone.Call.PlayVolume

get

Gets the mesured playback volume level (received from remote) in dbm0.

Returns: float Volume level in dbm0.

Linphone.Reason Linphone.Call.Reason

get

Returns the reason for a call termination (either error or normal termination)

Returns: the Linphone.Reason of the call termination.

float Linphone.Call.RecordVolume

get

Gets the mesured record volume level (sent to remote) in dbm0.

Returns: float Volume level in dbm0.

Linphone.Address Linphone.Call.ReferredByAddress

get

Gets the referred-by address, which is set when an incoming call is received as a consequence of a call transfer operation by a third party.

The referred-by address is the sip identity of the one who initiated the transfer.

Returns: The referred-by address

string Linphone.Call.ReferTo

get

Gets the refer-to uri (if the call was transferred).

Returns: The refer-to uri of the call (if it was transferred).

Linphone.Address Linphone.Call.ReferToAddress

get

Gets the refer-to uri (if the call was transferred).

Returns: The refer-to uri of the call (if it was transferred).

Linphone.Address Linphone.Call.RemoteAddress

get

Returns the remote address associated to this call.

Returns: The Linphone.Address of the remote end of the call.

string Linphone.Call.RemoteAddressAsString

get

Returns the remote address associated to this call as a string.

The result string must be freed by user using ms_free().

Returns: the remote address as a string.

Deprecated : 06/07/2020 use Linphone.Call.RemoteAddress instead.

IEnumerable<string> Linphone.Call.RemoteAuthenticationTokens

get

Returns a list of 4 remote ZRTP authentication tokens.

The user needs to select one.

Returns: the authentication tokens to verify or null if ZRTP isn't enabled. A list of char * objects.

string Linphone.Call.RemoteContact

get

Returns the far end's sip contact as a string, if available.

Returns: the remote contact or null.

Linphone.Address Linphone.Call.RemoteContactAddress

get

Returns the far end's sip contact as an address, if available.

Returns: the remote contact as a Linphone.Address or null.

Linphone.CallParams Linphone.Call.RemoteParams

get

Returns call parameters proposed by remote.

This is useful when receiving an incoming call, to know whether the remote party supports video, encryption or whatever.

Returns: the Linphone.CallParams suggested by the remote or null.

string Linphone.Call.RemoteTag

get

Returns the remote tag of the Linphone.Call.

Returns: the remote tag.

string Linphone.Call.RemoteUserAgent

get

Returns the far end's user agent description string, if available.

Returns: the remote user agent or null.

Linphone.Call Linphone.Call.ReplacedCall

get

Returns the call object this call is replacing, if any.

Call replacement can occur during call transfers. By default, the core automatically terminates the replaced call and accept the new one. This function allows the application to know whether a new incoming call is a one that replaces another one.

Returns: the Linphone.Call object this call is replacing or null.

Linphone.Address Linphone.Call.RequestAddress

get

The address to which the call has been sent, taken directly from the SIP request-URI of the INVITE.

Usually equal to the To field, except when e.g. using a fallback contact address. You should probably use getToAddress() instead, unless you know what you're doing. Usually equal to the To field, except when e.g. using a fallback contact address. You should probably use getToAddress() instead, unless you know what you're doing.

Returns: the Linphone.Address matching the URI of the INVITE request.

bool Linphone.Call.SpeakerMuted

getset

Gets speaker muted state.

Returns: The speaker muted state.

float Linphone.Call.SpeakerVolumeGain

getset

Gets speaker volume gain.

If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.

Returns: Percentage of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned

Linphone.CallState Linphone.Call.State

get

Retrieves the call's current state.

Returns: the current Linphone.CallState of this call.

int Linphone.Call.StreamCount

get

Returns the number of stream for the given call.

Returns: the amount of streams for this call.

Linphone.CallStats Linphone.Call.TextStats

get

Returns a copy of the call statistics for the text stream.

Returns: a Linphone.CallStats object for the text stream or null if it isn't available.

Linphone.Address Linphone.Call.ToAddress

get

Returns the to address with its headers associated to this call.

Returns: the Linphone.Address matching the TO of the call.

Linphone.Call Linphone.Call.TransfererCall

get

Gets the transferer if this call was started automatically as a result of an incoming transfer request.

The call in which the transfer request was received is returned in this case.

Returns: The transferer Linphone.Call if the specified call was started automatically as a result of an incoming transfer request, null otherwise.

Linphone.CallState Linphone.Call.TransferState

get

Returns the current transfer state, if a transfer has been initiated from this call.

See : linphone_core_transfer_call , linphone_core_transfer_call_to_another

Returns: the Linphone.CallState.

Linphone.Call Linphone.Call.TransferTargetCall

get

When this call has received a transfer request, returns the new call that was automatically created as a result of the transfer.

Returns: the transfer Linphone.Call created.

Linphone.VideoSourceDescriptor Linphone.Call.VideoSource

getset

Gets the video source of a call.

Returns: The Linphone.VideoSourceDescriptor describing the video source that is set

Linphone.CallStats Linphone.Call.VideoStats

get

Returns a copy of the call statistics for the video stream.

Returns: a Linphone.CallStats object for the video stream or null if it isn't available.

bool Linphone.Call.ZrtpCacheMismatchFlag

get

Returns whether ZRTP cache mismatch.

If mismatch, the ZRTP authentication token must be verified by users as described in ZRTP procedure.

Returns: true if ZRTP cache mismatch, false otherwise.

The documentation for this class was generated from the following file:

LinphoneWrapper.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation