Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Using the following speech markers in a particular response will disable equivalent autonomous behavior.

@gestureObject

Code Block
@gestureObject([object_id: str], [start_time(optional): float], [duration(optional): float])

The Digital Person should gesture towards the on-screen object with the given id. Requires Real-Time Gesturing and a UI that supports Content Awareness.

The Digital Person will only perform the gesture if the screen aspect ratio is wide enough for the gesture to look natural and if the content does not overlap the Digital Person.

object_id: string
(required)

The id of the on-screen element that the Digital Person should gesture towards.

For the Default UI this is supported for content blocks, and should use the same object_id as would be used for the @showcards() speech marker.

For a custom UI this is supported for any element marked up with the data-sm-content="objectId" HTML attribute. See [WebSDK / Content Awareness].

start_time: float

The number of seconds delay before the Digital Person should look towards the on-screen element. This delay is relative from the point in speech that the speech marker is reached.

default: 0 (zero seconds, no delay)

duration: float

The number of seconds that the Digital Person should continue looking at the on-screen element.

default: 1 (one second)

@GestureObjectBothSides

Code Block
@gestureObjectBothSides([object_id_1: str],[object_id_2: str], [start_time(optional): float], [duration(optional): float])

The Digital Person should gesture with both hands simultaneously towards two on-screen objects with the given id. Requires Real-Time Gesturing and a UI that supports Content Awareness

The Digital Person will always perform the gesture. A user has to make sure that objects are placed at on both sides of the Digital Person (left and right-hand sidesides).

object_id_1: string

object_id_2: string
(required)

The id of the on-screen element that the Digital Person should gesture towards.

For the Default UI this is supported for content blocks, and should use the same object_id as would be used for the @showcards() speech marker.

For a custom UI this is supported for any element marked up with the data-sm-content="objectId" HTML attribute. See [WebSDK / Content Awareness].

start_time: float

The number of seconds delay before the Digital Person should look towards the on-screen element. This delay is relative from the point in speech that the speech marker is reached.

default: 0 (zero seconds, no delay)

duration: float

The number of seconds that the Digital Person should continue looking at the on-screen element.

default: 1 (one second)

 

Contents

Table of Contents