Aller au contenu principal

voice.off()

La méthode off() supprime les écouteurs d’événements précédemment enregistrés avec on(). Elle est particulièrement utile pour libérer les ressources et prévenir les fuites de mémoire dans les applications de longue durée avec capacités vocales en temps réel.

Exemple d’utilisation
Lien direct vers Exemple d’utilisation

import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
import chalk from 'chalk'

// Initialize a real-time voice provider
const voice = new OpenAIRealtimeVoice({
realtimeConfig: {
model: 'gpt-5.1-realtime',
apiKey: process.env.OPENAI_API_KEY,
},
})

// Connect to the real-time service
await voice.connect()

// Define the callback function
const writingCallback = ({ text, role }) => {
if (role === 'user') {
process.stdout.write(chalk.green(text))
} else {
process.stdout.write(chalk.blue(text))
}
}

// Register event listener
voice.on('writing', writingCallback)

// Later, when you want to remove the listener
voice.off('writing', writingCallback)

Paramètres
Lien direct vers Paramètres


event:

string
Nom de l’événement à ne plus écouter (par ex. 'speaking', 'writing', 'error')

callback:

function
Même fonction de rappel que celle transmise à on()

Valeur renvoyée
Lien direct vers Valeur renvoyée

Cette méthode ne renvoie aucune valeur.

Remarques
Lien direct vers Remarques

  • La fonction de rappel transmise à off() doit être la même référence de fonction que celle transmise à on()
  • Si la fonction de rappel est introuvable, la méthode n’a aucun effet
  • Cette méthode est principalement utilisée avec les fournisseurs Voice en temps réel prenant en charge une communication fondée sur les événements
  • Si elle est appelée sur un fournisseur Voice ne prenant pas en charge les événements, elle consigne un avertissement et ne fait rien
  • Supprimer les écouteurs d’événements est important pour prévenir les fuites de mémoire dans les applications de longue durée