| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_131-google-v7) on Thu Apr 19 15:01:45 PDT 2018 --> |
| <title>StreamingRecognitionConfigOrBuilder (java API)</title> |
| <meta name="date" content="2018-04-19"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StreamingRecognitionConfigOrBuilder (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfig.Builder.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionResult.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfigOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="StreamingRecognitionConfigOrBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.google.cloud.speech.v1p1beta1</div> |
| <h2 title="Interface StreamingRecognitionConfigOrBuilder" class="title">Interface StreamingRecognitionConfigOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfig.html" title="class in com.google.cloud.speech.v1p1beta1">StreamingRecognitionConfig</a>, <a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfig.Builder.html" title="class in com.google.cloud.speech.v1p1beta1">StreamingRecognitionConfig.Builder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">StreamingRecognitionConfigOrBuilder</span> |
| extends <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.html" title="class in com.google.cloud.speech.v1p1beta1">RecognitionConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfigOrBuilder.html#getConfig--">getConfig</a></span>()</code> |
| <div class="block"> |
| *Required* Provides information to the recognizer that specifies how to |
| process the request.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">RecognitionConfigOrBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfigOrBuilder.html#getConfigOrBuilder--">getConfigOrBuilder</a></span>()</code> |
| <div class="block"> |
| *Required* Provides information to the recognizer that specifies how to |
| process the request.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfigOrBuilder.html#getInterimResults--">getInterimResults</a></span>()</code> |
| <div class="block"> |
| *Optional* If `true`, interim results (tentative hypotheses) may be |
| returned as they become available (these interim results are indicated with |
| the `is_final=false` flag).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfigOrBuilder.html#getSingleUtterance--">getSingleUtterance</a></span>()</code> |
| <div class="block"> |
| *Optional* If `false` or omitted, the recognizer will perform continuous |
| recognition (continuing to wait for and process audio even if the user |
| pauses speaking) until the client closes the input stream (gRPC API) or |
| until the maximum time limit has been reached.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfigOrBuilder.html#hasConfig--">hasConfig</a></span>()</code> |
| <div class="block"> |
| *Required* Provides information to the recognizer that specifies how to |
| process the request.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf">findInitializationErrors</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf">getAllFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf">getDefaultInstanceForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf">getInitializationErrorString</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">getOneofFieldDescriptor</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf">getRepeatedField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getRepeatedFieldCount</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf">getUnknownFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">hasField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">hasOneof</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf">isInitialized</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="hasConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasConfig</h4> |
| <pre>boolean hasConfig()</pre> |
| <div class="block"><pre> |
| *Required* Provides information to the recognizer that specifies how to |
| process the request. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionConfig config = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getConfig--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfig</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfig.html" title="class in com.google.cloud.speech.v1p1beta1">RecognitionConfig</a> getConfig()</pre> |
| <div class="block"><pre> |
| *Required* Provides information to the recognizer that specifies how to |
| process the request. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionConfig config = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getConfigOrBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigOrBuilder</h4> |
| <pre><a href="../../../../../com/google/cloud/speech/v1p1beta1/RecognitionConfigOrBuilder.html" title="interface in com.google.cloud.speech.v1p1beta1">RecognitionConfigOrBuilder</a> getConfigOrBuilder()</pre> |
| <div class="block"><pre> |
| *Required* Provides information to the recognizer that specifies how to |
| process the request. |
| </pre> |
| |
| <code>.google.cloud.speech.v1p1beta1.RecognitionConfig config = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getSingleUtterance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSingleUtterance</h4> |
| <pre>boolean getSingleUtterance()</pre> |
| <div class="block"><pre> |
| *Optional* If `false` or omitted, the recognizer will perform continuous |
| recognition (continuing to wait for and process audio even if the user |
| pauses speaking) until the client closes the input stream (gRPC API) or |
| until the maximum time limit has been reached. May return multiple |
| `StreamingRecognitionResult`s with the `is_final` flag set to `true`. |
| If `true`, the recognizer will detect a single spoken utterance. When it |
| detects that the user has paused or stopped speaking, it will return an |
| `END_OF_SINGLE_UTTERANCE` event and cease recognition. It will return no |
| more than one `StreamingRecognitionResult` with the `is_final` flag set to |
| `true`. |
| </pre> |
| |
| <code>bool single_utterance = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getInterimResults--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInterimResults</h4> |
| <pre>boolean getInterimResults()</pre> |
| <div class="block"><pre> |
| *Optional* If `true`, interim results (tentative hypotheses) may be |
| returned as they become available (these interim results are indicated with |
| the `is_final=false` flag). |
| If `false` or omitted, only `is_final=true` result(s) are returned. |
| </pre> |
| |
| <code>bool interim_results = 3;</code></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfig.Builder.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../com/google/cloud/speech/v1p1beta1/StreamingRecognitionResult.html" title="class in com.google.cloud.speech.v1p1beta1"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?com/google/cloud/speech/v1p1beta1/StreamingRecognitionConfigOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="StreamingRecognitionConfigOrBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
