Function useScreencast

Returns {
    isScreencastOn: boolean;
    setScreencastTrackBandwidth: ((bandwidth) => Promise<void>);
    setScreencastTrackEncodingBandwidth: ((encoding, bandwidth) => Promise<void>);
    simulcastConfig: SimulcastConfig;
    toggleScreencast: (<ScreencastOptionsMetadataType>(screencastOptions?) => Promise<void>);
    toggleScreencastTrackEncoding: ((encoding) => Promise<void>);
    updateScreencastTrackMetadata: (<ScreencastMetadataType>(metadata) => Promise<void>);
}

An object with functions to manage screencast.

• isScreencastOn: boolean

• setScreencastTrackBandwidth: ((bandwidth) => Promise<void>)

  • • (bandwidth): Promise<void>

    • Parameters

      • bandwidth: BandwidthLimit

      Returns Promise<void>

• setScreencastTrackEncodingBandwidth: ((encoding, bandwidth) => Promise<void>)

  • • (encoding, bandwidth): Promise<void>

    • Parameters

      • encoding: TrackEncoding

      • bandwidth: BandwidthLimit

      Returns Promise<void>

• simulcastConfig: SimulcastConfig

• toggleScreencast: (<ScreencastOptionsMetadataType>(screencastOptions?) => Promise<void>)

  • • <ScreencastOptionsMetadataType>(screencastOptions?): Promise<void>

    • Type Parameters

      • ScreencastOptionsMetadataType extends Metadata

      Parameters

      • Optional screencastOptions: Partial<ScreencastOptions<ScreencastOptionsMetadataType>>

      Returns Promise<void>

• toggleScreencastTrackEncoding: ((encoding) => Promise<void>)

  • • (encoding): Promise<void>

    • Parameters

      • encoding: TrackEncoding

      Returns Promise<void>

• updateScreencastTrackMetadata: (<ScreencastMetadataType>(metadata) => Promise<void>)

  • • <ScreencastMetadataType>(metadata): Promise<void>

    • Type Parameters

      • ScreencastMetadataType extends Metadata

      Parameters

      • metadata: ScreencastMetadataType

      Returns Promise<void>