Inheritance diagram for ZDK::ICall:

Public Member Functions
virtual ZDK::ZDKHandle	CallHandle () const =0
	Gets call handle. More...

virtual ZDK::Shared::BrandingInfo	Branding () const =0

virtual void	Branding (ZDK::Shared::BrandingInfo value)=0

virtual ZDK::Shared::CallStatus	Status () const =0
	Provides the Call's status information. More...

virtual ZDK::Shared::String	CalleeNumber () const =0
	Provides the Callee number. More...

virtual ZDK::Shared::String	CalleeName () const =0
	Provides the Callee name. More...

virtual ZDK::AudioVideoCodecs	CodecInUse () const =0
	Provides the used codec. More...

virtual void	SetCallStatusListener (ZDK::Shared::CallEventsHandler value)=0
	Sets Call status listener. More...

virtual void	DropCallStatusListener (ZDK::Shared::CallEventsHandler value)=0
	Drops Call status listener. More...

virtual void	SetVideoCallNotificiationsListener (ZDK::Shared::VideoEventsHandler value)=0
	Sets Video status listener. More...

virtual void	DropVideoCallNotificiationsListener (ZDK::Shared::VideoEventsHandler value)=0
	Drops Video status listener. More...

virtual void	DropAllEventListeners ()=0
	Drops all event listeners. More...

virtual void	SetVideoRendererNotificationsListener (ZDK::Shared::VideoRendererEventsHandler value)=0

virtual ZDK::Shared::Result	HangUp ()=0
	Hang up the call. More...

virtual ZDK::Shared::Result	AcceptCall ()=0
	Accepts an incoming call. More...

virtual ZDK::Shared::Result	AcceptCallTransfer ()=0
	Accept a call transfer request. More...

virtual ZDK::Shared::Result	RejectCallTransfer ()=0
	Rejects a call transfer request. More...

virtual ZDK::Shared::Result	AttendedTransfer (ZDK::Shared::Call transferee)=0
	Initiates an attended call transfer. More...

virtual ZDK::Shared::Result	BlindTransfer (ZDK::Shared::String transferee)=0
	Initiates an unattended call transfer. More...

virtual ZDK::Shared::Result	AcceptVideo (bool accept)=0
	Accepts an incoming offer for video. More...

virtual ZDK::Shared::Result	OfferVideo ()=0
	Offers Video. More...

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

virtual ZDK::Shared::Result	VideoToggleCamera ()=0
	Toggles the camera. More...

virtual ZDK::CameraSensorLocation	VideoGetCameraLocation ()=0
	Provides Camera location. More...

virtual ZDK::Shared::Result	RestartVideoCapture ()=0
	Restart Video capture. More...

virtual bool	OnSpeaker () const =0
	Gets the speakers state. More...

virtual void	OnSpeaker (bool value)=0
	Sets the speakers state. More...

virtual bool	Held () const =0
	Gets the Hold state. More...

virtual void	Held (bool value)=0
	Sets the hold state. More...

virtual bool	Muted () const =0
	Gets the Mute state. More...

virtual void	Muted (bool value)=0
	Sets the Mute state. More...

virtual bool	HasVideo (ZDK::OriginType origin) const =0
	Gets if video is present. More...

virtual ZDK::Shared::Result	SetHasVideo (ZDK::OriginType origin, bool value)=0
	Sets the video. More...

virtual ZDK::Shared::VideoCallInfo	VideoCallInfo () const =0
	Gets Video call information. More...

virtual ZDK::Shared::VideoSinkManager	ReleaseVideoSinkSourceOwnership ()=0

virtual bool	IsFirstClass () const =0

virtual void	StopHandlingVoipPhoneCallEvents ()=0
	Stops handling Call events. More...

virtual void	StartHandlingVoipPhoneCallEvents ()=0
	Start handling Call events. More...

virtual ZDK::Shared::Result	NotifyAccountOfOwnershipChange ()=0
	Notify upon Account ownership changes. More...

virtual ZDK::Shared::Result	SendDTMF (ZDK::DTMFCodes DTMF)=0
	Used to send DTMF. More...

virtual ZDK::Shared::Result	PlayDTMFSound (ZDK::DTMFCodes DTMF)=0
	Used to play DTMF sound. More...

virtual ZDK::Shared::Account	Owner () const =0
	Returns the account owner. More...

virtual ZDK::Shared::String	RecordFileName () const =0
	Gets the record file name. More...

virtual void	RecordFileName (ZDK::Shared::String fileName)=0
	Sets the record file name. More...

virtual ZDK::Shared::Result	StartRecording ()=0
	Start recording call. More...

virtual ZDK::Shared::Result	StopRecording ()=0
	Stop recording. More...

virtual ZDK::Shared::Result	EnableZrtp (bool enabled)=0
	Enables ZRTP. More...

virtual ZDK::Shared::Result	ConfirmZrtpSas (bool confirmed)=0
	Enables ZRTP. More...

Public Member Functions inherited from ZDK::IZHandle
virtual ZDK::ZDKHandle	Handle () const =0

virtual	operator ZDK::ZDKHandle () const =0

virtual void	Initialize ()=0

virtual void	ReleaseReference ()=0

Member Function Documentation

◆ AcceptCall()

virtual ZDK::Shared::Result ZDK::ICall::AcceptCall ( )

pure virtual

Accepts an incoming call.

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

Returns: The result of accepting call up

◆ AcceptCallTransfer()

virtual ZDK::Shared::Result ZDK::ICall::AcceptCallTransfer ( )

pure virtual

Accept a call transfer request.

Accept a call transfer request. Periodical updates on the new call's state will be sent to the old call. The old call will be hung up only after the new call is succesful.

The new call will get all the relevant callbacks.

Returns: The result of accepting the call transfer

◆ AcceptVideo()

virtual ZDK::Shared::Result ZDK::ICall::AcceptVideo ( bool accept )

pure virtual

Accepts an incoming offer for video.

Returns: The result of accepted video

◆ AttendedTransfer()

virtual ZDK::Shared::Result ZDK::ICall::AttendedTransfer ( ZDK::Shared::Call transferee )

pure virtual

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.

Returns: The result of the attended transfer

◆ BlindTransfer()

virtual ZDK::Shared::Result ZDK::ICall::BlindTransfer ( ZDK::Shared::String transferee )

pure virtual

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 IAX2 calls cannot be redirected.

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

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

Returns: The result of the unattended transfer

◆ CalleeName()

virtual ZDK::Shared::String ZDK::ICall::CalleeName ( ) const

pure virtual

Provides the Callee name.

Returns: String with the callee name

◆ CalleeNumber()

virtual ZDK::Shared::String ZDK::ICall::CalleeNumber ( ) const

pure virtual

Provides the Callee number.

Returns: String with the callee number

◆ CallHandle()

virtual ZDK::ZDKHandle ZDK::ICall::CallHandle ( ) const

pure virtual

Gets call handle.

Returns: ZDKHandle object holding the handle

◆ CodecInUse()

virtual ZDK::AudioVideoCodecs ZDK::ICall::CodecInUse ( ) const

pure virtual

Provides the used codec.

Returns: AudioVideoCodecs representing the used codec

◆ ConfirmZrtpSas()

virtual ZDK::Shared::Result ZDK::ICall::ConfirmZrtpSas ( bool confirmed )

pure virtual

Enables ZRTP.

Returns: Result of enabling zrtp

◆ DropAllEventListeners()

virtual void ZDK::ICall::DropAllEventListeners ( )

pure virtual

Drops all event listeners.

◆ DropCallStatusListener()

virtual void ZDK::ICall::DropCallStatusListener ( ZDK::Shared::CallEventsHandler value )

pure virtual

Drops Call status listener.

Parameters

[in] value The call events handler to drop

◆ DropVideoCallNotificiationsListener()

virtual void ZDK::ICall::DropVideoCallNotificiationsListener ( ZDK::Shared::VideoEventsHandler value )

pure virtual

Drops Video status listener.

Parameters

[in] value The call events handler to drop

◆ EnableZrtp()

virtual ZDK::Shared::Result ZDK::ICall::EnableZrtp ( bool enabled )

pure virtual

Enables ZRTP.

Returns: Result of enabling zrtp

◆ HangUp()

virtual ZDK::Shared::Result ZDK::ICall::HangUp ( )

pure virtual

Hang up the call.

Returns: The result of hanging up

◆ HasVideo()

virtual bool ZDK::ICall::HasVideo ( ZDK::OriginType origin ) const

pure virtual

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: IOriginType

◆ Held() [1/2]

virtual bool ZDK::ICall::Held ( ) const

pure virtual

Gets the Hold state.

Returns: Bool result of the hold state

◆ Held() [2/2]

virtual void ZDK::ICall::Held ( bool value )

pure virtual

Sets the hold state.

◆ Muted() [1/2]

virtual bool ZDK::ICall::Muted ( ) const

pure virtual

Gets the Mute state.

Returns: Bool result of the Mute state

◆ Muted() [2/2]

virtual void ZDK::ICall::Muted ( bool value )

pure virtual

Sets the Mute state.

◆ NotifyAccountOfOwnershipChange()

virtual ZDK::Shared::Result ZDK::ICall::NotifyAccountOfOwnershipChange ( )

pure virtual

Notify upon Account ownership changes.

Returns: result of notification

◆ OfferVideo()

virtual ZDK::Shared::Result ZDK::ICall::OfferVideo ( )

pure virtual

Offers Video.

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

Returns: The result of the video offer

◆ OnSpeaker() [1/2]

virtual bool ZDK::ICall::OnSpeaker ( ) const

pure virtual

Gets the speakers state.

Returns: Bool result of the speakers state

◆ OnSpeaker() [2/2]

virtual void ZDK::ICall::OnSpeaker ( bool value )

pure virtual

Sets the speakers state.

◆ Owner()

virtual ZDK::Shared::Account ZDK::ICall::Owner ( ) const

pure virtual

Returns the account owner.

Returns: The account owner

◆ PlayDTMFSound()

virtual ZDK::Shared::Result ZDK::ICall::PlayDTMFSound ( ZDK::DTMFCodes DTMF )

pure virtual

Used to play DTMF sound.

Parameters

[in] DTMF The DTMF you want to send

Returns: result of sending DTMF

See also: IDTMFCodes

◆ RecordFileName() [1/2]

virtual ZDK::Shared::String ZDK::ICall::RecordFileName ( ) const

pure virtual

Gets the record file name.

Returns: The record file name as String

◆ RecordFileName() [2/2]

virtual void ZDK::ICall::RecordFileName ( ZDK::Shared::String fileName )

pure virtual

Sets the record file name.

◆ RejectCallTransfer()

virtual ZDK::Shared::Result ZDK::ICall::RejectCallTransfer ( )

pure virtual

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

◆ RestartVideoCapture()

virtual ZDK::Shared::Result ZDK::ICall::RestartVideoCapture ( )

pure virtual

Restart Video capture.

Returns: Result of the restarting video capture

◆ SendDTMF()

virtual ZDK::Shared::Result ZDK::ICall::SendDTMF ( ZDK::DTMFCodes DTMF )

pure virtual

Used to send DTMF.

Parameters

[in] DTMF The DTMF you want to send

Returns: result of sending DTMF

See also: IDTMFCodes

◆ SendVideoFrame()

virtual void ZDK::ICall::SendVideoFrame	(	unsigned char *	bytes,
		int	byteCount,
		ZDK::VideoFrameFormat	type
	)

pure virtual

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]	VideoFrameFormat	The format of the frame we are sending

See also: IVideoFrameFormat

◆ SetCallStatusListener()

virtual void ZDK::ICall::SetCallStatusListener ( ZDK::Shared::CallEventsHandler value )

pure virtual

Sets Call status listener.

Parameters

[in] value The call events handler

◆ SetHasVideo()

virtual ZDK::Shared::Result ZDK::ICall::SetHasVideo	(	ZDK::OriginType	origin,
		bool	value
	)

pure virtual

Sets the video.

Sets the state of video for both remote and local

Parameters

[in]	origin	The side that we want to set the video presentability
[in]	value	The value that is changed to

See also: IOriginType

◆ SetVideoCallNotificiationsListener()

virtual void ZDK::ICall::SetVideoCallNotificiationsListener ( ZDK::Shared::VideoEventsHandler value )

pure virtual

Sets Video status listener.

Parameters

[in] value The Video events handler

◆ StartHandlingVoipPhoneCallEvents()

virtual void ZDK::ICall::StartHandlingVoipPhoneCallEvents ( )

pure virtual

Start handling Call events.

◆ StartRecording()

virtual ZDK::Shared::Result ZDK::ICall::StartRecording ( )

pure virtual

Start recording call.

Returns: Result of StartRecoding

◆ Status()

virtual ZDK::Shared::CallStatus ZDK::ICall::Status ( ) const

pure virtual

Provides the Call's status information.

Returns: The call status

See also: ICallStatus

◆ StopHandlingVoipPhoneCallEvents()

virtual void ZDK::ICall::StopHandlingVoipPhoneCallEvents ( )

pure virtual

Stops handling Call events.

◆ StopRecording()

virtual ZDK::Shared::Result ZDK::ICall::StopRecording ( )

pure virtual

Stop recording.

Returns: Result of StopRecoding

◆ VideoCallInfo()

virtual ZDK::Shared::VideoCallInfo ZDK::ICall::VideoCallInfo ( ) const

pure virtual

Gets Video call information.

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: Video Call Information object

See also: IOriginType, IVideoCallInfo

◆ VideoGetCameraLocation()

virtual ZDK::CameraSensorLocation ZDK::ICall::VideoGetCameraLocation ( )

pure virtual

Provides Camera location.

Provides Camera location ( Front, Back, NA )

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

See also: ICameraSensorLocation

◆ VideoToggleCamera()

virtual ZDK::Shared::Result ZDK::ICall::VideoToggleCamera ( )

pure virtual

Toggles the camera.

Returns: The result of toggling the camera

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

ICall.h

Public Member Functions

Member Function Documentation

◆ AcceptCall()

◆ AcceptCallTransfer()

◆ AcceptVideo()

◆ AttendedTransfer()

◆ BlindTransfer()

◆ CalleeName()

◆ CalleeNumber()

◆ CallHandle()

◆ CodecInUse()

◆ ConfirmZrtpSas()

◆ DropAllEventListeners()

◆ DropCallStatusListener()

◆ DropVideoCallNotificiationsListener()

◆ EnableZrtp()

◆ HangUp()

◆ HasVideo()

◆ Held() [1/2]

◆ Held() [2/2]

◆ Muted() [1/2]

◆ Muted() [2/2]

◆ NotifyAccountOfOwnershipChange()

◆ OfferVideo()

◆ OnSpeaker() [1/2]

◆ OnSpeaker() [2/2]

◆ Owner()

◆ PlayDTMFSound()

◆ RecordFileName() [1/2]

◆ RecordFileName() [2/2]

◆ RejectCallTransfer()

◆ RestartVideoCapture()

◆ SendDTMF()

◆ SendVideoFrame()

◆ SetCallStatusListener()

◆ SetHasVideo()

◆ SetVideoCallNotificiationsListener()

◆ StartHandlingVoipPhoneCallEvents()

◆ StartRecording()

◆ Status()

◆ StopHandlingVoipPhoneCallEvents()

◆ StopRecording()

◆ VideoCallInfo()

◆ VideoGetCameraLocation()

◆ VideoToggleCamera()