Hierarchy

  • default
    • ContentShareService

Accessors

  • get contentShareState(): ContentShareState
  • contentShareState, state of whether you are sharing content in a meeting. This value will be "started", if this endpoint is sending content, "stopped" if you are not and "cancelled" when we requested screen share but the user cancelled it from the native content share dialog. To get "cancelled" state, we need to observe the change in value of contentShareState, as this immediately changes to "stopped".

    Returns ContentShareState

  • get isContentShareSupported(): boolean
  • isContentShareSupported, boolean property which returns true when the current endpoint can share their screen. Returns false when either

    1. your browser/OS does not support screen share (For eg: Safari on Desktop below 15.0 or any Mobile browser) OR
    2. if the moderator in the meeting has disabled screen share for others (and you are not a moderator)

    Returns boolean

  • get receivingContentShare(): boolean
  • receivingContentShare, 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 being received, this value will be false

    Returns boolean

Methods

  • 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.contentService.observe("contentShareState", function() {
    console.info("Connection state is changed to : ", sdk.meetingService.contentService.contentShareState)
    });

    Parameters

    • property: keyof ContentShareService

      The name of the property to observe for changes.

    • callback: (() => void)

      on change event for the property.

        • (): void
        • Returns void

    Returns void

  • To start sharing the content from the meeting Technical limitation : Not Supported for safari or Mobile browsers. Please call isContentShareSupported to check if screen share is possible before calling this function

    Returns void

  • To stop an active content sharing in the meeting

    Returns void

Generated using TypeDoc