Skip to main content

Sambert Flutter SDK

Integre Sambert ao SDK do Flutter. Consulte a sequência de chamadas Dart, os parâmetros da solicitação e os eventos.

Sambert usa streaming unidirecional. O aplicativo envia o texto completo e recebe o áudio sintetizado em blocos.

Pré-requisitos

  • Configure o ambiente de desenvolvimento Flutter para a plataforma de destino. O aplicativo de exemplo requer Dart 3.4 ou posterior, abaixo de 4.0.
  • Obtenha uma chave de API. Selecione um endpoint de serviço na mesma região da chave de API. Se usar um domínio específico do espaço de trabalho, obtenha também o ID do espaço de trabalho.
Não inclua chaves de API de longa duração no código do aplicativo móvel. Para modelos que aceitam uma chave de API temporária, use o servidor do aplicativo para gerar uma chave de API temporária e enviá-la ao cliente.

Instalar o SDK

Abra Seleção e download do SDK móvel de voz, selecione a guia Flutter e baixe e extraia o pacote. Copie o diretório extraído do SDK para packages/aliyun_neonui no projeto Flutter e adicione a dependência local ao pubspec.yaml.
dependencies:
  aliyun_neonui:
    path: packages/aliyun_neonui
Execute flutter pub get e importe o SDK no arquivo Dart.
import 'package:aliyun_neonui/neonui.dart';

Início rápido

Execute o aplicativo de exemplo

  1. Conecte o dispositivo de destino. Execute estes comandos no diretório do SDK extraído.
    cd example
    flutter pub get
    flutter run
    
  2. Na tela inicial do aplicativo de exemplo, abra 百炼(DashScope). Selecione um endpoint de serviço e informe a API Key. Se usar um domínio específico do espaço de trabalho, informe também o WorkspaceId.
  3. Abra Sambert 单向流式语音合成 e execute o exemplo.
O código completo está em example/lib/pages/dashscope/dash_sambert_tts_page.dart no pacote do SDK.

Modelos incluídos no exemplo

  • sambert-zhinan-v1

Sequência de chamadas

Chame estes métodos na instância retornada por NativeNui().
  1. Assine ttsEventStream e ttsAudioStream antes de chamar os métodos.
  2. Use o JSON de conexão abaixo como initJson. Passe os parâmetros da tarefa como pares de chave e valor para ttsSetParam.
    await nui.ttsInitialize(params: initJson);
    for (final entry in taskParams.entries) {
      await nui.ttsSetParam(entry.key, entry.value);
    }
    await nui.ttsStart(priority: '1', taskId: '', text: '你好,欢迎使用语音合成。');
    
    Após inicializar o SDK, configure os parâmetros da tarefa um de cada vez. Envie o texto completo com ttsStart e leia o áudio no fluxo.
  3. O evento TTS_EVENT_END indica que o SDK concluiu o envio de áudio. Ao terminar, chame ttsRelease.

Parâmetros de solicitação

O exemplo usa um modelo incluído no pacote. Para outras configurações, consulte example/lib/dashscope_params.dart. Substitua YOUR_WS_HOST pelo host WebSocket da região, YOUR_DEVICE_ID pelo ID do dispositivo e YOUR_API_KEY por uma chave de API da mesma região.

Parâmetros de conexão

Passe o JSON do exemplo como string ao método Dart.
{
  "url": "wss://YOUR_WS_HOST/api-ws/v1/inference",
  "device_id": "YOUR_DEVICE_ID",
  "mode_type": "2"
}

Parâmetros da tarefa

Defina cada parâmetro com ttsSetParam(key, value). Passe os valores numéricos como strings, conforme o exemplo.
{
  "apikey": "YOUR_API_KEY",
  "model": "sambert-zhinan-v1",
  "format": "pcm",
  "enable_audio_decoder": "0",
  "sample_rate": "48000",
  "volume": "50",
  "rate": "1.0",
  "pitch": "1.0"
}
Em Sambert, model seleciona o ID do modelo associado à voz. Este exemplo usa uma voz de 48 kHz do pacote. Reproduza o áudio na mesma taxa de amostragem.

Referência da API

Métodos

Nos métodos que retornam Future<int>, o código 0 indica êxito.
Assinatura do métodoFinalidade
Future<int> ttsInitialize({required String params, int logLevel = 0, bool saveLog = false})Inicializa o SDK com os parâmetros de conexão em uma string JSON.
Future<int> ttsSetParam(String key, String value)Define um parâmetro da tarefa com valor em string.
Future<int> ttsStart({required String priority, required String taskId, required String text})Envia o texto completo. O exemplo usa priority: '1' e taskId: ''.
Future<int> ttsPause()Pausa a síntese.
Future<int> ttsResume()Retoma a síntese.
Future<int> ttsCancel(String taskId)Cancela a síntese pelo ID da tarefa.
Future<String?> ttsGetParam(String key)Lê um parâmetro. Use error_msg para obter detalhes do erro.
Future<int> ttsRelease()Libera os recursos do SDK.

Eventos e fluxos de áudio

Leia os eventos em ttsEventStream. Quando um evento chega como um mapa Dart, leia o nome em event e consulte resultCode para identificar erros na tarefa. O fluxo ttsAudioStream fornece blocos de áudio para reprodução pelo aplicativo.
EventoFinalidade
TTS_EVENT_STARTInício da síntese ou do áudio da resposta
TTS_EVENT_ENDConclusão da tarefa ou da saída de áudio atual
TTS_EVENT_CANCELCancelamento da tarefa
TTS_EVENT_ERRORFalha na tarefa