Inheritance diagram for ZDK_NET::Call:

Public Member Functions
	Call (ZDK::Shared::Call src)

void	SetCallStatusListener (ZDK_NET::CallEventsHandler^ value)
	Sets Call status listener. More...

void	DropCallStatusListener (ZDK_NET::CallEventsHandler^ value)
	Drops Call status listener. More...

void	DropAllEventListeners ()
	Drops all event listeners.

void	SetVideoRendererNotificationsListener (ZDK_NET::VideoRendererEventsHandler^ value)

ZDK_NET::Result ^	Ringing ()
	Notifies the remote party that we are ringing (incoming calls) More...

ZDK_NET::Result ^	AcceptCall ()
	Accepts an incoming call. More...

ZDK_NET::Result ^	HangUp ()
	Hang up the call. More...

ZDK_NET::Call ^	AcceptCallTransfer ()
	Accept a call transfer request. More...

ZDK_NET::Result ^	RejectCallTransfer ()
	Rejects a call transfer request. More...

ZDK_NET::Result ^	AttendedTransfer (ZDK_NET::Call^ transferee)
	Initiates an attended call transfer. More...

ZDK_NET::Result ^	BlindTransfer (System::String^ transferee)
	Initiates an unattended call transfer. More...

ZDK_NET::Result ^	AcceptVideo (bool accept)
	Accepts an incoming offer for video. More...

ZDK_NET::Result ^	OfferVideo ()
	Offers Video. More...

void	SendVideoFrame (unsigned char *bytes, int byteCount, ZDK_NET::VideoFrameFormat type)
	Send a video frame over the network. More...

ZDK_NET::Result ^	VideoToggleCamera ()
	Toggles the camera. More...

ZDK_NET::CameraSensorLocation	VideoGetCameraLocation ()
	Provides Camera location. More...

ZDK_NET::Result ^	RestartVideoCapture ()
	Restart Video capture. More...

bool	HasVideo (ZDK_NET::OriginType origin)
	Gets if video is present. More...

void	StopHandlingVoipPhoneCallEvents ()
	Stops handling Call events.

void	StartHandlingVoipPhoneCallEvents ()
	Start handling Call events.

ZDK_NET::Result ^	NotifyAccountOfOwnershipChange ()
	Notify upon Account ownership changes. More...

ZDK_NET::Result ^	SendDTMF (ZDK_NET::DTMFCodes dtmf)
	Sends a DTMF signal over a call. More...

ZDK_NET::Result ^	StartRecording ()
	Start recording call. More...

ZDK_NET::Result ^	StopRecording ()
	Stop recording. More...

ZDK_NET::Result ^	EnableZrtp (bool enabled)
	Enables ZRTP. More...

ZDK_NET::Result ^	ConfirmZrtpSas (bool confirmed)
	Enables ZRTP. More...

ZDK_NET::Result ^	ConfigureCallRecordFormat (ZDK_NET::AudioFileFormat format)
	Configures a call recording's encoding format and its specific settings. More...

virtual long long	Handle () override

virtual void	Initialize () override

virtual void	ReleaseReference () override

Public Attributes
ZDK::ICall *	cppRef = nullptr

Properties
long long	CallHandle `[get]`
	Gets call handle. More...

ZDK_NET::BrandingInfo^	Branding `[get, set]`

ZDK_NET::CallStatus^	Status `[get]`
	Provides the Call's status information. More...

System::String^	CalleeNumber `[get]`
	Provides the Callee number. More...

System::String^	CalleeName `[get]`
	Provides the Callee name. More...

ZDK_NET::AudioVideoCodecs	CodecInUse `[get]`
	Provides the used codec. More...

bool	OnSpeaker `[get, set]`
	Sets the speakers state. More...

bool	Held `[get, set]`
	Sets the hold state. More...

bool	Muted `[get, set]`
	Sets the Mute state of the local input device. More...

ZDK_NET::VideoCallInfo^	VideoCallInfo `[get]`
	Gets Video call information. More...

bool	IsFirstClass `[get]`

ZDK_NET::Account^	Owner `[get]`
	Returns the account owner. More...

System::String^	RecordFileName `[set]`
	Sets the record file name. More...

Member Function Documentation

◆ AcceptCall()

ZDK_NET::Result ^ ZDK_NET::Call::AcceptCall ( )

Accepts an incoming call.

Accepts an incoming call and opens audio and video channels for communication.

Returns: The result of accepting call up

See also: Result

◆ AcceptCallTransfer()

ZDK_NET::Call ^ ZDK_NET::Call::AcceptCallTransfer ( )

Accept a call transfer request.

Accept a call transfer request and creates a new outgoing call to the transfer target.

The notification listeners will be coppied to the newly created call!

The new call will get all the relevant callbacks as if it was normally created outgoing call.

The old call will be hung up only after the new call is succesful.

Returns: The newly created transferring call or NULL in case of transfer failure

See also: Call

◆ AcceptVideo()

ZDK_NET::Result ^ ZDK_NET::Call::AcceptVideo ( bool accept )

Accepts an incoming offer for video.

Parameters

[in] accept Flag indicating whether to accept or reject the offered video

Returns: The result of accepted video

See also: Result

◆ AttendedTransfer()

ZDK_NET::Result ^ ZDK_NET::Call::AttendedTransfer ( ZDK_NET::Call^ transferee )

Initiates an attended call transfer.

Initiates an attended call transfer. There have to be two calls using the same user account (call direction doesn't matter). The calls must have been accepted. They can be currently on hold. The library will put the calls on hold if they already weren't. If the transfer fails the first call will be retrieved back.

For SIP calls the REFER message will be sent to the first call.

Parameters

[in] transferee The call to which the current call to be transfered to

Returns: The result of the attended transfer

See also: Result

◆ BlindTransfer()

ZDK_NET::Result ^ ZDK_NET::Call::BlindTransfer ( System::String^ transferee )

Initiates an unattended call transfer.

Initiates an unattended transfer (also called blind transfer). This function can be used for incoming SIP calls to redirect them. Incoming AX2 calls cannot be redirected.

Calls that were answered (incoming or outgoing) can be transferred using this function (both SIP and AX2).

The function returns immediately. If there is no error the process of unattended transfer will start.

Parameters

[in] transferee The name of the Peer to which the current call to be transfered to

Returns: The result of the unattended transfer

See also: Result

◆ ConfigureCallRecordFormat()

ZDK_NET::Result ^ ZDK_NET::Call::ConfigureCallRecordFormat ( ZDK_NET::AudioFileFormat format )

Configures a call recording's encoding format and its specific settings.

Parameters

[in] format The format in which the call recording to be stored

Returns: Result of enabling configuring the call record format

See also: Result, AudioFileFormat

◆ ConfirmZrtpSas()

ZDK_NET::Result ^ ZDK_NET::Call::ConfirmZrtpSas ( bool confirmed )

Enables ZRTP.

Parameters

[in]

confirmed

0 - disabled
1 - enabled

Returns: Result of enabling zrtp

See also: Result

◆ DropCallStatusListener()

void ZDK_NET::Call::DropCallStatusListener ( ZDK_NET::CallEventsHandler^ value )

Drops Call status listener.

Parameters

[in] value The call events handler to drop

See also: CallEventsHandler

◆ EnableZrtp()

ZDK_NET::Result ^ ZDK_NET::Call::EnableZrtp ( bool enabled )

Enables ZRTP.

Parameters

[in]

enabled

0 - disabled
1 - enabled

Returns: Result of enabling zrtp

See also: Result

◆ HangUp()

ZDK_NET::Result ^ ZDK_NET::Call::HangUp ( )

Hang up the call.

Returns: The result of hanging up

See also: Result

◆ HasVideo()

bool ZDK_NET::Call::HasVideo ( ZDK_NET::OriginType origin )

Gets if video is present.

Gets if video is present, local or remote.

Parameters

[in] origin The side that we want to check if video is present (local or remote)

Returns: bool with the result of the state

See also: OriginType

◆ NotifyAccountOfOwnershipChange()

ZDK_NET::Result ^ ZDK_NET::Call::NotifyAccountOfOwnershipChange ( )

Notify upon Account ownership changes.

Returns: result of notification

See also: Result

◆ OfferVideo()

ZDK_NET::Result ^ ZDK_NET::Call::OfferVideo ( )

Offers Video.

Offers video to the remote party during a normal (audio) call.

Returns: The result of the video offer

See also: Result

◆ RejectCallTransfer()

ZDK_NET::Result ^ ZDK_NET::Call::RejectCallTransfer ( )

Rejects a call transfer request.

Rejects a call transfer request.For SIP, the call will continue as usual.

Returns: The result of rejecting the call transfer

See also: Result

◆ RestartVideoCapture()

ZDK_NET::Result ^ ZDK_NET::Call::RestartVideoCapture ( )

Restart Video capture.

Returns: Result of the restarting video capture

See also: Result

◆ Ringing()

ZDK_NET::Result ^ ZDK_NET::Call::Ringing ( )

Notifies the remote party that we are ringing (incoming calls)

Sends a ringing notification to the remote party for an incoming call. The call must not be accepted yet.

Returns: The result of the ringing notification

See also: Result

◆ SendDTMF()

ZDK_NET::Result ^ ZDK_NET::Call::SendDTMF ( ZDK_NET::DTMFCodes dtmf )

Sends a DTMF signal over a call.

Sends a DTMF signal over a call. The BS (backspace) key is only supported by SIP/KPML. To select the DTMF type use AccountConfig::DTMFBand().

The function returns immediately. If there is no immediate error the function will return OK and the actual status of the DTMF send operation will be delivered via a callback.

By default The ZDK will not produce an audible local signal to reflect the DTMF transmission. You can configure the ZDK to produce an audible signal by using AccountConfig::DTMFAutoplay().

Parameters

[in] dtmf The DTMF you want to send

Returns: result of sending DTMF

See also: AccountConfig, Result, DTMFCodes

◆ SendVideoFrame()

void ZDK_NET::Call::SendVideoFrame	(	unsigned char *	bytes,
		int	byteCount,
		ZDK_NET::VideoFrameFormat	type
	)

Send a video frame over the network.

Send an arbitrary-format frame to the remote party

The function will copy the buffer into its internal structures and schedule it for encoding and transmitting over the video call. It will return immediately.

Parameters

[in]	bytes	The buffer that holds the bytes
[in]	byteCount	The buffer size in number of bytes
[in]	type	The format of the frame we are sending

See also: VideoFrameFormat

◆ SetCallStatusListener()

void ZDK_NET::Call::SetCallStatusListener ( ZDK_NET::CallEventsHandler^ value )

Sets Call status listener.

Parameters

[in] value The call events handler

See also: CallEventsHandler

◆ StartRecording()

ZDK_NET::Result ^ ZDK_NET::Call::StartRecording ( )

Start recording call.

Returns: Result of StartRecoding

See also: Result

◆ StopRecording()

ZDK_NET::Result ^ ZDK_NET::Call::StopRecording ( )

Stop recording.

Returns: Result of StopRecoding

See also: Result

◆ VideoGetCameraLocation()

ZDK_NET::CameraSensorLocation ZDK_NET::Call::VideoGetCameraLocation ( )

Provides Camera location.

Provides Camera location ( Front, Back, NA )

Returns: The camera seonsor object that holds the camera location information

See also: CameraSensorLocation

◆ VideoToggleCamera()

ZDK_NET::Result ^ ZDK_NET::Call::VideoToggleCamera ( )

Toggles the camera.

Returns: The result of toggling the camera

See also: Result

Property Documentation

◆ CalleeName

System:: String^ ZDK_NET::Call::CalleeName

get

Provides the Callee name.

Returns: String with the callee name

◆ CalleeNumber

System:: String^ ZDK_NET::Call::CalleeNumber

get

Provides the Callee number.

Returns: String with the callee number

◆ CallHandle

long long ZDK_NET::Call::CallHandle

get

Gets call handle.

Returns: ZDKHandle object holding the handle

◆ CodecInUse

ZDK_NET:: AudioVideoCodecs ZDK_NET::Call::CodecInUse

get

Provides the used codec.

Returns: AudioVideoCodecs representing the used codec

See also: AudioVideoCodecs

◆ Held

bool ZDK_NET::Call::Held

getset

Sets the hold state.

Parameters

[in]

value

0 - resume
1 - hold

◆ Muted

bool ZDK_NET::Call::Muted

getset

Sets the Mute state of the local input device.

Mutes/unmutes the local input device (microphone).

Parameters

[in]

value

0 - unmute
1 - mute

◆ OnSpeaker

bool ZDK_NET::Call::OnSpeaker

getset

Sets the speakers state.

!!!NOTE!!! Only keeps track of the SPEAKER state. DOES NOT change the audio routing!!! API user is responsible for changing the audio routing!!!

Parameters

[in]

value

0 - disabled
1 - enabled

◆ Owner

ZDK_NET:: Account^ ZDK_NET::Call::Owner

get

Returns the account owner.

Returns: The account owner

See also: Account

◆ RecordFileName

System:: String^ ZDK_NET::Call::RecordFileName

set

Sets the record file name.

Parameters

[in] value The name of the record file to be used

◆ Status

ZDK_NET:: CallStatus^ ZDK_NET::Call::Status

get

Provides the Call's status information.

Returns: The call status

See also: CallStatus

◆ VideoCallInfo

ZDK_NET:: VideoCallInfo^ ZDK_NET::Call::VideoCallInfo

get

Gets Video call information.

Gets if video is present, local or remote.

Returns: Video Call Information object

See also: VideoCallInfo

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

Call.h

Public Member Functions

Public Attributes

Properties

Member Function Documentation

◆ AcceptCall()

◆ AcceptCallTransfer()

◆ AcceptVideo()

◆ AttendedTransfer()

◆ BlindTransfer()

◆ ConfigureCallRecordFormat()

◆ ConfirmZrtpSas()

◆ DropCallStatusListener()

◆ EnableZrtp()

◆ HangUp()

◆ HasVideo()

◆ NotifyAccountOfOwnershipChange()

◆ OfferVideo()

◆ RejectCallTransfer()

◆ RestartVideoCapture()

◆ Ringing()

◆ SendDTMF()

◆ SendVideoFrame()

◆ SetCallStatusListener()

◆ StartRecording()

◆ StopRecording()

◆ VideoGetCameraLocation()

◆ VideoToggleCamera()

Property Documentation

◆ CalleeName

◆ CalleeNumber

◆ CallHandle

◆ CodecInUse

◆ Held

◆ Muted

◆ OnSpeaker

◆ Owner

◆ RecordFileName

◆ Status

◆ VideoCallInfo