VideoParams interface

Package:

@azure/ai-voicelive

Video streaming parameters for avatar.

Properties

background	Optional background settings for the video. Allows specifying either a solid color or an image URL.
bitrate	Bitrate in bits per second (e.g., 2000000 for 2 Mbps).
codec	Codec to use for encoding. Currently only 'h264' is supported.
crop	Optional cropping settings for the video stream.
gopSize	Group of Pictures (GOP) size for video encoding. Controls the interval between keyframes, affecting compression efficiency and seeking performance.
resolution	Optional resolution settings for the video stream.

Property Details

background

Optional background settings for the video. Allows specifying either a solid color or an image URL.

background?: Background

Property Value

Background

bitrate

Bitrate in bits per second (e.g., 2000000 for 2 Mbps).

bitrate?: number

Property Value

number

codec

Codec to use for encoding. Currently only 'h264' is supported.

codec?: "h264"

Property Value

"h264"

crop

Optional cropping settings for the video stream.

crop?: VideoCrop

Property Value

VideoCrop

gopSize

Group of Pictures (GOP) size for video encoding. Controls the interval between keyframes, affecting compression efficiency and seeking performance.

gopSize?: number

Property Value

number

resolution

Optional resolution settings for the video stream.

resolution?: VideoResolution

Property Value

VideoResolution