Package com.microsoft.cognitiveservices.speech.audio

Class AudioInputStream

java.lang.Object

com.microsoft.cognitiveservices.speech.audio.AudioInputStream

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

PullAudioInputStream, PushAudioInputStream

public class AudioInputStream
extends Object
implements AutoCloseable

Represents audio input stream used for custom audio input configurations. Note: close() must be called in order to release underlying resources held by the object.

Method Summary

Modifier and Type	Method	Description
void	close()	Explicitly frees any external resource attached to the object Note: close() must be called in order to release underlying resources held by the object.
static PullAudioInputStream	createPullStream(PullAudioInputStreamCallback callback)	Creates a PullAudioInputStream that delegates to the specified callback interface for read() and close() methods, using the default format (16 kHz, 16 bit, mono PCM).
static PullAudioInputStream	createPullStream(PullAudioInputStreamCallback callback, AudioStreamFormat format)	Creates a PullAudioInputStream that delegates to the specified callback interface for read() and close() methods.
static PushAudioInputStream	createPushStream()	Creates a memory backed PushAudioInputStream using the default format (16 kHz, 16 bit, mono PCM).
static PushAudioInputStream	createPushStream(AudioStreamFormat format)	Creates a memory backed PushAudioInputStream with the specified audio format.
SafeHandle	getImpl()	Internally used to get the underlying native handle of the stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createPushStream

public static PushAudioInputStream createPushStream()

Creates a memory backed PushAudioInputStream using the default format (16 kHz, 16 bit, mono PCM).

Returns:

The audio input stream being created.

createPushStream

public static PushAudioInputStream createPushStream(AudioStreamFormat format)

Creates a memory backed PushAudioInputStream with the specified audio format.

Parameters:

format - The audio data format in which audio will be written to the push audio stream's write() method.

Returns:

The audio input stream being created.

createPullStream

public static PullAudioInputStream createPullStream(PullAudioInputStreamCallback callback)

Creates a PullAudioInputStream that delegates to the specified callback interface for read() and close() methods, using the default format (16 kHz, 16 bit, mono PCM).

Parameters:

callback - The custom audio input object, derived from PullAudioInputStreamCallback

Returns:

The audio input stream being created.

createPullStream

public static PullAudioInputStream createPullStream(PullAudioInputStreamCallback callback,
                                                    AudioStreamFormat format)

Creates a PullAudioInputStream that delegates to the specified callback interface for read() and close() methods.

Parameters:

callback - The custom audio input object, derived from PullAudioInputStreamCallback

format - The audio data format in which audio will be returned from the callback's read() method.

Returns:

The audio input stream being created.

close

public void close()

Explicitly frees any external resource attached to the object Note: close() must be called in order to release underlying resources held by the object.

Specified by:

close in interface AutoCloseable

getImpl

public SafeHandle getImpl()

Internally used to get the underlying native handle of the stream.

Returns:

The implementation of the stream.