Scene interface

Package:

@azure/ai-voicelive

Configuration for avatar's zoom level, position, rotation and movement amplitude in the video frame.

Properties

amplitude	Amplitude of the avatar movement. Range is (0, 1]. Values in (0, 1) mean reduced amplitude, 1 means full amplitude.
positionX	Horizontal position of the avatar. Range is [-1, 1], as a proportion of frame width. Negative values move left, positive values move right.
positionY	Vertical position of the avatar. Range is [-1, 1], as a proportion of frame height. Negative values move up, positive values move down.
rotationX	Rotation around the X-axis (pitch). Range is [-π, π] in radians. Negative values rotate up, positive values rotate down.
rotationY	Rotation around the Y-axis (yaw). Range is [-π, π] in radians. Negative values rotate left, positive values rotate right.
rotationZ	Rotation around the Z-axis (roll). Range is [-π, π] in radians. Negative values rotate anticlockwise, positive values rotate clockwise.
zoom	Zoom level of the avatar. Range is (0, +∞). Values less than 1 zoom out, values greater than 1 zoom in.

Property Details

amplitude

Amplitude of the avatar movement. Range is (0, 1]. Values in (0, 1) mean reduced amplitude, 1 means full amplitude.

amplitude?: number

Property Value

number

positionX

Horizontal position of the avatar. Range is [-1, 1], as a proportion of frame width. Negative values move left, positive values move right.

positionX?: number

Property Value

number

positionY

Vertical position of the avatar. Range is [-1, 1], as a proportion of frame height. Negative values move up, positive values move down.

positionY?: number

Property Value

number

rotationX

Rotation around the X-axis (pitch). Range is [-π, π] in radians. Negative values rotate up, positive values rotate down.

rotationX?: number

Property Value

number

rotationY

Rotation around the Y-axis (yaw). Range is [-π, π] in radians. Negative values rotate left, positive values rotate right.

rotationY?: number

Property Value

number

rotationZ

Rotation around the Z-axis (roll). Range is [-π, π] in radians. Negative values rotate anticlockwise, positive values rotate clockwise.

rotationZ?: number

Property Value

number

zoom

Zoom level of the avatar. Range is (0, +∞). Values less than 1 zoom out, values greater than 1 zoom in.

zoom?: number

Property Value

number