Send feedback
Class v1.SpeechClient (4.8.1) Stay organized with collections
Save and categorize content based on your preferences.
Version 4.8.1 keyboard_arrow_down
Service that implements Google Cloud Speech API. v1
Package
@google-cloud/speech!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of SpeechClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
operationsClient
operationsClient
:
gax
.
OperationsClient
;
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
speechStub
speechStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
> void
;
Property Value
Methods
_streamingRecognize(options)
_streamingRecognize
(
options
?:
CallOptions
)
:
gax
.
CancellableStream
;
Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
Parameter Name
Description
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
gax. CancellableStream
{Stream} An object stream which is both readable and writable. It accepts objects representing [StreamingRecognizeRequest] for write() method, and will emit objects representing [StreamingRecognizeResponse] on 'data' event asynchronously. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming) for more details and examples.
checkLongRunningRecognizeProgress(name)
checkLongRunningRecognizeProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
speech
.
v1
.
LongRunningRecognizeResponse
,
protos
.
google
.
cloud
.
speech
.
v1
.
LongRunningRecognizeMetadata
>> ;
Check the status of the long running operation returned by longRunningRecognize()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.speech.v1.LongRunningRecognizeResponse
, protos. google.cloud.speech.v1.LongRunningRecognizeMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns Type
Description
Promise
<void>
{Promise} A promise that resolves when the client is closed.
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
longRunningRecognize(request, options)
longRunningRecognize
(
request
?:
protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeResponse
,
protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.speech.v1.ILongRunningRecognizeRequest
options
CallOptions
Returns
longRunningRecognize(request, options, callback)
longRunningRecognize
(
request
:
protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeResponse
,
protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.speech.v1.ILongRunningRecognizeRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.speech.v1.ILongRunningRecognizeResponse
, protos. google.cloud.speech.v1.ILongRunningRecognizeMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
longRunningRecognize(request, callback)
longRunningRecognize
(
request
:
protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeResponse
,
protos
.
google
.
cloud
.
speech
.
v1
.
ILongRunningRecognizeMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.speech.v1.ILongRunningRecognizeRequest
callback
Callback
< LROperation
<protos. google.cloud.speech.v1.ILongRunningRecognizeResponse
, protos. google.cloud.speech.v1.ILongRunningRecognizeMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
recognize(request, options)
recognize
(
request
?:
protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeResponse
,
protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.speech.v1.IRecognizeRequest
options
CallOptions
Returns
recognize(request, options, callback)
recognize
(
request
:
protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeResponse
,
protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.speech.v1.IRecognizeRequest
options
CallOptions
callback
Callback
<protos. google.cloud.speech.v1.IRecognizeResponse
, protos. google.cloud.speech.v1.IRecognizeRequest
| null | undefined, {} | null | undefined>
Returns
recognize(request, callback)
recognize
(
request
:
protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeResponse
,
protos
.
google
.
cloud
.
speech
.
v1
.
IRecognizeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.speech.v1.IRecognizeRequest
callback
Callback
<protos. google.cloud.speech.v1.IRecognizeResponse
, protos. google.cloud.speech.v1.IRecognizeRequest
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
