IrisRtcSessionDelegate Protocol Reference

Conforms to IrisRtcJingleSessionDelegate
Declared in IrisRtcSession.h

Overview

The IrisRtcSessionDelegate protocol defines the optional methods implemented by delegates of the IrisRtcSession class.

The delegates should be used to monitor the events like when a remote stream is added or removed. Delegate onAddRemoteStream:mediaTrack: will be called when we got remote stream and onRemoveRemoteStream:mediaTrack: will be called when remote stream is removed.

– onAddRemoteStream:participantId:roomId:traceId: required method

This method is called when the remote stream is added to peerconnection.

- (void)onAddRemoteStream:(IrisRtcMediaTrack *)track participantId:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

track

pointer to the IrisRtcMediaTrack containing remote track.
participantId

Participant Id.
roomId

Room Id.
traceId

trace Id.

Discussion

This method is called when the remote stream is added to peerconnection.

Declared In

IrisRtcSession.h

– onRemoveRemoteStream:participantId:roomId:traceId: required method

This method is called when the remote stream is removed from the peerconnection.

- (void)onRemoveRemoteStream:(IrisRtcMediaTrack *)track participantId:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

track

pointer to the IrisRtcMediaTrack containing remote track.
participantId

Participant Id.
roomId

Room Id.
traceId

trace Id.

Discussion

This method is called when the remote stream is removed from the peerconnection.

Declared In

IrisRtcSession.h

– onSessionParticipantMessage:participantId:roomId:traceId: required method

This method is called when the remote stream is added to peerconnection.

- (void)onSessionParticipantMessage:(IrisChatMessage *)message participantId:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

message

Chat message string
participantId

Participant Id sending the chat message
roomId

Room Identifier for the allocated chat room for the participants
traceId

trace Id.

Discussion

This method is called when the remote stream is added to peerconnection.

Declared In

IrisRtcSession.h

– onChatMessageSuccess:roomId:traceId: required method

This method is called as an acknowledggment of chat message sent to participant.

- (void)onChatMessageSuccess:(IrisChatMessage *)message roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

message

ChatAck message string
roomId

Room Identifier for the allocated chat room for the participants
traceId

trace Id.

Discussion

This method is called as an acknowledggment of chat message sent to participant.

Declared In

IrisRtcSession.h

– onChatMessageError:withAdditionalInfo:roomId:traceId: required method

This method is called as when chat message is not sent to participant.

- (void)onChatMessageError:(NSString *)messageId withAdditionalInfo:(NSDictionary *)info roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

messageId

messageid of chat message
info

additional info about error.
roomId

Room Identifier for the allocated chat room for the participants
traceId

trace Id.

Discussion

This method is called as when chat message is not sent to participant.

Declared In

IrisRtcSession.h

– onChatMessageState:participantId:roomId:traceId: required method

This method is used for seding chat message state .

- (void)onChatMessageState:(IrisChatState)state participantId:(NSString *)participantId roomId:(NSString *)roomId traceId:(NSString *)traceId

Parameters

state

chat state
participantId

Participant Id sending the chat message
roomId

Room Identifier for the allocated chat room for the participants
traceId

trace Id.

Discussion

This method is used for seding chat message state .

Declared In

IrisRtcSession.h