API reference
API reference
Select your platform
No SDKs available
No versions available

AudioStreamHandler Class

Extends DownloadHandlerScript, Meta.WitAi.Requests.IVRequestDownloadDecoder
A download handler for UnityWebRequest that decodes audio data and performs audio sample decoded callbacks.

Constructors

AudioStreamHandler ( audioDecoder , onSamplesDecoded )
The constructor that generates the decoder and handles routing callbacks
Signature
Meta.WitAi.Requests.AudioStreamHandler.AudioStreamHandler(IAudioDecoder audioDecoder, AudioSampleDecodeDelegate onSamplesDecoded)
Parameters
audioDecoder: IAudioDecoder  The audio type requested (Wav, MP3, etc.)
onSamplesDecoded: AudioSampleDecodeDelegate  Called on background thread for every chunk of samples decoded.

Fields

WillDecodeInBackground : bool
Quick accessor for audio decoder's will decode in background method. If true, performant but requires multiple buffers. If false, buffers are not required but less performant.
Signature
bool Meta.WitAi.Requests.AudioStreamHandler.WillDecodeInBackground

Properties

AudioDecoder : IAudioDecoder
[Get]
The script being used to decode audio
Signature
IAudioDecoder Meta.WitAi.Requests.AudioStreamHandler.AudioDecoder
Completion : TaskCompletionSource< bool >
[Get]
Completion source task
Signature
TaskCompletionSource<bool> Meta.WitAi.Requests.AudioStreamHandler.Completion
IsComplete : bool
[Get]
Whether or not complete
Signature
bool Meta.WitAi.Requests.AudioStreamHandler.IsComplete
IsError : bool
[Get]
Whether the request was caused by an error
Signature
bool Meta.WitAi.Requests.AudioStreamHandler.IsError
IsStarted : bool
[Get]
Whether data has arrived
Signature
bool Meta.WitAi.Requests.AudioStreamHandler.IsStarted
Logger : IVLogger
[Get]
Signature
IVLogger Meta.WitAi.Requests.AudioStreamHandler.Logger
OnSamplesDecoded : AudioSampleDecodeDelegate
[Get]
Callback for audio sample decode
Signature
AudioSampleDecodeDelegate Meta.WitAi.Requests.AudioStreamHandler.OnSamplesDecoded
Progress : float
[Get]
Current progress of the download
Signature
float Meta.WitAi.Requests.AudioStreamHandler.Progress

Events

OnFirstResponse : VRequestResponseDelegate
Signature
VRequestResponseDelegate Meta.WitAi.Requests.AudioStreamHandler.OnFirstResponse
OnProgress : VRequestProgressDelegate
Callback for download progress
Signature
VRequestProgressDelegate Meta.WitAi.Requests.AudioStreamHandler.OnProgress
OnResponse : VRequestResponseDelegate
Signature
VRequestResponseDelegate Meta.WitAi.Requests.AudioStreamHandler.OnResponse

Protected Methods

CompleteContent ()
Signature
override void Meta.WitAi.Requests.AudioStreamHandler.CompleteContent()
Returns
override void
GetProgress ()
Signature
override float Meta.WitAi.Requests.AudioStreamHandler.GetProgress()
Returns
override float
GetText ()
Signature
override string Meta.WitAi.Requests.AudioStreamHandler.GetText()
Returns
override string
ReceiveContentLengthHeader ( contentLength )
If size is provided, determine if end size is too small for an audio file
Signature
override void Meta.WitAi.Requests.AudioStreamHandler.ReceiveContentLengthHeader(ulong contentLength)
Parameters
contentLength: ulong
Returns
override void
ReceiveData ( bufferData , length )
Receive data and push it to the ring buffer
Signature
override bool Meta.WitAi.Requests.AudioStreamHandler.ReceiveData(byte[] bufferData, int length)
Parameters
bufferData: byte []
length: int
Returns
override bool

Methods

Dispose ()
Dispose ring buffer
Signature
override void Meta.WitAi.Requests.AudioStreamHandler.Dispose()
Returns
override void