martedì 30 aprile 2013

WP8 : Installare dinamicamente i Voice Command Definition, DynamicVCD

I Voice Command Definition sono dei file XML che permettono di configurare quali sono i comandi vocali, gestiti da Windows Phone 8, a cui la nostra applicazione risponde.

Per una trattazione più approfondita sull’argomento vi rimando al blog di Michele Locuratolo (anatomia del file VCD, registrazione del file VCD, Gestione del Voice Command).

In questo post vorrei suggerire un modo per gestire dinamicamente l’installazione e la configurazione di tali file.

Una app può installare un solo VCD e, una volta installato, si possono solamente modificare le phrase list e non si possono aggiungere o rimuovere i comandi (a meno di non reinstallare il file).

L’idea è quella di creare una struttura dati che descriva il voice command definition:

image

e, utilizzando, queste strutture costruire “al volo” i file VCD da salvare su storage e installare in maniera “canonica”.

  1. Public Shared Async Function InstallVoiceCommandDefinitionAsync(voiceCommandDefinition As VoiceCommandDefinition) As Task
  2.     If voiceCommandDefinition Is Nothing Then Throw New ArgumentNullException("voiceCommandDefinition")
  3.     Try
  4.         Dim xmlString = CreateXml(voiceCommandDefinition)
  5.         If Await SaveAsync(VCDFileName, xmlString) Then
  6.             Await MSSpeech.VoiceCommandService.InstallCommandSetsFromFileAsync(GetLocalUri(VCDFileName))
  7.         End If
  8.     Catch ex As Exception
  9.         Dim newEx = ExceptionFactory.CreateException(ex)
  10.         Throw newEx
  11.     End Try
  12. End Function

In questo contesto non stiamo a dettagliare i vari metodi utilizzati (anche perchè il codice è disponibile su Codeplex).

In sostanza potremo creare una nostra classe VoiceCommandService che fa da wrapper all’omologa fornita dalle Speech API di Windows Phone 8 e che fornisce, oltre alle funzioni di serie, anche la possibilità di creare ed installare al volo un VCD.

Un esempio può essere:

  1. Public Async Function InstallVCD() As task
  2.     Dim vcd = New VoiceCommandDefinition
  3.     ' Define command set
  4.     Dim cs = New CommandSet
  5.     cs.Name = "MyAppCommandSet"
  6.     cs.Culture = "en-US"
  7.     cs.CommandPrefix = "MyApp"
  8.     cs.Example = "Sample"
  9.     vcd.AddCommandSet(cs)
  10.     ' Define single Command
  11.     Dim c = New Command() With {.Name = "OpenDocument",
  12.                                 .Feedback = "I'm opening a document...",
  13.                                 .Example = "Open a document"}
  14.     c.ListenForList.Add("open [a] document")
  15.     c.ListenForList.Add("show [a] document")
  16.     cs.AddCommand(c)
  17.     ' Try to install the VCD
  18.     Try
  19.         Await VoiceCommandService.InstallVoiceCommandDefinitionAsync(vcd)
  20.         MessageBox.Show("VCD installed correctly")
  21.     Catch ex As Exception
  22.         MessageBox.Show(ex.Message)
  23.     End Try
  24. End Function

Sta alla nostra fantasia, poi, utilizzare le funzionalità di configurazione al volo in maniera opportuna. Ad esempio si potrebbero attivare comandi in base alle funzionalità acquistate dall’utente o permettere allo stesso di personalizzare i propri comandi.

Il progetto, il cui nome è DynamicVCD, è disponibile in licensa Ms-PL su CodePlex all’indirizzo https://dynamicvcd.codeplex.com/ ed è disponibile anche su NuGet (https://www.nuget.org/packages/DynamicVCD/).

Critiche, consigli e proposte di nuove funzionalità sono bene accetti! Winking smile

Nessun commento: