RtccCallDelegate Protocol Reference

Conforms to NSObject
Declared in RtccCall.h

Overview

Delegate for the RtccCall Singleton.

Allows the Host Application to be notified upon events. All methods are optional.

– rtccCall:videoReceiving:

Called when the call starts or stops receiving video.

- (void)rtccCall:(id)sender videoReceiving:(BOOL)isReceiving
Parameters
sender

The RtccCall which property changed.

isReceiving

Answers “Are we receing video?”.

Availability

5.0

Declared In

RtccCall.h

– rtccCall:cursorLocationInShare:

Called when the SDK receives cursor coordinates in the share view.

This location is in percent, between 0 and 99 (width%, height%). If the cursor is out of the view, location is -1x-1.

- (void)rtccCall:(id)sender cursorLocationInShare:(CGPoint)location
Parameters
sender

The RtccCall which property changed.

location

The inbound video cursor location. If -1x-1, the remote’s cursor is not over the share view.

Availability

5.3

Declared In

RtccCall.h

– rtccCall:cursorClick:onShareInAt:

Called when the SDK receives a cursor click event.

This location is in percent, between 0 and 99 (width%, height%). If the cursor is out of the view, location is -1x-1.

- (void)rtccCall:(id)sender cursorClick:(int)action onShareInAt:(CGPoint)location
Parameters
sender

The RtccCall which property changed.

action

The type of action sent by the remote. 0 is cursor location, 1 is drawing (a.k.a. connects the dots) and 2 is drop (a predefined form is to be drawn at the coordinates).

location

The inbound cursor location. If -1x-1, the remote’s cursor is not over the share view.

Availability

5.3

Declared In

RtccCall.h

– rtccCall:shareReceiving:

Fired when the SDK starts or stops receiving share data.

- (void)rtccCall:(id)sender shareReceiving:(BOOL)isReceiving
Parameters
sender

The RtccCall which property changed.

isReceiving

Answers “Are we receiving share data?”.

Availability

5.1

Declared In

RtccCall.h

– rtccCall:shareSending:

Fired when the SDK starts or stops sending share data.

- (void)rtccCall:(id)sender shareSending:(BOOL)isSending
Parameters
sender

The RtccCall which property changed.

isSending

Answers “Are we sending share data?”.

Availability

5.1

Declared In

RtccCall.h

– rtccCall:videoInSizeChange:

Called when the incoming video profile changes.

Use this method to know when the video incoming size/profile changes.

- (void)rtccCall:(id)sender videoInSizeChange:(CGSize)size
Parameters
sender

The RtccCall which property changed.

size

The new profile used by the incoming video. Can be CGSizeZero.

Availability

5.1

Declared In

RtccCall.h

– rtccCall:videoInSizeChange:forContact:

Called when the incoming video profile changes.

Use this method to know when the video incoming size/profile changes.

- (void)rtccCall:(id)sender videoInSizeChange:(CGSize)profile forContact:(RtccContact *)contact
Parameters
sender

The RtccCall which property changed.

profile

The new profile used by the incoming video. Can be CGSizeZero.

contact

The contact whose video in changed.

Availability

5.1

Declared In

RtccCall.h

– rtccCall:shareInSizeChange:

Called when the incoming share frame size changes.

- (void)rtccCall:(id)sender shareInSizeChange:(CGSize)size
Parameters
sender

The RtccCall which property changed.

size

The new size of the share frame. Can be CGSizeZero.

Availability

5.1

Declared In

RtccCall.h

– rtccCall:videoOutSizeChange:

Called when the outgoing video size changes (that is, even if the device rotates).

- (void)rtccCall:(id)sender videoOutSizeChange:(CGSize)size
Parameters
sender

The RtccCall which property changed.

size

The new size of the monitoring video. Can be CGSizeZero.

Availability

5.1

Declared In

RtccCall.h

– rtccCall:videoSource:

Called when the video source changes.

- (void)rtccCall:(id)sender videoSource:(videoSource_t)source
Parameters
sender

The RtccCall which property changed.

source

The source now in use.

Availability

5.0

Declared In

RtccCall.h

– rtccCall:videoZoom:

Called when the zoom level changes

- (void)rtccCall:(id)sender videoZoom:(CGFloat)zoom
Parameters
sender

The RtccCall which property changed

zoom

The new zoom level

Availability

6.3

Declared In

RtccCall.h

– rtccCall:videoZoomThreshold:

The zoom threshold at which the captured image starts being upscaled

- (void)rtccCall:(id)sender videoZoomThreshold:(CGFloat)zoom
Parameters
sender

The related RtccCall

zoom

The zoom threshold

Availability

6.3

Discussion

The zoom threshold at which the captured image starts being upscaled

Declared In

RtccCall.h

– rtccCall:videoZoomMax:

The maximum zoom level available for the camera

- (void)rtccCall:(id)sender videoZoomMax:(CGFloat)zoom
Parameters
sender

The related RtccCall

zoom

The maximum zoom level @ since 6.3

Discussion

The maximum zoom level available for the camera

Declared In

RtccCall.h

– rtccCall:audioSending:

Called when the microphone is muted.

- (void)rtccCall:(id)sender audioSending:(BOOL)isSending
Parameters
sender

The RtccCall which property changed.

isSending

sending captured audio stream if true, sending empty packets otherwise.

Availability

5.0

Declared In

RtccCall.h

– rtccCall:audioRoute:

Called when the audio route changes.

- (void)rtccCall:(id)sender audioRoute:(audioRoute_t)route
Parameters
sender

The RtccCall which property changed.

route

The new route used.

Availability

5.0 - modified 5.5

Declared In

RtccCall.h

– rtccCall:callStatus:

Called when the status of the call changes.

- (void)rtccCall:(id)sender callStatus:(callStatus_t)status
Parameters
sender

The RtccCall which property changed.

status

The new status of the call (i.e. callStatus_ringing).

Availability

5.0

Declared In

RtccCall.h

– rtccCall:sipID:

The call unique SIP identifier as been received. This occurs after the call goes active. After this delegate method is fired, the [RtccCall getSipID] message can be fired anytime to retrieve this ID.

- (void)rtccCall:(id)sender sipID:(NSString *)sipID
Parameters
sender

The RtccCall which sipID was received.

sipID

The sipID.

Availability

5.2

Declared In

RtccCall.h

– rtccCall:receivedData:

You received raw data from the contact you are talking to.

- (void)rtccCall:(id)sender receivedData:(NSData *)data
Parameters
sender

The call related to the data.

data

The data received.

Availability

5.3

Declared In

RtccCall.h

– rtccConference:participantChange:

Fired when a participant’s status changes.

- (void)rtccConference:(id)sender participantChange:(RtccContact *)contact
Parameters
sender

the Call which participant changed.

contact

A reference to the contact that changed. The changes is one of the following:

* [RtccContact isMuted]
* [RtccContact isDeaf]
* [RtccContact isEmittingVideo]
* [RtccContact isHandUp]
* [RtccContact isAdmin]
* [RtccContact isOnHold]
* [RtccContact isTalking]
Availability

5.3

Declared In

RtccCall.h

– rtccParticipantListChangeForConference:

Fired when the list of contacts changes. The whole list (of RtccContact) is dropped and rebuilt.

- (void)rtccParticipantListChangeForConference:(id)sender
Parameters
sender

The Call which participant list changed.

Availability

5.3

Discussion

Fired when the list of contacts changes. The whole list (of RtccContact) is dropped and rebuilt.

Declared In

RtccCall.h

– rtccCallRecordStopped:

Indicates that recording for this call started.

- (void)rtccCallRecordStopped:(id)sender
Parameters
sender

The related RtccCall.

Availability

5.3

Discussion

Indicates that recording for this call started.

Declared In

RtccCall.h

– rtccCallRecordStarted:

Indicates that recording for this call ended.

- (void)rtccCallRecordStarted:(id)sender
Parameters
sender

The related RtccCall.

Availability

5.3

Discussion

Indicates that recording for this call ended.

Declared In

RtccCall.h

– rtccCallRecordPaused:

Called when the conference call record is paused

- (void)rtccCallRecordPaused:(id)sender
Parameters
sender

the related RtccCall

Discussion

Called when the conference call record is paused

Declared In

RtccCall.h

– rtccCallRecordResumed:

Called when the conference call record is resumed

- (void)rtccCallRecordResumed:(id)sender
Parameters
sender

the related RtccCall

Discussion

Called when the conference call record is resumed

Declared In

RtccCall.h