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
  • Public fields
  • Public method Summar

Was this helpful?

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

Participant

Public fields

Name

Description

participantId

  • Unique identifier of a participant

participantName

  • Name of participant

isLocal

  • Identifies whether the participant is a local one

stream

streamConstraints

  • An object with two fields: {audio: boolean, video: boolean}

  • Example: {audio: false, video: true}. - that means a stream of participant consists only of video tracks

settings

  • An object with two fields: {mutedAudio: boolean, mutedVideo: boolean} - Those fields contain the state of the Audio and Video of the participant

Public method Summar

Name

Description

Parameters

enableAudio()

disableAudio()

enableVideo()

disableVideo()

isAudioEnabled()

  • Return boolean state of the local audio

isVideoEnabled()

  • Return boolean state of the local video

startScreenSharing(callback: Function)

  • The callback function will be invoked when screen sharing is started

stopScreenSharing(callback: Function)

  • The callback function will be invoked when screen sharing is stopped

toggleRemoteAudio(participantId: String)

  • Toggle remote participantId audio

toggleRemoteVideo(participantId: String)

  • Toggle remote participantId video

isRemoteAudioEnabled(participantId: String)

isRemoteVideoEnabled(participantId: String)

  • Apply constraints to video resolution and frame rate

publishRemoteParticipant(participantId)

  • Allow the remote participant to publish into the session

disconnectRemoteParticipant(participantId, message)

  • Disconnect the remote participant from the session

  • participantId - id of participant who will be disconnected from a session

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

PreviousWTSessionListeners.onIceDisconnected(fn)NextsetMediaQuality

Last updated 3 years ago

Was this helpful?

Participant Media Stream - Read for more information

({videoHeight: Number, videoWidth: Number, frameRate: Number})

here
setMediaQuality