Skip to main content
Version: 2.0.x

Meeting Class Events - iOS

onMeetingJoined()​

  • This event will be emitted when a localParticipant successfully joined the meeting.

Example​

meeting.listeners.onMeetingJoined();

onMeetingLeft()​

Example​

meeting.listeners.onMeetingLeft();

onParticipantJoined()​

  • This event will be emitted when a new participant joined the meeting.

Event callback parameters​

Example​

meeting.listeners.onParticipantJoined(participant);

onParticipantLeft()​

  • This event will be emitted when a joined participant left the meeting.

Event callback parameters​

Example​

meeting.listeners.onParticipantLeft(participant);

onSpeakerChanged()​

  • This event will be emitted when a active speaker changed.
  • If you want to know which participant is actively speaking, then this event will be used.
  • If no participant is actively speaking, then this event will pass null as en event callback parameter.

Event callback parameters​

  • participantId: String?

Example​

meeting.listeners.onSpeackerChanged(participantId: participantId)

onMicRequested()​

  • This event will be emitted to the participant B when any other participant A requests to enable mic of participant B.
  • On accepting the request, mic of participant B will be enabled.

Event callback parameters​

  • participantId: String?
  • accept: Closure
  • reject: Closure

Example​

meeting.listeners.onMicRequested(participantId: participantId) {
    // request accepted
} reject: {
    // request rejected
}

onWebcamRequested()​

  • This event will be emitted to the participant B when any other participant A requests to enable webcam of participant B.
  • On accepting the request, webcam of participant B will be enabled.

Event callback parameters​

  • participantId: String?
  • accept: Closure
  • reject: Closure

Example​

meeting.listeners.onWebcamRequested(participantId: participantId) {
    // request accepted
} reject: {
    // request rejected
}

onRecordingStateChanged()​

  • This event will be emitted when the meeting's recording status changed.

Example​

meeting.listeners.onRecordingStateChanged(state: RecordingState) {
    switch(state) {
        case .RECORDING_STARTING:
            print("recording starting")

        case .RECORDING_STARTED:
            print("recording started")

        case .RECORDING_STOPPING:
            print("recording stoping")

        case .RECORDING_STOPPED:
            print("recording stopped")
    }
}

onRecordingStarted()​

  • This event will be emitted when recording of the meeting is started.

Example​

meeting.listeners.onRecordingStarted();

onRecordingStopped()​

  • This event will be emitted when recording of the meeting is stopped.

Example​

meeting.listeners.onRecordingStopped();

onLivestreamStateChanged()​

  • This event will be emitted when the meeting's livestream status changed.

Example​

meeting.listeners.onLivestreamStateChanged(state: LiveStreamState) {
    switch(state) {
        case .LIVESTREAM_STARTING:
            print("livestream starting")

        case .LIVESTREAM_STARTED:
            print("livestream started")

        case .LIVESTREAM_STOPPING:
            print("livestream stoping")

        case .LIVESTREAM_STOPPED:
            print("livestream stopped")
    }
}

onLivestreamStarted()​

  • This event will be emitted when RTMP live stream of the meeting is started.

Example​

meeting.listeners.onLivestreamStarted();

onLivestreamStopped()​

  • This event will be emitted when RTMP live stream of the meeting is stopped.

Example​

meeting.listeners.onLivestreamStopped();

onHlsStateChanged()​

  • This event will be emitted when the meeting's HLS(Http Livestreaming) status changed.

Example​

meeting.listeners.onHlsStateChanged(state: HLSState, hlsUrl: HLSUrl?) {
    switch(state) {
        case .HLS_STARTING:
            print("HLS Starting")

        case .HLS_STARTED:
            self.hlsStreamStarted = true
            print("HLS Started")

        case .HLS_PLAYABLE:
            print("HLS Playable")

        case .HLS_STOPPING:
            print("HLS Stopping")

        case .HLS_STOPPED:
            self.hlsStreamStarted = false
            print("HLS Stopped")
    }
}

onTranscriptionStateChanged()​

  • This event will be emitted when the meeting's transcription status is changed.
  • All available TranscriptionStates are TRANSCRIPTION_STARTING, TRANSCRIPTION_STARTED, TRANSCRIPTION_STOPPING, TRANSCRIPTION_STOPPED.

Example​

meeting.listeners.onTranscriptionStateChanged(state: TranscriptionState) {
    switch(state) {
        case .TRANSCRIPTION_STARTING:
            print("transcription starting")

        case .TRANSCRIPTION_STARTED:
            print("transcription started")

        case .TRANSCRIPTION_STOPPING:
            print("transcription stopping")

        case .TRANSCRIPTION_STOPPED:
            print("transcription stopped")
    }
}

onTranscriptionText()​

  • This event will be emitted when the transcription is received by the SDK.

Event callback parameters​

  • data: { _ data: TranscriptionText }
    • TranscriptionText.participantId: String
    • TranscriptionText.participantName: String
    • TranscriptionText.text: String
    • TranscriptionText.timestamp: Int
    • TranscriptionText.type: String

Example​

meeting.listeners.onTranscriptionText(_ data: TranscriptionText) {
        print("transcription text: ", data.text)
        print("participant name", data.participantName)
    }

onMeetingStateChanged()​

  • This event will be triggered when state of meeting changes.
  • It will pass state as an event callback parameter which will indicate current state of the meeting.
  • All available states are CONNECTING, CONNECTED, CLOSING, CLOSED and CANCELLED.

Event callback parameters​

  • data: { meetingState: MeetingState }
    • meetingState: MeetingState

Example​

meeting.listeners.onMeetingStateChanged(meetingState: MeetingState) {
    switch meetingState {
        case .CONNECTING:
            print("Meeting is connecting")

        case .CONNECTED:
            print("Meeting is connected")

        case .CLOSING:
            print("Meeting is closing")

        case .CLOSED:
            print("Meeting connection closed")

        case .CANCELLED:
            print("Meeting is cancelled")
    }
}

onError()​

  • This event will be triggered when any error occured.
  • It will pass error as an event parameter.
  • To see all available error codes from SDK. Meeting Error Codes

Example​

meeting.listeners.onError(error: VideoSDKError) {
    switch error {
        case .INVALID_TOKEN: print("Invalid Token")

        case .INVALID_MEETING_ID: print("Invalid Meeting Id")

        case .INVALID_API_KEY: print("Invalid API Key")

        case .INVALID_PERMISSIONS: print("Invalid Permissions")

        ...
    }
}

onPinStateChanged()​

  • This event will be triggered when participant pin state changes.
  • It will pass participantId, pinType as an event parameter.
  • All available pin states are SHARE_AND_CAM, CAM and SHARE.

Event parameters​

  • data: { participantId: String, pinType: PinType }
    • participantId: String
    • pinType: PinType

Example​

meeting.listeners.onPinStateChanged(participantId: String, pinType: PinType) {
    ...
}

onParticipantModeChanged()​

  • This event will be triggered when participant mode changes.
  • It will pass participantId, mode as an event parameter.
  • All available participant modes are SEND_AND_RECV, SIGNALLING_ONLY and RECV_ONLY.
info

Important Changes IOS SDK in Version v2.2.0

  • The following modes have been deprecated:
    • CONFERENCE has been replaced by SEND_AND_RECV
    • VIEWER has been replaced by SIGNALLING_ONLY

Please update your implementation to use the new modes.

⚠️ Compatibility Notice:
To ensure a seamless meeting experience, all participants must use the same SDK version.
Do not mix version v2.2.0 + with older versions, as it may cause significant conflicts.

Event parameters​

  • data: { participantId: String, mode: Mode }
    • participantId: String
    • mode: Mode

Example​

meeting.listeners.onParticipantModeChanged(participantId: String, mode: Mode) {
    ...
}

onMicChanged()​

  • This event will be emitted when a localParticipant change their audio output device using changeMic method.

Example​

meeting.listeners.onMicChanged();

onWhiteboardStarted()​

  • This event will be triggered when whiteboard is successfully started and it will return the url.

Event callback parameters​

  • url: URL

Example​

meeting.listeners.onWhiteboardStarted(url: URL) {
    ...
}

onWhiteboardStopped()​

  • This event will be triggered when whiteboard session is stopped.

Example​

meeting.listeners.onWhiteboardStopped();

onPausedAllStreams()​

  • This callback is triggered when all or specified media streams within the meeting are successfully paused

Event callback parameters​

  • kind: Specifies the type of media stream that was paused.
    • Type: String
    • Possible values:
      • "audio": Indicates that audio streams have been paused.
      • "video": Indicates that video streams have been paused.
      • "share": Indicates that screen-sharing video streams have been paused
      • all : Indicates that all stream have been paused.

Example​

meeting.listeners.onPausedAllStreams(kind: String)

onResumedAllStreams()​

  • This callback is triggered when all or specified media streams within the meeting are successfully resumed

Event callback parameters​

  • kind: Specifies the type of media stream that was resumed.
    • Type: String
    • Possible values:
      • "audio": Indicates that audio streams have been resumed.
      • "video": Indicates that video streams have been resumed.
      • "share": Indicates that screen-sharing video streams have been resumed
      • all : Indicates that all stream have been resumed.

Example​

meeting.listeners.onResumedAllStreams(kind: String);

mediaRelayReceived()​

  • This callback is triggered when a request is recieved for media relay in the destination meeting.

Parameters​

  • participantId - (String): Specifies the participantId who requested the media relay.

  • meetingId - (String): Specifies the meeting from where the media relay request was made.

  • displayName - (String): Specifies the displayName of the participant who requested the media relay.

  • accept - (Function): Specifies the function to accept the media relay request.

  • reject - (Function): Specifies the function to reject the media relay request..

Example​

    meeting.listeners.onMediaRelayRequestReceived(participantId: String, meetingId: String, displayName: String, accept: @escaping () -> Void, reject: @escaping () -> Void)

mediaRelayResponse()​

  • This callback is triggered when a response is recieved for media relay request in the source meeting.

Parameters​

  • decidedBy - (String): Specifies the participantId who responded the request for the media relay.

  • decision - (String): Specifies the decision whether the request for media relay was accepted or not.

Example​

 meeting.listeners.onMediaRelayRequestResponse(decision: String, decidedBy: String, meetingId: String)

mediaRelayStarted()​

  • This callback is triggered when the media relay to the destination meeting succesfully starts.

Parameters​

  • meetingId - (String): Specifies the meeting where the media relay started.

Example​

   meeting.listeners.onMediaRelayStarted(meetingId: String)

mediaRelayStopped()​

  • This callback is triggered when the media relay to the destination meeting stops for any reason.

Parameters​

  • meetingId - (String): Specifies the meeting where the media relay stopped.

  • reason - (String): Specifies the reason why the media relay stopped

Example​

   meeting.listeners.onMediaRelayStopped(meetingId: String)

mediaRelayError()​

  • This callback is triggered when an error occurs during media relay to the destination meeting.

Parameters​

  • meetingId - (String): Specifies the meeting where the media relay stopped.

  • reason - (String): Specifies the reason why the media relay stopped

Example​

 meeting.listeners.onMediaRealyError(meetingId: String, error: String)

Got a Question? Ask us on discord

Last updated on by Deep Bhupatkar
Previous
PubSub
Next

Was this helpful?