Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BJNEmbedSDKInterface

Interface for the exposed properties and the functionalities from the BJNEmbedSDK.

The properties are implemented as an mobX observables.

Hierarchy

  • BJNEmbedSDKInterface

Implemented by

Properties

audioMuted

audioMuted: boolean

audioMuted, boolean property provides the local audio state. This value will be true, if the local audio flow is stopped and If the audio starts flowing this value will be false

canShareScreen

canShareScreen: boolean

canShareScreen, boolean property, provides if content share is allowed. This value will be true, if this endpoint can share content and will be false otherwise.

chatMessages

chatMessages: BJNEChatMessage[]

chatMessages, property provides the array of chatMessages in the meeting. Refer BJNEChatMessage, for the attributes structure of a each message.

connectionState

connectionState: BJNEConnectionState

connectionState BJNEConnectionState, property provides the meeting state. This returns the enum for all the states.

If the connectionState == "Connected" or connectionState == BJNEConnectionState.CONNECTED, It means the meeting is connected.

isSDKInitComplete

isSDKInitComplete: boolean

isSDKInitComplete, property states the readiness of the SDK. Once this flag became true, we are good to get the updates about the BlueJeans meeting properties.

participants

participants: BJNEParticipant[]

participants, property provides the array of participants in the meeting. Refer BJNEParticipant, for the attributes of a participant.

receivingScreenShare

receivingScreenShare: boolean

receivingScreenShare, boolean property provides the state of the content receive. This value will be true, if this endpoint is receiving the content and If there is no content received this value will be false

remoteAudioMuted

remoteAudioMuted: boolean

remoteAudioMuted, property provides the value of audio being locally muted from other participants in the meeting.

selfParticipant

selfParticipant: BJNEParticipant | null

selfParticipant, property provides the information of the self participant. Refer BJNEParticipant, for the attributes structure of a participant.

sharingScreen

sharingScreen: boolean

sharingScreen, boolean property provides the state of the content sent. This value will be true, if this endpoint is senting the content and If there is no content sent this value will be false

version

version: string

returns the verison of the BlueJeans Web Embed SDK

videoMuted

videoMuted: boolean

videoMuted, boolean property provides the local video state. This value will be true, if the local video flow is stopped and If the video starts flowing this value will be false

videoState

videoState: VideoState

videoState, property provides the value of if video is being received from other participants in the meeting.

Methods

leave

  • leave(): void
  • Leaves you from the meeting. After successfully leaving the meeting, the connectionState will be updated with Disconnected.

    Returns void

leaveAndEndForAll

  • leaveAndEndForAll(): void
  • Leaves you from the meeting as well ends that meeting session. So everyone in the meeting will be kicked out. After successfully leaving the meeting, the connectionState will be updated with Disconnected.

    Note : Supported only by the moderators.

    Returns void

setAudioMuted

  • setAudioMuted(mute: boolean): void
  • Local audio mute state can be controlled.

    Parameters

    • mute: boolean

      of type boolen, true for muting the audio and false for unmuting the audio. If the passed argument and the current state are the same, that operation will be ignored.

    Returns void

setName

  • setName(name: string): void
  • User can update the name, after joining the meeting.

    Parameters

    • name: string

      the modified name of the participant.

    Returns void

setRemoteAudioMuted

  • setRemoteAudioMuted(mute: boolean): void
  • User can mute/unmute audio from remote . This method provides you the ability to mute the incoming audio from other participants in your BlueJeans endpoint. This means, if you call setRemoteAudioMuted with true, the other participants will still be able to speak in the meeting, but you would not be able to hear their audio. pass @param mute to locally control the audio from remote endpoint.

    Parameters

    • mute: boolean

    Returns void

setVideoMuted

  • setVideoMuted(mute: boolean): void
  • Local video mute state can be controlled.

    Parameters

    • mute: boolean

      of type boolen, true for muting the video and false for unmuting the video. If the passed argument and the current state are the same, that operation will be ignored.

    Returns void

startScreenShare

  • startScreenShare(): void
  • To start sharing the screen from the meeting

    Technical limitation : Not supported for browsers in mobile devices

    Returns void

stopScreenShare

  • stopScreenShare(): void
  • To stop an active screen sharing in the meeting

    Returns void