SessionDelegate

Public Method Summary

Type

Methods

Parameters

void

SessionConnected:(NSString *)sessionId participants:(NSArray<NSString*>*)existPublisher;

A session is connected.

  • sessionId - a unique identifier of a session

  • existPublisher - an array of identifiers of users currently available in a session

void

SessionDidFinish;

A session finished.

void

SessionOnLocalParticipantJoined:(Participant *)participant

A local participant joined to a session.

  • participant - an object representing a participant

void

SessionParticipantJoined:(Participant *)participant;

A remote participant joined to a session.

  • participant - an object representing a participant

SessionParticipantLeft:(Participant *)participant;

A participant left a session.

  • participant - an object representing a participant

void

SessionDidFailWithError:(NSError *)error;

A session failed.

  • error - an error produced

void

SessionDidGetStreamTime:(NSString*)time withUserNumber:(NSInteger)userNumber;

An event for a video player time synchronization.

  • time - time in milliseconds for synchronization of video player

  • userNumber - a value indicating an amount of users in a session

void

SessionBecomesAnOrganizer:(BOOL)isOrganizer;

An event sent when a session organizer (synchronizer) has been changed.

  • isOrganizer - a value indicating whether a participant started or stopped to be an organizer

void

SessionOnManageParticipantMedia:(NSString*)participantID mediaType:(MediaType)mediaType mediaState:(MediaState)mediaState;

A media state of audio or video has been changed.

  • participantID - an identifier of the message sender

  • mediaType - a value indicating a media type (audio, video, all)

  • mediaState - a value indicating a media state (enabled, disabled)

void

rtcStats:(NSDictionary*)stats fromParticipant:(Participant*)participant;

Stats are produced for a participant.

  • stats - stats parsed into a dictionary collection type

  • participant - an object representing a participant for which stats are produced

void

(void)participant:(Participant*)participant streamQualityChanged:(WTStreamQuality)quality mosAudio:(float)mosAudio mosVideo:(float)mosVideo;

A stream quality (MOS - mean opinion score) has been changed for a participant.

  • participant - an object representing each individual participant

  • quality - a constant indicating a stream quality (good, bad, excellent)

  • mosAudio - a mean opinion score for audio

  • mosVideo - a mean opinion score for video

void

SessionNeedToReconnect;

This event is invoked in the following cases:

  • The device'sNetwork has been disconnected and reconnected

  • Stream quality is bad

When this call is invoked it is recommended that the session will be disconnected and connected again when the "SessionDidFinish" event comes in

void

sessionDidSubscribeToParticipant:(Participant *)participant;

The current user successfully subscribed for a participant media. Note: This call will be invoked as well when the current participant transitions from WTBroadcaster to WTViewer or WTFullParticipant

  • participant - an object representing a participant

void

sessionDidUnsubscribeFromParticipant:(Participant *)participant;

A current user has been unsubscribed from a participant media. Note: This call will be invoked as well when the current participant becomes a WTBroadcaster

  • participant - an object representing a participant

Last updated