zdk.objc
Instance Methods | Properties | List of all members
<ZDKCall> Protocol Reference
Inheritance diagram for <ZDKCall>:
<ZDKZHandle> <ZDKConference>

Instance Methods

(void) - setCallStatusListener:
 Sets Call status listener. More...
 
(void) - dropCallStatusListener:
 Drops Call status listener. More...
 
(void) - dropAllEventListeners
 Drops all event listeners.
 
(void) - setVideoRendererNotificationsListener:
 
(id< ZDKResult >) - ringing
 Notifies the remote party that we are ringing (incoming calls) More...
 
(id< ZDKResult >) - acceptCall
 Accepts an incoming call. More...
 
(id< ZDKResult >) - hangUp
 Hang up the call. More...
 
(id< ZDKCall >) - acceptCallTransfer
 Accept a call transfer request. More...
 
(id< ZDKResult >) - rejectCallTransfer
 Rejects a call transfer request. More...
 
(id< ZDKResult >) - attendedTransfer:
 Initiates an attended call transfer. More...
 
(id< ZDKResult >) - blindTransfer:
 Initiates an unattended call transfer. More...
 
(id< ZDKResult >) - acceptVideo:
 Accepts an incoming offer for video. More...
 
(id< ZDKResult >) - offerVideo
 Offers Video. More...
 
(void) - sendVideoFrame:byteCount:type:
 Send a video frame over the network. More...
 
(id< ZDKResult >) - videoToggleCamera
 Toggles the camera. More...
 
(ZDKCameraSensorLocation) - videoGetCameraLocation
 Provides Camera location. More...
 
(id< ZDKResult >) - restartVideoCapture
 Restart Video capture. More...
 
(BOOL) - hasVideo:
 Gets if video is present. More...
 
(void) - stopHandlingVoipPhoneCallEvents
 Stops handling Call events.
 
(void) - startHandlingVoipPhoneCallEvents
 Start handling Call events.
 
(id< ZDKResult >) - notifyAccountOfOwnershipChange
 Notify upon Account ownership changes. More...
 
(id< ZDKResult >) - sendDTMF:
 Sends a DTMF signal over a call. More...
 
(id< ZDKResult >) - startRecording
 Start recording call. More...
 
(id< ZDKResult >) - stopRecording
 Stop recording. More...
 
(id< ZDKResult >) - enableZrtp:
 Enables ZRTP. More...
 
(id< ZDKResult >) - confirmZrtpSas:
 Enables ZRTP. More...
 
(id< ZDKResult >) - configureCallRecordFormat:
 Configures a call recording's encoding format and its specific settings. More...
 
(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKZHandle>
(long int) - handle
 
(void) - initialize
 
(void) - releaseReference
 
(NSString *) - handlesDescription
 

Properties

long int callHandle
 Gets call handle. More...
 
id< ZDKBrandingInfo > _Nullable branding
 
id< ZDKCallStatusstatus
 Provides the Call's status information. More...
 
NSString * calleeNumber
 Provides the Callee number. More...
 
NSString * calleeName
 Provides the Callee name. More...
 
ZDKAudioVideoCodecs codecInUse
 Provides the used codec. More...
 
BOOL onSpeaker
 Sets the speakers state. More...
 
BOOL held
 Sets the hold state. More...
 
BOOL muted
 Sets the Mute state of the local input device. More...
 
id< ZDKVideoCallInfo > _Nullable videoCallInfo
 Gets Video call information. More...
 
BOOL isFirstClass
 
id< ZDKAccountowner
 Returns the account owner. More...
 
NSString * recordFileName
 Sets the record file name. More...
 

Method Documentation

◆ acceptCall

- (id< ZDKResult >) 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
ZDKResult

◆ acceptCallTransfer

- (id< ZDKCall >) 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
ZDKCall

◆ acceptVideo:

- (id< ZDKResult >) acceptVideo: (BOOL)  accept

Accepts an incoming offer for video.

Parameters
[in]acceptFlag indicating whether to accept or reject the offered video
Returns
The result of accepted video
See also
ZDKResult

◆ attendedTransfer:

- (id< ZDKResult >) attendedTransfer: (id< ZDKCall >)  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]transfereeThe call to which the current call to be transfered to
Returns
The result of the attended transfer
See also
ZDKResult

◆ blindTransfer:

- (id< ZDKResult >) blindTransfer: (NSString *)  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 ZDKAX2 calls cannot be redirected.

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

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

Parameters
[in]transfereeThe name of the Peer to which the current call to be transfered to
Returns
The result of the unattended transfer
See also
ZDKResult

◆ configureCallRecordFormat:

- (id< ZDKResult >) configureCallRecordFormat: (ZDKAudioFileFormat)  format

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

Parameters
[in]formatThe format in which the call recording to be stored
Returns
Result of enabling configuring the call record format
See also
ZDKResult, AudioFileFormat

◆ confirmZrtpSas:

- (id< ZDKResult >) confirmZrtpSas: (BOOL)  confirmed

Enables ZRTP.

Parameters
[in]confirmed
  • 0 - disabled
  • 1 - enabled
Returns
Result of enabling zrtp
See also
ZDKResult

◆ dropCallStatusListener:

- (void) dropCallStatusListener: (id< ZDKCallEventsHandler >)  value

Drops Call status listener.

Parameters
[in]valueThe call events handler to drop
See also
ZDKCallEventsHandler

◆ enableZrtp:

- (id< ZDKResult >) enableZrtp: (BOOL)  enabled

Enables ZRTP.

Parameters
[in]enabled
  • 0 - disabled
  • 1 - enabled
Returns
Result of enabling zrtp
See also
ZDKResult

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

◆ hangUp

- (id< ZDKResult >) hangUp

Hang up the call.

Returns
The result of hanging up
See also
ZDKResult

◆ hasVideo:

- (BOOL) hasVideo: (ZDKOriginType)  origin

Gets if video is present.

Gets if video is present, local or remote.

Parameters
[in]originThe 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

- (id< ZDKResult >) notifyAccountOfOwnershipChange

Notify upon Account ownership changes.

Returns
result of notification
See also
ZDKResult

◆ offerVideo

- (id< ZDKResult >) offerVideo

Offers Video.

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

Returns
The result of the video offer
See also
ZDKResult

◆ rejectCallTransfer

- (id< ZDKResult >) 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
ZDKResult

◆ restartVideoCapture

- (id< ZDKResult >) restartVideoCapture

Restart Video capture.

Returns
Result of the restarting video capture
See also
ZDKResult

◆ ringing

- (id< ZDKResult >) 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
ZDKResult

◆ sendDTMF:

- (id< ZDKResult >) sendDTMF: (ZDKDTMFCodes)  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 zdkAccountConfig::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 zdkAccountConfig::DTMFAutoplay().

Parameters
[in]dtmfThe DTMF you want to send
Returns
result of sending DTMF
See also
ZDKAccountConfig, ZDKResult, DTMFCodes

◆ sendVideoFrame:byteCount:type:

- (void) sendVideoFrame: (unsigned char *)  bytes
byteCount: (int)  byteCount
type: (ZDKVideoFrameFormat)  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]bytesThe buffer that holds the bytes
[in]byteCountThe buffer size in number of bytes
[in]typeThe format of the frame we are sending
See also
VideoFrameFormat

◆ setCallStatusListener:

- (void) setCallStatusListener: (id< ZDKCallEventsHandler >)  value

Sets Call status listener.

Parameters
[in]valueThe call events handler
See also
ZDKCallEventsHandler

◆ startRecording

- (id< ZDKResult >) startRecording

Start recording call.

Returns
Result of StartRecoding
See also
ZDKResult

◆ stopRecording

- (id< ZDKResult >) stopRecording

Stop recording.

Returns
Result of StopRecoding
See also
ZDKResult

◆ videoGetCameraLocation

- (ZDKCameraSensorLocation) 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

- (id< ZDKResult >) videoToggleCamera

Toggles the camera.

Returns
The result of toggling the camera
See also
ZDKResult

Property Documentation

◆ calleeName

- (NSString*) calleeName
readnonatomicassign

Provides the Callee name.

Returns
String with the callee name

◆ calleeNumber

- (NSString*) calleeNumber
readnonatomicassign

Provides the Callee number.

Returns
String with the callee number

◆ callHandle

- (long int) callHandle
readnonatomicassign

Gets call handle.

Returns
ZDKHandle object holding the handle

◆ codecInUse

- (ZDKAudioVideoCodecs) codecInUse
readnonatomicassign

Provides the used codec.

Returns
AudioVideoCodecs representing the used codec
See also
AudioVideoCodecs

◆ held

- (BOOL) held
readwritenonatomicassign

Sets the hold state.

Parameters
[in]value
  • 0 - resume
  • 1 - hold

◆ muted

- (BOOL) muted
readwritenonatomicassign

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) onSpeaker
readwritenonatomicassign

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

- (id<ZDKAccount>) owner
readnonatomicassign

Returns the account owner.

Returns
The account owner
See also
ZDKAccount

◆ recordFileName

- (NSString*) recordFileName
readwritenonatomicassign

Sets the record file name.

Parameters
[in]valueThe name of the record file to be used

◆ status

- (id<ZDKCallStatus>) status
readnonatomicassign

Provides the Call's status information.

Returns
The call status
See also
ZDKCallStatus

◆ videoCallInfo

- (id<ZDKVideoCallInfo> _Nullable) videoCallInfo
readnonatomicassign

Gets Video call information.

Gets if video is present, local or remote.

Returns
Video Call Information object
See also
ZDKVideoCallInfo

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