Class MeetingService

closedCaptioningService

connectionState

contentService

moderatorControlsService

moderatorWaitingRoomService

participantService

privateChatService

publicChatService

videoStreamService

audioMuted

• get 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

  Returns boolean

connectionMode

• get connectionMode(): ConnectionMode

• connectionMode provides the connectionMode currently set for the meeting

  Returns ConnectionMode

galleryLayoutConfiguration

• get galleryLayoutConfiguration(): GalleryLayoutConfiguration

• The galleryLayoutConfiguration provides information about the current video configuration for the gallery layout (3x3, 5x5).

  Returns GalleryLayoutConfiguration

isMultiStreamSupported

• get isMultiStreamSupported(): boolean

• isMultiStreamSupported returns a boolean value whether the browser supports multistream or not. Note: by “multistream” we mean the ability to send more than 1 video for a WebRTC connection. i.e Each participant's video comes in a different video stream

  Returns boolean

maxVideoSendResolution

• get maxVideoSendResolution(): MaxVideoQuality

• maxVideoSendResolution provides the maximum video resolution sent from the SDK endpoint. It can be either 360p or 720p.

  Returns MaxVideoQuality

meetingInformation

• get meetingInformation(): MeetingInformation

• meetingInformation, provides details about the meeting. Refer to MeetingInformation for documentation on meeting details provided from this flag.

  Returns MeetingInformation

recordingState

• get recordingState(): RecordingState

• recordingState provides current recordingState

  Returns RecordingState

selfVideoPreviewEnabled

• get selfVideoPreviewEnabled(): boolean

• selfVideoPreviewEnabled, boolean property provides the state of video preview This value will be true if the local preview video is turned on, false otherwise

  Returns boolean

videoLayout

• get videoLayout(): VideoLayout

• videoLayout, provides the current Video layout in the meeting. Refer to VideoLayout for documentation on all possible values for the video layout Returns null if the meeting is not active

  Returns VideoLayout

videoMuted

• get 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

  Returns boolean

videoState

• get videoState(): VideoState

• videoState, provides the current state of Video in the meeting. Refer to VideoState for documentation on all possible values for the video state

  Returns VideoState

attachLocalVideo

• attachLocalVideo(videoElement): void

• attachLocalVideo

  Parameters

  • videoElement: HTMLElement

    an HTML video element where you want to show local/preview video

  Returns void

attachRemoteContent

• attachRemoteContent(videoElement): void

• attachRemoteContent,

  Parameters

  • videoElement: HTMLElement

    an HTML video element where you want to show remote content

  Returns void

attachRemoteVideo

• attachRemoteVideo(remoteVideoContainer): void

• attachRemoteVideo,

  Parameters

  • remoteVideoContainer: HTMLDivElement

    an HTML div element where you want to show remote video

  Returns void

endMeeting

• endMeeting(): Promise<any>

• Ends the active bluejeans meeting.

  Returns Promise<any>

joinMeeting

• joinMeeting(meetingID, passcode, displayName, optionalJoinProps?): Promise<void>

• Connect to a Video/Audio meeting

  Parameters

  • meetingID: string

    The numberic ID of the meeting you plan on joining

  • passcode: string

    the passcode of the meeting (Could be empty if no passcode has been set for a meeting)

  • displayName: string

    The participant would join the meeting with this name

  • Optional optionalJoinProps: OptionalJoinProps

  Returns Promise<void>

  Promise which resolves when meeting join is successful and rejects with one of JoinError or PermissionError

  joinMeeting will ask users for audio/video permissions if not granted already

observe

• observe(property, callback): void

• Allows observing changes to properties. Provide the property which you are interested in and a callback. Whenever the property value changes, you will be notified via the callback.

  Usage:

  Example

  sdk.meetingService.observe("connectionState", function() {
       console.info("Connection state is changed to : ", sdk.meetingService.connectionState)
  });
  Copy

  Parameters

  • property: keyof MeetingService

    The name of the property to observe for changes.

  • callback: (() => void)

    on change event for the property.

    • • (): void

      • Returns void

  Returns void

setAudioMuted

• setAudioMuted(muted): void

• Local audio mute state can be controlled.

  Parameters

  • muted: 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

setGalleryLayoutConfiguration

• setGalleryLayoutConfiguration(galleryLayoutConfiguration): void

• The gallery layout configuration can be changed from 3x3 to 5x5 or from 5x5 to 3x3.

  Parameters

  • galleryLayoutConfiguration: GalleryLayoutConfiguration

  Returns void

setMaxVideoSendResolution

• setMaxVideoSendResolution(resolution): Promise<SetMaxVideoSendResolutionResponse>

• Set the send video resolution 720p/360p using this function. Supported on Safari and Chromium-based browsers on desktop, as well as on iOS and iPadOS Safari.

  Parameters

  • resolution: MaxVideoQuality

    You need to pass the resolution(720/360)

  Returns Promise<SetMaxVideoSendResolutionResponse>

setName

• setName(name): void

• Update the name of selfParticipant, after joining the meeting.

  Parameters

  • name: string

    the modified name of the participant.

  Returns void

setSelfVideoPreviewEnabled

• setSelfVideoPreviewEnabled(enable): void

• setSelfVideoPreviewEnabled, used to show the self View pre meeting

  Parameters

  • enable: boolean

    boolean Would start showing local preview video if enable is true and hide it if enable is false

  Returns void

setVideoLayout

• setVideoLayout(videoLayout): void

• Set local video layout.

  Parameters

  • videoLayout: VideoLayout

    NOTE: FILMSTRIP layout is a special case in which, the top 86% of video comes as black video and Up to the 5 most recent speakers are shown, arranged in a horizontal filmstrip in the bottom 14%. The most common use case for this is to overlay content video in the top 86%, so that you can show content and video simultaneously.

    Changing layouts is not allowed while receiving video upload and share. Custom layout is only supported on multistream capable endpoints. To check if the current endpoint is capable of multistream video, please call isMultiStreamSupported method.

  Returns void

setVideoMuted

• setVideoMuted(muted): void

• Set local video mute state.

  Parameters

  • muted: boolean

    of type boolen, set true to mute the video and false to unmute the video. If the passed argument and the current state are the same, that operation will be ignored.

  Returns void

switchConnectionMode

• switchConnectionMode(connectionMode): Promise<SwitchConnectionModeResponse>

• switchConnectionMode, used to change the connectionMode of the meeting based on the passed param, connectionMode. This should be called in-meeting to change connectionMode for a meeting.

  Self audio & video is always muted in ScreenShareOnly mode. Upon switching connectionMode from ScreenShareOnly to Default, self video will remain muted, however audio will get unmuted.

  Parameters

  • connectionMode: ConnectionMode

  Returns Promise<SwitchConnectionModeResponse>