Configuration

📈 Configuration du SDK

La configuration du SDK Surpuissant ne prend que quelques étapes.

Initialisation

Pour initialiser le SDK, utilisez la méthode setup avec les paramètres requis comme le contexte de l'application, votre clé API (que vous pouvez récuperez ici), et les mots-clés que vous souhaitez détecter. Voici un exemple de code pour configurer votre SDK :

Surpuissant.setup(
    Configuration(
        context = applicationContext,
        apiKey = "votre_clé_api",
        keywords = listOf("surpuissant")
        //Seul 'Surpuissant' est disponible acutellement,
        //contactez-nous pour en savoir plus
    )
)

Note de sécurité

Pour protéger votre clé API et autres informations sensibles, il est recommandé d'utiliser des outils comme ProGuard ou R8 pour l'obfuscation et la minification du code.

Demande de permission

Avant de démarrer l'enregistrement, il est nécessaire de demander la permission d'accès au microphone de l'utilisateur. Le SDK fournit une méthode facilitant cette demande :

Surpuissant.askRecordPermission(this) { _ ->
    Surpuissant.startRecord { status: Status ->
        Log.d("MainActivity", "startRecord: $status")
    }
}

Si le status retourné est Status.SUCCESS, cela signifie que le SDK est prêt à écouter les mots-clés et les phrases d'action.

Stopper l'enregistrement

Pour vous assurer que le SDK n'enregistre pas lorsque l'application est complètement fermée, il est crucial d'appeler la fonction stopRecord dans la méthode onDestroy de votre MainActivity. Cela garantit que l'enregistrement est correctement stoppé lorsque l'utilisateur quitte l'application :

override fun onDestroy() {
    super.onDestroy()
    Surpuissant.stopRecord()
}

Note de sécurité

Ne pas oublier de stopper l'enregistrement ! Si la fonction stopRecord n'est pas appelée, l'application pourrait continuer à enregistrer des données même après sa fermeture, ce qui pourrait entraîner des problèmes de confidentialité et de performance.

Configuration minimale

Pour une configuration minimale, votre fichier MainActivity.kt devrait ressembler à ça :

MainActivity.kt

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        // ...
        Surpuissant.setup(
            Configuration(
                context = applicationContext,
                apiKey = "your-api-key",
                keywords = listOf("surpuissant")
            )
        )

        Surpuissant.askRecordPermission(this) { _ ->
            Surpuissant.startRecord { status: Status ->
                Log.d("MainActivity", "startRecord: $status")
            }
        }
        // ...
    }

    override fun onDestroy() {
        super.onDestroy()
        Surpuissant.stopRecord()
    }
}

Si malgré tout vous avez des difficultés à mettre en place le SDK, nous vous invitons à regarder l'exemple.

C'est tout !

Dès votre inscription une commande par défaut est disponible pour vous permettre de tester le SDK. Dites simplement "Surpuissant" puis au premier son "Bonjour, je m'appelle [votre nom] et j'ai [votre âge] ans". Un son sera joué pour vous indiquer que la commande a été reconnue. Vous pouvez ensuite consulter la partie Playground pour voir les résultats de votre commande.