Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContentShareControllerFacade

Hierarchy

Index

Methods

addContentShareObserver

enableSimulcastForContentShare

  • Toggle simulcast for content share. This should be called before calling startContentShare or startContentShareFromScreenCapture. The default encoding parameters are:

    • High layer: 1200 kbps max bitrate
    • Low layer: 300 kbps max bitrate, scale down resolution by 2, and 5 fps max frame rate.

    Parameters

    • enable: boolean

      Enable/disable simulcast

    • Optional encodingParams: ContentShareSimulcastEncodingParameters

      Overide the default encoding params for either layer in max bitrate, scale resolution down by, or max frame rate.

    Returns void

pauseContentShare

  • pauseContentShare(): void
  • Pause content sharing. This (combined with unpauseContentShare is a lightweight alternative to stopping and starting content share which requires use of a seperate peer connection and therefore has increased latency.

    Remote receivers will continue to subscribe to content share video but there will be nothing transmitting (e.g. it may be a black frame)

    Returns void

removeContentShareObserver

setContentAudioProfile

Optional setContentShareVideoCodecPreferences

startContentShare

  • startContentShare(stream: MediaStream): Promise<void>

startContentShareFromScreenCapture

  • startContentShareFromScreenCapture(sourceId?: string, frameRate?: number): Promise<MediaStream>

stopContentShare

  • stopContentShare(): void

unpauseContentShare

  • unpauseContentShare(): void

Generated using TypeDoc