blob: cda14fe2098c4238bc1dc0251a77dbb9eb5762f1 [file] [log] [blame]
<!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:31 PDT 2018 -->
<title>StreamingRecognitionResultOrBuilder (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="StreamingRecognitionResultOrBuilder (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/v1beta1/StreamingRecognitionResult.Builder.html" title="class in com.google.cloud.speech.v1beta1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognizeRequest.html" title="class in com.google.cloud.speech.v1beta1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html" target="_top">Frames</a></li>
<li><a href="StreamingRecognitionResultOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.v1beta1</div>
<h2 title="Interface StreamingRecognitionResultOrBuilder" class="title">Interface StreamingRecognitionResultOrBuilder</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/v1beta1/StreamingRecognitionResult.html" title="class in com.google.cloud.speech.v1beta1">StreamingRecognitionResult</a>, <a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResult.Builder.html" title="class in com.google.cloud.speech.v1beta1">StreamingRecognitionResult.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">StreamingRecognitionResultOrBuilder</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/v1beta1/SpeechRecognitionAlternative.html" title="class in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternative</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html#getAlternatives-int-">getAlternatives</a></span>(int&nbsp;index)</code>
<div class="block">
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html#getAlternativesCount--">getAlternativesCount</a></span>()</code>
<div class="block">
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../com/google/cloud/speech/v1beta1/SpeechRecognitionAlternative.html" title="class in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternative</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html#getAlternativesList--">getAlternativesList</a></span>()</code>
<div class="block">
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/google/cloud/speech/v1beta1/SpeechRecognitionAlternativeOrBuilder.html" title="interface in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternativeOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html#getAlternativesOrBuilder-int-">getAlternativesOrBuilder</a></span>(int&nbsp;index)</code>
<div class="block">
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../../../com/google/cloud/speech/v1beta1/SpeechRecognitionAlternativeOrBuilder.html" title="interface in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternativeOrBuilder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html#getAlternativesOrBuilderList--">getAlternativesOrBuilderList</a></span>()</code>
<div class="block">
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html#getIsFinal--">getIsFinal</a></span>()</code>
<div class="block">
*Output-only* If `false`, this `StreamingRecognitionResult` represents an
interim result that may change.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html#getStability--">getStability</a></span>()</code>
<div class="block">
*Output-only* An estimate of the likelihood that the recognizer will not
change its guess about this interim result.</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&nbsp;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&nbsp;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="getAlternativesList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlternativesList</h4>
<pre>java.util.List&lt;<a href="../../../../../com/google/cloud/speech/v1beta1/SpeechRecognitionAlternative.html" title="class in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternative</a>&gt;&nbsp;getAlternativesList()</pre>
<div class="block"><pre>
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).
</pre>
<code>repeated .google.cloud.speech.v1beta1.SpeechRecognitionAlternative alternatives = 1;</code></div>
</li>
</ul>
<a name="getAlternatives-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlternatives</h4>
<pre><a href="../../../../../com/google/cloud/speech/v1beta1/SpeechRecognitionAlternative.html" title="class in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternative</a>&nbsp;getAlternatives(int&nbsp;index)</pre>
<div class="block"><pre>
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).
</pre>
<code>repeated .google.cloud.speech.v1beta1.SpeechRecognitionAlternative alternatives = 1;</code></div>
</li>
</ul>
<a name="getAlternativesCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlternativesCount</h4>
<pre>int&nbsp;getAlternativesCount()</pre>
<div class="block"><pre>
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).
</pre>
<code>repeated .google.cloud.speech.v1beta1.SpeechRecognitionAlternative alternatives = 1;</code></div>
</li>
</ul>
<a name="getAlternativesOrBuilderList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlternativesOrBuilderList</h4>
<pre>java.util.List&lt;? extends <a href="../../../../../com/google/cloud/speech/v1beta1/SpeechRecognitionAlternativeOrBuilder.html" title="interface in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternativeOrBuilder</a>&gt;&nbsp;getAlternativesOrBuilderList()</pre>
<div class="block"><pre>
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).
</pre>
<code>repeated .google.cloud.speech.v1beta1.SpeechRecognitionAlternative alternatives = 1;</code></div>
</li>
</ul>
<a name="getAlternativesOrBuilder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlternativesOrBuilder</h4>
<pre><a href="../../../../../com/google/cloud/speech/v1beta1/SpeechRecognitionAlternativeOrBuilder.html" title="interface in com.google.cloud.speech.v1beta1">SpeechRecognitionAlternativeOrBuilder</a>&nbsp;getAlternativesOrBuilder(int&nbsp;index)</pre>
<div class="block"><pre>
*Output-only* May contain one or more recognition hypotheses (up to the
maximum specified in `max_alternatives`).
</pre>
<code>repeated .google.cloud.speech.v1beta1.SpeechRecognitionAlternative alternatives = 1;</code></div>
</li>
</ul>
<a name="getIsFinal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIsFinal</h4>
<pre>boolean&nbsp;getIsFinal()</pre>
<div class="block"><pre>
*Output-only* If `false`, this `StreamingRecognitionResult` represents an
interim result that may change. If `true`, this is the final time the
speech service will return this particular `StreamingRecognitionResult`,
the recognizer will not return any further hypotheses for this portion of
the transcript and corresponding audio.
</pre>
<code>bool is_final = 2;</code></div>
</li>
</ul>
<a name="getStability--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStability</h4>
<pre>float&nbsp;getStability()</pre>
<div class="block"><pre>
*Output-only* An estimate of the likelihood that the recognizer will not
change its guess about this interim result. Values range from 0.0
(completely unstable) to 1.0 (completely stable).
This field is only provided for interim results (`is_final=false`).
The default of 0.0 is a sentinel value indicating `stability` was not set.
</pre>
<code>float stability = 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/v1beta1/StreamingRecognitionResult.Builder.html" title="class in com.google.cloud.speech.v1beta1"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/google/cloud/speech/v1beta1/StreamingRecognizeRequest.html" title="class in com.google.cloud.speech.v1beta1"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/cloud/speech/v1beta1/StreamingRecognitionResultOrBuilder.html" target="_top">Frames</a></li>
<li><a href="StreamingRecognitionResultOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>