Skip to content

Commit

Permalink
Add 5.8.3 release docs. [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
twilio-sdk-build committed Oct 22, 2024
1 parent 77d3d9c commit 3f15969
Show file tree
Hide file tree
Showing 20 changed files with 1,567 additions and 2 deletions.
251 changes: 251 additions & 0 deletions docs/5.8.3/Classes/TVINoiseCancellationProcessor.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">

<title>TVINoiseCancellationProcessor Class Reference</title>

<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">

<h1 id="library-title">
<a href="../index.html">Twilio Audio Processors </a>
</h1>

<p id="developer-home">
<a href="../index.html">Twilio Inc.</a>
</p>

</div>
</header>

<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>

<li id="on-this-page" role="navigation">
<label>
On This Page

<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>

<select id="jump-to">
<option value="top">Jump To&#133;</option>

<option value="overview">Overview</option>




<option value="tasks">Tasks</option>





<optgroup label="Properties">

<option value="//api/name/enabled">enabled</option>

<option value="//api/name/pauseProcessing">pauseProcessing</option>

</optgroup>






</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>

<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">TVINoiseCancellationProcessor Class Reference</h1>


<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Inherits from</th>
<td>NSObject</td>
</tr><tr>
<th>Conforms to</th>
<td>TVIAudioDevice</td>
</tr><tr>
<th>Declared in</th>
<td>TVINoiseCancellationProcessor.h</td>
</tr>
</tbody></table></div>




<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p><code>TVINoiseCancellationProcessor</code> is an audio device that allows for background noise removal from the current audio source.</p>
</div>





<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>





<div class="task-list">
<div class="section-method">
<a name="//api/name/pauseProcessing" title="pauseProcessing"></a>
<h3 class="method-title"><code><a href="#//api/name/pauseProcessing">&nbsp;&nbsp;pauseProcessing</a></code>
</h3>

<div class="method-info">
<div class="pointy-thing"></div>

<div class="method-info-container">


<div class="method-subsection brief-description">
<p>Pause noise cancellation audio processing.</p>
</div>



<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL pauseProcessing</code></div>









<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>By default, the SDK initializes this property to NO. Setting it to YES disables the additional Twilio based underlying noise cancellation audio processing
while allowing audio to play from the current source including any audio processing the system may be providing, i.e. Voice Isolation mode in iOS 15.
Setting the property to NO enables the additional Twilio based noise cancellation audio processing on top of any system audio processing being used, i.e. Voice Isolation mode in iOS 15.</p>
</div>







<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">TVINoiseCancellationProcessor.h</code></p>
</div>


</div>
</div>
</div><div class="section-method">
<a name="//api/name/enabled" title="enabled"></a>
<h3 class="method-title"><code><a href="#//api/name/enabled">&nbsp;&nbsp;enabled</a></code>
</h3>

<div class="method-info">
<div class="pointy-thing"></div>

<div class="method-info-container">


<div class="method-subsection brief-description">
<p>Enable audio device</p>
</div>



<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, getter=isEnabled) BOOL enabled</code></div>









<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>By default, the SDK initializes this property to YES. Setting it to NO entirely disables the audio device. When the device is disabled, both audio capture and playback halt. This toggle should be used in CallKit delegate (CXProviderDelegate) methods (ex: didReset, didActivate, didDeactivate) to negotiate call holding and other events taking place from the iOS dialer</p>
</div>







<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">TVINoiseCancellationProcessor.h</code></p>
</div>


</div>
</div>
</div>
</div>

</div>






</main>

<footer>
<div class="footer-copyright">

<p class="copyright">Copyright &copy; 2024 Twilio Inc. All rights reserved. Updated: 2024-10-16</p>


<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>

</div>
</footer>
</div>
</div>
</article>

<script src="../js/script.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-2900316-33', 'auto');
ga('send', 'pageview');

</script>
</body>
</html>
17 changes: 17 additions & 0 deletions docs/5.8.3/css/scss/_index.scss
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.index-container {
-webkit-flex-direction: column;
flex-direction: column;

@media (min-width: $desktop-min-width) {
display: flex;
-webkit-flex-direction: row;
flex-direction: row;
-webkit-flex-wrap: wrap;
flex-wrap: wrap;
}

.index-column {
-webkit-flex: 1 1 33%;
flex: 1 1 33%;
}
}
Loading

0 comments on commit 3f15969

Please sign in to comment.