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

Instance Methods

(id< ZDKResult >) - addCall:
 Adds a call to the conference. More...
 
(id< ZDKResult >) - removeCall:hangUp:
 Removes a call from the conference. More...
 
(id< ZDKResult >) - muteCall:
 Mute a call in the conference. More...
 
(id< ZDKResult >) - unmuteCall:
 Unmute a call in the conference. More...
 
(BOOL) - isCallFromConference:
 Checks if a call is part of conference. More...
 
(id< ZDKResult >) - acquireVideoSinkMngrFromCall:
 Acquire video sink from call. More...
 
(void) - setConferenceEventsListener:
 Set Conference Events Listener. More...
 
(void) - dropConferenceEventsListener:
 Drops Conference Events Listener. More...
 
(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKCall>
(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 conferenceHandle
 Gets conference handle. More...
 
int callsCount
 Gives the number of calls in conference. More...
 
NSArray< id< ZDKCall > > * calls
 Gives list with all calls in conference. More...
 
- Properties inherited from <ZDKCall>
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

◆ acquireVideoSinkMngrFromCall:

- (id< ZDKResult >) acquireVideoSinkMngrFromCall: (id< ZDKCall >)  call

Acquire video sink from call.

Parameters
[in]callThe call which video sink to be aquired
Returns
Result of the acquiring

◆ addCall:

- (id< ZDKResult >) addCall: (id< ZDKCall >)  hCall

Adds a call to the conference.

Adds a call to the conference. If the call is already part of another conference, it will be moved.

Parameters
[in]hCallThe call to add to the conference
Returns
The result of the function
See also
ZDKCall, ZDKResult

◆ dropConferenceEventsListener:

- (void) dropConferenceEventsListener: (id< ZDKConferenceEventsHandler >)  confEventHandler

Drops Conference Events Listener.

Parameters
[in]confEventHandlerThe conference event handler
See also
ZDKConferenceEventsHandler

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKCall>.

◆ isCallFromConference:

- (BOOL) isCallFromConference: (long int)  hCall

Checks if a call is part of conference.

Parameters
[in]hCallThe call to be checked
Returns
True if the call is part of the conference, false otherwise

◆ muteCall:

- (id< ZDKResult >) muteCall: (id< ZDKCall >)  hCall

Mute a call in the conference.

Parameters
[in]hCallThe call to be muted
Returns
The result of muting
See also
ZDKCall, ZDKResult

◆ removeCall:hangUp:

- (id< ZDKResult >) removeCall: (id< ZDKCall >)  hCall
hangUp: (BOOL)  hangUp 

Removes a call from the conference.

Parameters
[in]hCallThe call to remove from the conference
[in]hangUpboolean to hang up or not
Returns
The result of the function
See also
ZDKCall, ZDKResult

◆ setConferenceEventsListener:

- (void) setConferenceEventsListener: (id< ZDKConferenceEventsHandler >)  confEventHandler

Set Conference Events Listener.

Parameters
[in]confEventHandlerThe conference event handler
See also
ZDKConferenceEventsHandler

◆ unmuteCall:

- (id< ZDKResult >) unmuteCall: (id< ZDKCall >)  hCall

Unmute a call in the conference.

Parameters
[in]hCallThe call to be Unmute
Returns
The result of Unmute
See also
ZDKCall, ZDKResult

Property Documentation

◆ calls

- (NSArray<id<ZDKCall> >*) calls
readnonatomicassign

Gives list with all calls in conference.

Returns
The list with calls in conference

◆ callsCount

- (int) callsCount
readnonatomicassign

Gives the number of calls in conference.

Returns
The number of calls

◆ conferenceHandle

- (long int) conferenceHandle
readnonatomicassign

Gets conference handle.

The function returns the conference handler

Returns
The conference handle

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