settings

Video Recording configuration object.

Details

Attribute: settings

Type: VideoSettings

Default value: View field table

VideoServiceType

Member	Value	Description
WS	ws	Remote recording via WebSocket (default).
SSE	sse	Remote recording via Server-Sent Events.
LOCAL	local	Local recording in the browser.

CameraType

Member	Value	Description
USER	user	Front camera.
ENVIRONMENT	environment	Rear camera.

VideoQuality

Member	Value	Description
LOW	low	250 kbps.
MEDIUM	medium	625 kbps.
HIGH	high	1000 kbps.

Fields of VideoSettings

Property	Type	Default	Description
serviceType	VideoServiceType	ws	Recording mode. Use local for browser recording.
cameraWidth	number	1280	Camera resolution width in pixels.
cameraHeight	number	720	Camera resolution height in pixels.
audioEnabled	boolean	true	Captures audio from the microphone along with the video.
cameraType	CameraType	environment	Initial camera orientation.
cameraId	string	''	deviceId of a specific camera.
cameraSwitch	boolean	true	Allows switching between cameras at runtime.
videoQuality	VideoQuality	medium	Recording bitrate.
videoTimer	boolean	false	Overlays a timer HH:MM:SS in local recording.

Morphology

import { VideoServiceType } from '@facephi/sdk-web-wc';

video.settings = {
  serviceType: VideoServiceType.LOCAL,
  audioEnabled: true,
  videoTimer: false,
};

Description

Configures video recording behavior. JS property only (no HTML attribute). Omitted fields take the default values from the table.

Considerations

• With serviceType: 'local', recording starts when the component is rendered; the video is obtained with stopVideo.

• videoTimer only applies in mode local.

• The modes ws and sse require recording license and configuration of baseUrl and apiKey in the license.

---

Example

import { VideoServiceType } from '@facephi/sdk-web-wc';

<facephi-video-provider
    settings={{
        serviceType: VideoServiceType.LOCAL,
        audioEnabled: true,
        videoTimer: false,
    }}
    onChangeLoading={(event) => {
        if (!event.detail) {
            // Iniciar widgets hijos
        }
    }}
>
    <facephi-selphi-widget />
</facephi-video-provider>