View Source ExAzureSpeech.Common.Messages.SpeechConfigMessage (ex_azure_speech v0.2.2)

Message used to inform the Speech service about which SDK is being used and the type of audio it should expect.

Path: speech.config
Content-Type: application/json
MessageType: text

Summary

Types

audio()

source: The audio source configuration.

context()

system: The system information.
os: The os information.
audio: The audio information.

os()

name: The name of the os.
version: The version of the os.
platform: The platform of the os.

source()

bitspersample: The number of bits per sample.
channelcount: The number of channels.
connectivity: The connectivity of the audio source.
manufacturer: The manufacturer of the audio source.
model: The model of the audio source.
samplerate: The sample rate of the audio source.
type: The type of the audio source.

system()

name: The name of the system sdk.
version: The version of the system sdk.
build: The build of the system sdk.
lang: The programming language of the system sdk.

t()

context: The context of the message.
recognition: The type of recognition to be performed.

Functions

new()

Creates a new SpeechConfigMessage.

Types

audio()

@type audio() :: %{source: source()}

source: The audio source configuration.

context()

@type context() :: %{system: system(), os: os(), audio: audio()}

system: The system information.
os: The os information.
audio: The audio information.

os()

@type os() :: %{name: String.t(), version: String.t(), platform: String.t()}

name: The name of the os.
version: The version of the os.
platform: The platform of the os.

source()

@type source() :: %{
  bitspersample: non_neg_integer(),
  channelcount: non_neg_integer(),
  connectivity: String.t(),
  manufacturer: String.t(),
  model: String.t(),
  samplerate: non_neg_integer(),
  type: String.t()
}

bitspersample: The number of bits per sample.
channelcount: The number of channels.
connectivity: The connectivity of the audio source.
manufacturer: The manufacturer of the audio source.
model: The model of the audio source.
samplerate: The sample rate of the audio source.
type: The type of the audio source.

system()

@type system() :: %{
  name: String.t(),
  version: String.t(),
  build: String.t(),
  lang: String.t()
}

name: The name of the system sdk.
version: The version of the system sdk.
build: The build of the system sdk.
lang: The programming language of the system sdk.

t()

@type t() :: %ExAzureSpeech.Common.Messages.SpeechConfigMessage{
  context: context(),
  recognition: :interactive | :conversation | :dictation
}

context: The context of the message.
recognition: The type of recognition to be performed.

Functions

new()

@spec new() :: t()

Creates a new SpeechConfigMessage.