IrisRtcJingleSessionDelegate Protocol Reference

Conforms to NSObject
Declared in IrisRtcJingleSession.h

Overview

The IrisRtcJingleSessionDelegate protocol defines the optional methods implemented by delegates of the IrisRtcJingleSession class.

– onSessionCreated:traceId: required method

Callback:This method is called when the room is created successfully.

- (void)onSessionCreated:(NSString *)roomId traceId:(NSString *)traceId

Parameters

roomId

room id.
traceId

trace id.

Discussion

Callback:This method is called when the room is created successfully.

Declared In

IrisRtcJingleSession.h

– onSessionJoined:traceId: required method

Callback: This is called when the room is joined successfully from reciever.

- (void)onSessionJoined:(NSString *)roomId traceId:(NSString *)traceId

Parameters

roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when the room is joined successfully from reciever.

Declared In

IrisRtcJingleSession.h

– onSessionParticipantJoined:roomId:traceId: required method

Callback: This is called at the sender side when the remote participant joins the room.

- (void)onSessionParticipantJoined:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called at the sender side when the remote participant joins the room.

Declared In

IrisRtcJingleSession.h

– onSessionConnected:traceId: required method

Callback: This is called when the Ice connection state that is,session is connected.

- (void)onSessionConnected:(NSString *)roomId traceId:(NSString *)traceId

Parameters

roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when the Ice connection state that is,session is connected.

Declared In

IrisRtcJingleSession.h

– onSessionEnded:traceId: required method

Callback: This is called when the session ends.

- (void)onSessionEnded:(NSString *)roomId traceId:(NSString *)traceId

Parameters

roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when the session ends.

Declared In

IrisRtcJingleSession.h

– onSessionParticipantLeft:roomId:traceId: required method

Callback: This is called when the participant leaves the room.

- (void)onSessionParticipantLeft:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when the participant leaves the room.

Declared In

IrisRtcJingleSession.h

– onSessionParticipantProfile:userProfile:roomId:traceId: required method

Callback: This is called when the participant profile is changed.

- (void)onSessionParticipantProfile:(NSString *)participantId userProfile:(IrisRtcUserProfile *)userprofile roomId:(NSString *)roomid traceId:(NSString *)traceId

Parameters

participantId

paritcipant id.
userprofile

IriRtcuserProfile object containing participant’s name and image url .
traceId

trace id.
roomId

room id.

Discussion

Callback: This is called when the participant profile is changed.

Declared In

IrisRtcJingleSession.h

– onSessionDominantSpeakerChanged:roomId:traceId: required method

Callback: This is called when dominant speaker is changed in multiple stream.

- (void)onSessionDominantSpeakerChanged:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when dominant speaker is changed in multiple stream.

Declared In

IrisRtcJingleSession.h

– onSessionRemoteParticipantActivated:roomId:traceId:

Callback: This is called when stream of particular particiapnt is activated/viewed in multiple stream.

- (void)onSessionRemoteParticipantActivated:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when stream of particular particiapnt is activated/viewed in multiple stream.

Declared In

IrisRtcJingleSession.h

– onSessionParticipantNotResponding:roomId:traceId:

Callback: This is called when remote participant is not responding.

- (void)onSessionParticipantNotResponding:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when remote participant is not responding.

Declared In

IrisRtcJingleSession.h

– onSessionTypeChanged:participantId:roomId:traceId:

Callback: This is called when there is change in sessiontype.

- (void)onSessionTypeChanged:(NSString *)sessionType participantId:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

sessionType

session type.
participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when there is change in sessiontype.

Declared In

IrisRtcJingleSession.h

– onSessionParticipantAudioMuted:participantId:roomId:traceId:

Callback: This is called when audio of remote participant muted or unmuted.

- (void)onSessionParticipantAudioMuted:(BOOL)mute participantId:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

mute

audio state mute or unmute.
participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when audio of remote participant muted or unmuted.

Declared In

IrisRtcJingleSession.h

– onSessionParticipantVideoMuted:participantId:roomId:traceId:

Callback: This is called when video of remote participant muted or unmuted.

- (void)onSessionParticipantVideoMuted:(BOOL)mute participantId:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

mute

video state mute or unmute.
participantId

paritcipant id.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when video of remote participant muted or unmuted.

Declared In

IrisRtcJingleSession.h

– onSessionError:withAdditionalInfo:roomId:traceId:

Callback: This is called when there is error while the session is active.

- (void)onSessionError:(NSError *)error withAdditionalInfo:(NSDictionary *)info roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

error

The basic error code details.
info

Additional error details including description.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when there is error while the session is active.

Declared In

IrisRtcJingleSession.h

– onLogAnalytics:roomId:traceId:

Callback: This is called when there is any message is to be convey to the app.

- (void)onLogAnalytics:(NSString *)log roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

log

message to the app.
roomId

room id.
traceId

trace id.

Discussion

Callback: This is called when there is any message is to be convey to the app.

Declared In

IrisRtcJingleSession.h