Sceenic - WatchTogether
  • Watch Together and Synchronization SDKs
  • Watch together SDK
    • Watch Together SDK overview
    • Authentication overview
    • Tutorials
      • Android
        • Android - Java/Kotlin
      • iOS
        • iOS Swift/Objective-c adapter
      • Web
        • Authentication
        • Create a New Project
        • Adding WT SDK library to the project
        • Installing the NPM package
        • Sample application
          • The conference skeleton
          • Connecting to a Session
          • How to turn on and off video and audio
          • How to change video quality
          • Errors handling
          • Leave the call
        • Support
    • API references
      • Android reference
        • Session
        • SessionListener
        • SessionReconnectListener
        • SessionConnectionListener
        • Participant
          • ParticipantType
        • SessionError
      • iOS Swift reference
        • Session
        • SessionDelegate
        • Participant
        • ParticipantActiveSpeakerDelegate
        • ParticipantDelegate
        • LocalParticipant
        • WTError
        • DataTypes
      • iOS Objective-c adapter reference
        • SessionAdapter
        • SessionAdapterDelegate
        • ParticipantAdapter
        • LocalParticipantAdapter
        • ParticipantAdpaterDelegate
        • ParticipantAdapterActiveSpeakerDelegate
        • NSError
        • DataTypes
      • Web reference
        • WT Session
          • WTSession.connect(sToken, pName, uC, m)
          • WTSession.connectAsAViewer(sToken, pName)
          • WTSession.connectWithSharingScreen(sToken, pName)
          • WTSession.disconnect()
          • WTSession.enableStats()
          • WTSession.sendMessage(msg)
          • WTSession.sendPlayerData(time)
          • async WTSession.getSessionState()
        • SessionListeners
          • WTSessionListeners.onConnected(fn)
          • WTSessionListeners.onDisconnected(fn)
          • WTSessionListeners.onStreamCreated(fn)
          • WTSessionListeners.onLocalStreamCreated(fn)
          • WTSessionListeners.onMosReport(fn)
          • WTSessionListeners.offMosReport(fn)
          • WTSessionListeners.onMessageReceived(fn)
          • WTSessionListeners.onSyncData(fn)
          • WTSessionListeners.onIceDisconnected(fn)
        • Participant
          • setMediaQuality
        • ParticipantListeners
        • ErrorsListeners
        • ReconnectListeners
        • MediaDevices
      • Cluster authentication service reference (CAS)
  • Synchronization SDK
    • Synchronization SDK overview
    • Tutorials
      • Android
        • Android - Java/Kotlin
      • iOS
        • iOS - Swift/Objective-c
      • Web
        • Installing the NPM package
        • Web - TypeScript/React
        • v2.0 Migration Guide
    • API references
      • Android reference
        • SynchSDK
        • SynchListener
      • iOS reference
        • SynchSDK
        • SynchListener
      • Web reference
  • Celebrity SDK
    • Celebrity SDK overview
    • Tutorials
      • Web
        • Installing the NPM package
        • Web - TypeScript/React
    • API References
      • Web reference
  • Chat SDK
    • Chat SDK overview
    • Tutorials
      • Web
        • Installing the NPM package
        • Web - TypeScript/React
    • API Refences
      • Web reference
  • Public Chat SDK
    • Public Chat SDK overview
    • Tutorials
      • Web
        • Installing the NPM package
        • Web - TypeScript/React
    • API Refences
      • Web reference
  • Celebrity Watch Party
    • Web application
    • Android
    • iOS
    • Celebrity View & Fan View
Powered by GitBook
On this page

Was this helpful?

  1. Watch together SDK
  2. API references
  3. Web reference

ParticipantListeners

Public method Summary

Methods

Description

Parameters

onParticipantJoin(fn)

const fn = (partricipant) => { //do smth }

The Event handler will be invoked when new participant joined to the Session but haven't started streaming yet

onParticipantLeft(fn)

const fn = ({participantId}) => { //do smth }

The Event handler will be invoked when the participant leaves the Session

  • participantId - unique identification of the user

onParticipantSpeaking(fn)

const fn = ({participantId}) => { //do smth }

The Event handler will be invoked when the participant starts speaking

onParticipantStopSpeaking(fn)

const fn = ({participantId}) => { //do smth }

The Event handler will be invoked when the participant stops speaking

onOrganizerReceived(fn)

The Event handler will be invoked when the user receives the organizer previlegious.

  • Fn - custom callback function without any parameters

onParticipantMediaStreamChanged(fn) const fn = ({participantId, mediaState, mediaType}) => { //do smth }

The Event handler will be invoked when a participant mute/unmute himself(audio or video). Params object with keys:

  • participantId -participant id which was muted

  • mediaType - allowed values Audio/Video

  • mediaState - allowed values Enabled/Disabled

onParticipantRejected(fn) const fn = (participant, message) => { //do smth }

The Event handler will be invoked when the participant was kicked from the session

  • participant - Participant object (who initiated a kick action)

  • message - optional parameter to provide a reason of kick action

PrevioussetMediaQualityNextErrorsListeners

Last updated 3 years ago

Was this helpful?