Hierarchy

  • default
    • ClosedCaptioningService

Accessors

  • get closedCaptionText(): string
  • Provides the caption text when closed captioning is active in a meeting.

    Returns string

  • get isClosedCaptioningAvailable(): boolean
  • Returns if closed captioning can be used in a meeting.

    Returns boolean

  • get isClosedCaptioningOn(): boolean
  • Returns if closed captioning is active in a meeting which has closed captioning capability.

    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.closedCaptioningService.observe("closedCaptioningState", function() {
    console.info("closedCaptioningState changed to : ", sdk.meetingService.closedCaptioningService.closedCaptioningState)
    });

    Parameters

    • property: keyof ClosedCaptioningService

      The name of the property to observe for changes.

    • callback: (() => void)

      on change event for the property.

        • (): void
        • Returns void

    Returns void

  • Starts closed captioning if it is enabled in the meeting scheduling options and also the associated meeting feature is enabled. Caption texts can then be observed through the closedCaptionText property.

    Returns Promise<StartCCResponse>

  • Stops the ongoing closed captioning.

    Returns Promise<StopCCResponse>

Generated using TypeDoc