experiments/STT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mark aNumResults parameters in *withMetadata methods as optional

Browse Source
This commit is contained in:
Reuben Morais 2020-05-06 12:03:14 +02:00
parent 41d990e538
commit e6e3cc539b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
native_client/javascript/index.d.ts vendored
View File

@ -103,7 +103,7 @@ stt(aBuffer: object): string;
* @return :js:func:`Metadata` object containing multiple candidate transcripts. Each transcript has per-token metadata including timing information. * @return :js:func:`Metadata` object containing multiple candidate transcripts. Each transcript has per-token metadata including timing information.
* The user is responsible for freeing Metadata by calling :js:func:`FreeMetadata`. Returns undefined on error. * The user is responsible for freeing Metadata by calling :js:func:`FreeMetadata`. Returns undefined on error.
*/ */
sttWithMetadata(aBuffer: object, aNumResults: number): Metadata; sttWithMetadata(aBuffer: object, aNumResults?: number): Metadata;
/** /**
* Create a new streaming inference state. One can then call :js:func:`Stream.feedAudioContent` and :js:func:`Stream.finishStream` on the returned stream object. * Create a new streaming inference state. One can then call :js:func:`Stream.feedAudioContent` and :js:func:`Stream.finishStream` on the returned stream object.
@ -143,7 +143,7 @@ intermediateDecode(aSctx: Stream): string;
* *
* @return :js:func:`Metadata` object containing multiple candidate transcripts. Each transcript has per-token metadata including timing information. The user is responsible for freeing Metadata by calling :js:func:`FreeMetadata`. Returns undefined on error. * @return :js:func:`Metadata` object containing multiple candidate transcripts. Each transcript has per-token metadata including timing information. The user is responsible for freeing Metadata by calling :js:func:`FreeMetadata`. Returns undefined on error.
*/ */
intermediateDecodeWithMetadata (aNumResults: number): Metadata; intermediateDecodeWithMetadata (aNumResults?: number): Metadata;
/** /**
* Compute the final decoding of an ongoing streaming inference and return the result. Signals the end of an ongoing streaming inference. * Compute the final decoding of an ongoing streaming inference and return the result. Signals the end of an ongoing streaming inference.
@ -163,7 +163,7 @@ finishStream(): string;
* *
* This method will free the stream, it must not be used after this method is called. * This method will free the stream, it must not be used after this method is called.
*/ */
finishStreamWithMetadata(aNumResults: number): Metadata; finishStreamWithMetadata(aNumResults?: number): Metadata;
} }
/** /**