smwebsdk.scene._constructor__1
Home > @soulmachines/smwebsdk > Scene > (constructor)
Scene.(constructor)
Warning: This API is now obsolete.
Use
new Scene(options: SceneOptions)instead
Construct Scene with parameters
Signature:
constructor(videoElement?: HTMLVideoElement, audioOnly?: boolean, requestedUserMedia?: UserMedia, requiredUserMedia?: UserMedia, contentAwarenessDebounceTime?: number, loggingConfig?: Partial<LoggingConfig>, tracerOptions?: TracerOptions, chromaKeyOptions?: ChromaKeyOptions);
Parameters
| Parameter | Type | Description |
|---|---|---|
| videoElement | HTMLVideoElement | (Optional) A video element that will display the connected scene |
| audioOnly | boolean | (Optional) This streaming should be audio streaming only (no video streaming) |
| requestedUserMedia | UserMedia | (Optional) The user media devices (microphone/camera) that should be requested, one of: UserMedia.None, UserMedia.Microphone, UserMedia.MicrophoneAndCamera (default) |
| requiredUserMedia | UserMedia | (Optional) Required user media devices, one of: UserMedia.None, UserMedia.Microphone, UserMedia.MicrophoneAndCamera If less user media devices are requested then are required then the requirements takes precedence. If this user media requirements is not met then Connect() will fail. |
| contentAwarenessDebounceTime | number | (Optional) The timeout period used for debouncing messaging within the content awareness class |
| loggingConfig | Partial<LoggingConfig> | (Optional) Options to configure different log levels for different classes |
| tracerOptions | TracerOptions | (Optional) |
| chromaKeyOptions | ChromaKeyOptions | (Optional) |