Type alias UseSetupMediaConfig<TrackMetadata>

UseSetupMediaConfig<TrackMetadata>: {
    camera: {
        broadcastOnConnect?: boolean;
        broadcastOnDeviceStart?: boolean;
        defaultMaxBandwidth?: TrackBandwidthLimit;
        defaultSimulcastConfig?: SimulcastConfig;
        defaultTrackMetadata?: TrackMetadata;
        onDeviceChange?: "replace" | "remove";
        onDeviceStop?: "remove" | "mute";
        trackConstraints: boolean | MediaTrackConstraints;
    };
    microphone: {
        broadcastOnConnect?: boolean;
        broadcastOnDeviceStart?: boolean;
        defaultMaxBandwidth?: TrackBandwidthLimit;
        defaultTrackMetadata?: TrackMetadata;
        onDeviceChange?: "replace" | "remove";
        onDeviceStop?: "remove" | "mute";
        trackConstraints: boolean | MediaTrackConstraints;
    };
    screenShare: {
        broadcastOnConnect?: boolean;
        broadcastOnDeviceStart?: boolean;
        defaultMaxBandwidth?: TrackBandwidthLimit;
        defaultTrackMetadata?: TrackMetadata;
        streamConfig?: ScreenShareManagerConfig;
    };
    startOnMount?: boolean;
    storage?: boolean | StorageConfig;
}

Type Parameters

  • TrackMetadata

Type declaration

  • camera: {
        broadcastOnConnect?: boolean;
        broadcastOnDeviceStart?: boolean;
        defaultMaxBandwidth?: TrackBandwidthLimit;
        defaultSimulcastConfig?: SimulcastConfig;
        defaultTrackMetadata?: TrackMetadata;
        onDeviceChange?: "replace" | "remove";
        onDeviceStop?: "remove" | "mute";
        trackConstraints: boolean | MediaTrackConstraints;
    }
    • Optional broadcastOnConnect?: boolean

      Determines whether broadcasting should start when the user connects to the server with an active camera stream.

    • Optional broadcastOnDeviceStart?: boolean

      Determines whether broadcasting should start when the user initiates the camera and is connected to the server.

    • Optional defaultMaxBandwidth?: TrackBandwidthLimit
    • Optional defaultSimulcastConfig?: SimulcastConfig
    • Optional defaultTrackMetadata?: TrackMetadata
    • Optional onDeviceChange?: "replace" | "remove"

      Determines whether track should be replaced when the user requests a device. default: replace

    • Optional onDeviceStop?: "remove" | "mute"

      Determines whether currently broadcasted track should be removed or muted when the user stopped a device. default: replace

    • trackConstraints: boolean | MediaTrackConstraints
  • microphone: {
        broadcastOnConnect?: boolean;
        broadcastOnDeviceStart?: boolean;
        defaultMaxBandwidth?: TrackBandwidthLimit;
        defaultTrackMetadata?: TrackMetadata;
        onDeviceChange?: "replace" | "remove";
        onDeviceStop?: "remove" | "mute";
        trackConstraints: boolean | MediaTrackConstraints;
    }
    • Optional broadcastOnConnect?: boolean

      Determines whether broadcasting should start when the user connects to the server with an active camera stream.

    • Optional broadcastOnDeviceStart?: boolean

      Determines whether broadcasting should start when the user initiates the camera and is connected to the server.

    • Optional defaultMaxBandwidth?: TrackBandwidthLimit
    • Optional defaultTrackMetadata?: TrackMetadata
    • Optional onDeviceChange?: "replace" | "remove"

      Determines whether currently broadcasted track should be replaced or stopped when the user changed a device. default: replace

    • Optional onDeviceStop?: "remove" | "mute"

      Determines whether currently broadcasted track should be removed or muted when the user stopped a device. default: replace

    • trackConstraints: boolean | MediaTrackConstraints
  • screenShare: {
        broadcastOnConnect?: boolean;
        broadcastOnDeviceStart?: boolean;
        defaultMaxBandwidth?: TrackBandwidthLimit;
        defaultTrackMetadata?: TrackMetadata;
        streamConfig?: ScreenShareManagerConfig;
    }
    • Optional broadcastOnConnect?: boolean

      Determines whether broadcasting should start when the user connects to the server with an active camera stream.

    • Optional broadcastOnDeviceStart?: boolean

      Determines whether broadcasting should start when the user initiates the camera and is connected to the server.

    • Optional defaultMaxBandwidth?: TrackBandwidthLimit
    • Optional defaultTrackMetadata?: TrackMetadata
    • Optional streamConfig?: ScreenShareManagerConfig
  • Optional startOnMount?: boolean
  • Optional storage?: boolean | StorageConfig

Settings

Member Visibility

Theme