Skip to main content

PlaybackCapabilities

ug-js-sdk

ug-js-sdk / PlaybackCapabilities

Interface: PlaybackCapabilities

Defined in: types/index.ts:69

Configures which playback features are enabled.

Use this to enable/disable specific output modalities based on your application needs. Disabling unused features can improve performance.

Example​

// Audio-only mode (no avatar)
const capabilities: PlaybackCapabilities = {
  audio: true,
  subtitles: true,
  viseme: false,
  avatar: false,
}

Properties​

audio?​

optional audio: boolean

Defined in: types/index.ts:71

Enable audio playback of assistant responses

viseme?​

optional viseme: boolean

Defined in: types/index.ts:73

Enable viseme data for lip-sync animations

subtitles?​

optional subtitles: boolean

Defined in: types/index.ts:75

Enable subtitle generation

avatar?​

optional avatar: boolean

Defined in: types/index.ts:77

Enable avatar rendering