Contents x
    Session Events for Mobile
    • 21 Nov 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Session Events for Mobile

    • Updated on 21 Nov 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Session events were added in version 3.0.9 of the Mobile SDKs.

    What are Session Events?

    For logging and analytics, it is useful to understand the timing of various events within a session. These events are emitted from the various components in the ScreenMeet platform and aggregated together in the Agent Portal session events view:
    image.png

    The ScreenMeet Live platform provides many built-in events and they consist of a timestamp, type, and message.

    Session Events from the Mobile SDK

    As the Mobile SDK is built on the ScreenMeet Live platform, it emits, by default, a subset of the events provided by the ScreenMeet Live platform. There are certain ScreenMeet Live web application-specific features for which the SDK does NOT emit automatically. For example, for a mobile app, the lobby experience is application-specific, not provided by the SDK, and thus does not emit this event.

    List of Events

    typemessage
    audio-mutedAudio stream muted
    audio-resumedAudio stream muted
    audio-stream-stoppedAudio stream stopped from + t.label
    camera-access-errorAn error has occurred while attempting to acquire the camera stream
    camera-access-requestedAttempting to acquire camera video stream
    camera-access-succeededCamera stream acquired successfully
    cobrowse-access-errorAn error has occurred while attempting to acquire the cobrowse stream
    cobrowse-access-requestedAttempting to acquire cobrowse video stream
    cobrowse-access-succeededCobrowse stream acquired successfully
    microphone-access-errorAn error has occurred while attempting to acquire the audio stream
    microphone-access-requestedAttempting to acquire microphone audio stream
    microphone-access-succeededMicrophone stream acquired successfully
    room-enteredEntered the meeting room.
    room-entry-requestedRequested permission to enter the room.
    video-stream-stoppedVideo stream stopped.

    Custom Events from the Mobile SDK

    In addition to to the built-in events, the SDKs allow for developers to send custom session events that will be available in the session logs.

    Android:

    ScreenMeet.logSessionEvent("custom_type", "custom_message")

    iOS:

    ScreenMeetDelegate.logSessionEvent(type: Swift.String, message: Swift.String)
    Was this article helpful?
    What's Next