Interface IAvatarBridgeService
- Namespace
- Oscova.Agents.Avatar
- Assembly
- Oscova.Agents.dll
Defines operations supported by an Oscova Avatar Engine bridge.
public interface IAvatarBridgeServiceProperties
- ConnectedBaseUrl
-
Gets the base URL currently targeted by the bridge.
Methods
- ChangeBackgroundColorAsync(int, int, int)
-
Changes the background color using RGB components. Values outside the valid range (0-255) are rejected by the avatar engine.
- ChangeResolutionAsync(int, int, bool)
-
Changes the engine/window resolution and fullscreen mode.
- CheckHealthAsync()
-
Performs a lightweight health/status check for the running avatar engine.
- ClearMessageAsync()
-
Clears the avatar message panel immediately.
- ConnectAsync(string)
-
Connects to the avatar engine at the specified base URL.
- ListAvatarsAsync()
-
Retrieves the avatar names reported by the running engine.
- ListEmotionsAsync()
-
Retrieves the emotion names reported by the running engine.
- QueueFileSpeechAsync(string, string)
-
Queues a local speech file for lip-sync and speech playback.
- QueueSpeechAsync(string, string)
-
Queues speech playback using a remote audio URL. The avatar bridge downloads the URL to a local file before enqueueing playback.
- SelectAvatarAsync(string)
-
Selects the current avatar by name. Avatar name must match one of the available avatars (case-sensitive). Switching avatars may cause a brief loading period.
- SetCameraYawAsync(float)
-
Adjusts camera yaw (rotation around vertical axis). The avatar engine expects a value from -5.0 through 5.0. Negative values rotate the camera left, positive values rotate right.
- SetEmotionAsync(string, float)
-
Sets a target emotion with smooth transition. The emotion will transition over the specified blend speed duration. Emotion name must match one of the available emotions (case-sensitive).
- SetGraphicsPresetAsync(int)
-
Sets the global graphics quality preset. Level values map to known presets (0=Low, 1=Medium, 2=High, 3=Epic). Other values are allowed.
- SetMessageBoxPositionAsync(float, float)
-
Sets the avatar message box position while preserving its current size.
- SetMessageBoxSizeAsync(float, float)
-
Sets the avatar message box size while preserving its current position.
- SetMessageColorAndOpacityAsync(float, float, float, float)
-
Sets the avatar message color and opacity using normalized RGBA values.
- SetMessageDisplayDurationAsync(float)
-
Sets how long avatar messages remain visible.
- SetMessageFontSizeAsync(int)
-
Sets the avatar message font size.
- SetSpeechVolumeAsync(float)
-
Sets the speech playback volume. Values outside the valid range (0.0 to 1.0) are rejected by the avatar engine.
- ShowMessageAsync(string)
-
Shows text on the avatar message panel without playing audio.
- ShutdownAsync(bool)
-
Requests a shutdown of the avatar engine. The response is sent before the engine terminates.
- StopSpeechAsync(bool)
-
Stops ongoing speech playback and lip-sync animation.