C# Class HoloToolkit.Unity.MicStream

显示文件 Open project: Microsoft/HoloToolkit-Unity Class Usage Examples

Public Methods

Method Description
CheckForErrorOnCall ( int returnCode ) : bool

Prints useful error/warning messages based on error codes returned from the functions in this class

MicStartStream ( bool keepData, bool previewOnDevice ) : int

Call this to start receiving data from a microphone. Then, each frame, call MicGetFrame.

MicStopRecording ( ) : string

Finishes writing the file recording started with MicStartRecording.

Private Methods

Method Description
MicDestroy ( ) : int
MicGetDefaultBufferSize ( ) : int
MicGetDefaultNumChannels ( ) : int
MicGetFrame ( float buffer, int length, int numchannels ) : int
MicInitializeCustomRate ( int category, int samplerate ) : int
MicInitializeDefault ( int category ) : int
MicPause ( ) : int
MicResume ( ) : int
MicSetGain ( float g ) : int
MicStartRecording ( string filename, bool previewOnDevice ) : int
MicStartStream ( bool keepData, bool previewOnDevice, LiveMicCallback micsignal ) : int
MicStopRecording ( StringBuilder sb ) : void
MicStopStream ( ) : int

Method Details

CheckForErrorOnCall() public static method

Prints useful error/warning messages based on error codes returned from the functions in this class
public static CheckForErrorOnCall ( int returnCode ) : bool
returnCode int An error code returned by another function in this class
return bool

MicStartStream() public static method

Call this to start receiving data from a microphone. Then, each frame, call MicGetFrame.
public static MicStartStream ( bool keepData, bool previewOnDevice ) : int
keepData bool If true, all data will stay in the queue, if the client code is running behind. This can lead to significant audio lag, so is not appropriate for low-latency situations like reall-time voice chat.
previewOnDevice bool If true, the audio from the microphone will be played through your speakers.
return int

MicStopRecording() public static method

Finishes writing the file recording started with MicStartRecording.
public static MicStopRecording ( ) : string
return string