Share via

AvatarVideoFormat class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

Defines the avatar output video format.

Constructors

AvatarVideoFormat(string, number, number, number)

Creates and initializes an instance of this class.

Properties

bitrate

Defines the video bitrate.
codec

Defines the video codec.
height

Defines the video height.
width

Defines the video width.

Methods

setCropRange(Coordinate, Coordinate)

Sets the video crop range.

Constructor Details

AvatarVideoFormat(string, number, number, number)

Creates and initializes an instance of this class.

new AvatarVideoFormat(codec?: string, bitrate?: number, width?: number, height?: number)

Parameters

codec

string

The video codec.

bitrate

number

The video bitrate.

width

number

The video width.

height

number

The video height.

Property Details

bitrate

Defines the video bitrate.

bitrate: number

Property Value

number

codec

Defines the video codec.

codec: string

Property Value

string

height

Defines the video height.

height: number

Property Value

number

width

Defines the video width.

width: number

Property Value

number

Method Details

setCropRange(Coordinate, Coordinate)

Sets the video crop range.

function setCropRange(topLeft: Coordinate, bottomRight: Coordinate)

Parameters

topLeft
Coordinate
bottomRight
Coordinate