Interface ContentShareController

interface ContentShareController {
    addContentShareObserver(observer: ContentShareObserver): void;
    enableSimulcastForContentShare(
        enable: boolean,
        encodingParams?: ContentShareSimulcastEncodingParameters,
    ): void;
    enableSVCForContentShare(enable: boolean): void;
    forEachContentShareObserver(
        observerFunc: (observer: ContentShareObserver) => void,
    ): void;
    pauseContentShare(): void;
    removeContentShareObserver(observer: ContentShareObserver): void;
    setContentAudioProfile(audioProfile: AudioProfile): void;
    setContentShareVideoCodecPreferences(
        preferences: VideoCodecCapability[],
    ): void;
    startContentShare(stream: MediaStream): Promise<void>;
    startContentShareFromScreenCapture(
        sourceId?: string,
        frameRate?: number,
    ): Promise<MediaStream>;
    stopContentShare(): void;
    unpauseContentShare(): void;
}

Hierarchy (View Summary)

ContentShareControllerFacade
- ContentShareController

Implemented by

DefaultContentShareController

Index

Methods

addContentShareObserver enableSimulcastForContentShare enableSVCForContentShare forEachContentShareObserver pauseContentShare removeContentShareObserver setContentAudioProfile setContentShareVideoCodecPreferences? startContentShare startContentShareFromScreenCapture stopContentShare unpauseContentShare

Methods

addContentShareObserver

addContentShareObserver(observer: ContentShareObserver): void
Add an observer
Parameters
- observer: ContentShareObserver
Returns void
Inherited from ContentShareControllerFacade.addContentShareObserver
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:72

enableSimulcastForContentShare

enableSimulcastForContentShare(
enable: boolean,
encodingParams?: ContentShareSimulcastEncodingParameters,
): void
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
- OptionalencodingParams: ContentShareSimulcastEncodingParameters
  Overide the default encoding params for either layer in max bitrate, scale resolution down by, or max frame rate.
Returns void
Inherited from ContentShareControllerFacade.enableSimulcastForContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:26

enableSVCForContentShare

enableSVCForContentShare(enable: boolean): void
Toggle SVC for content share. This should be called before calling startContentShare or startContentShareFromScreenCapture. This will only have impact if using an SVC supporting codec like VP9. It cannot be enabled at the same time as simulcast.
Parameters
- enable: boolean
  Enable/disable SVC
Returns void
Inherited from ContentShareControllerFacade.enableSVCForContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:38

forEachContentShareObserver

forEachContentShareObserver(
observerFunc: (observer: ContentShareObserver) => void,
): void
Iterates through each observer, so that their notification functions may be called.
Parameters
- observerFunc: (observer: ContentShareObserver) => void
Returns void
- Defined in src/contentsharecontroller/ContentShareController.ts:12

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
Inherited from ContentShareControllerFacade.pauseContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:57

removeContentShareObserver

removeContentShareObserver(observer: ContentShareObserver): void
Remove an observer
Parameters
- observer: ContentShareObserver
Returns void
Inherited from ContentShareControllerFacade.removeContentShareObserver
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:77

setContentAudioProfile

setContentAudioProfile(audioProfile: AudioProfile): void
Sets the audio profile to use for content sharing. The new audio profile takes effect on the next call to startContentShare or startContentShareFromScreenCapture or if already started, upon the next reconnect.
Parameters
- audioProfile: AudioProfile
Returns void
Inherited from ContentShareControllerFacade.setContentAudioProfile
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:15

`Optional`setContentShareVideoCodecPreferences

setContentShareVideoCodecPreferences(preferences: VideoCodecCapability[]): void
Set codec preferences for this content send stream. See AudioVideoControllerFacade.setVideoCodecSendPreferences for more information.
Parameters
- preferences: VideoCodecCapability[]
  Array of [[VideoCodecCapability]].
Returns void
Inherited from ContentShareControllerFacade.setContentShareVideoCodecPreferences
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:85

startContentShare

startContentShare(stream: MediaStream): Promise<void>
Start content sharing
Parameters
- stream: MediaStream
Returns Promise<void>
Inherited from ContentShareControllerFacade.startContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:43

startContentShareFromScreenCapture

startContentShareFromScreenCapture(
sourceId?: string,
frameRate?: number,
): Promise<MediaStream>
Start screen sharing
Parameters
- OptionalsourceId: string
- OptionalframeRate: number
Returns Promise<MediaStream>
Inherited from ContentShareControllerFacade.startContentShareFromScreenCapture
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:48

stopContentShare

stopContentShare(): void
Stop content sharing

Returns void
Inherited from ContentShareControllerFacade.stopContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:67

unpauseContentShare

unpauseContentShare(): void
Unpause content sharing

Returns void
Inherited from ContentShareControllerFacade.unpauseContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:62

Interface ContentShareController

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

addContentShareObserver

Parameters

Returns void

enableSimulcastForContentShare

Parameters

Returns void

enableSVCForContentShare

Parameters

Returns void

forEachContentShareObserver

Parameters

Returns void

pauseContentShare

Returns void

removeContentShareObserver

Parameters

Returns void

setContentAudioProfile

Parameters

Returns void

OptionalsetContentShareVideoCodecPreferences

Parameters

Returns void

startContentShare

Parameters

Returns Promise<void>

startContentShareFromScreenCapture

Parameters

Returns Promise<MediaStream>

stopContentShare

Returns void

unpauseContentShare

Returns void

Settings

On This Page

`Optional`setContentShareVideoCodecPreferences