space-wizards/RobustToolbox
1
0
Fork 0
mirror of https://github.com/space-wizards/RobustToolbox.git synced 2026-02-14 19:29:36 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
b5e5a808cc98e42910d1f71836d19c73be4e8417
RobustToolbox/api/Robust.Client/Robust.Client.Audio.Midi.IMidiRenderer.html
Silvertorch5 b5e5a808cc Deploy to GitHub Pages
2023-10-08 00:45:13 +00:00

1197 lines
64 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IMidiRenderer
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IMidiRenderer
">
<meta name="generator" content="docfx 2.56.7.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Robust.Client.Audio.Midi.IMidiRenderer">
<h1 id="Robust_Client_Audio_Midi_IMidiRenderer" data-uid="Robust.Client.Audio.Midi.IMidiRenderer" class="text-break">Interface IMidiRenderer
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Robust.Client.Audio.Midi.html">Robust.Client.Audio.Midi</a></h6>
<h6><strong>Assembly</strong>: Robust.Client.dll</h6>
<h5 id="Robust_Client_Audio_Midi_IMidiRenderer_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IMidiRenderer : IDisposable</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_DisablePercussionChannel.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.DisablePercussionChannel%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L72">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_DisablePercussionChannel_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.DisablePercussionChannel*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_DisablePercussionChannel" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.DisablePercussionChannel">DisablePercussionChannel</h4>
<div class="markdown level1 summary"><p>Whether to drop messages on the percussion channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool DisablePercussionChannel { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_DisableProgramChangeEvent.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.DisableProgramChangeEvent%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L77">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_DisableProgramChangeEvent_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.DisableProgramChangeEvent*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_DisableProgramChangeEvent" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.DisableProgramChangeEvent">DisableProgramChangeEvent</h4>
<div class="markdown level1 summary"><p>Whether to drop messages for program change events.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool DisableProgramChangeEvent { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_Disposed.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.Disposed%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L28">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_Disposed_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Disposed*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_Disposed" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Disposed">Disposed</h4>
<div class="markdown level1 summary"><p>Whether this renderer has been disposed or not.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool Disposed { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_FilteredChannels.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.FilteredChannels%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L113">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_FilteredChannels_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.FilteredChannels*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_FilteredChannels" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.FilteredChannels">FilteredChannels</h4>
<div class="markdown level1 summary"><p>Allows you to filter out note events from certain channels.
Only NoteOn will be filtered.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">BitArray FilteredChannels { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">BitArray</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_LoopMidi.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.LoopMidi%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L33">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_LoopMidi_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.LoopMidi*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_LoopMidi" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.LoopMidi">LoopMidi</h4>
<div class="markdown level1 summary"><p>This controls whether the midi file being played will loop or not.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool LoopMidi { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_Master.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.Master%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L103">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_Master_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Master*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_Master" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Master">Master</h4>
<div class="markdown level1 summary"><p>Whether this renderer will subscribe to another and copy its events.
See <a class="xref" href="Robust.Client.Audio.Midi.IMidiRenderer.html#Robust_Client_Audio_Midi_IMidiRenderer_FilteredChannels">FilteredChannels</a> to filter specific channels.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IMidiRenderer Master { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Robust.Client.Audio.Midi.IMidiRenderer.html">IMidiRenderer</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_MidiBank.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.MidiBank%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L49">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_MidiBank_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.MidiBank*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_MidiBank" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.MidiBank">MidiBank</h4>
<div class="markdown level1 summary"><p>The instrument bank the renderer is using.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">byte MidiBank { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_MidiProgram.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.MidiProgram%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L44">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_MidiProgram_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.MidiProgram*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_MidiProgram" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.MidiProgram">MidiProgram</h4>
<div class="markdown level1 summary"><p>The midi program (instrument) the renderer is using.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">byte MidiProgram { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Byte</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_MidiSoundfont.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.MidiSoundfont%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L54">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_MidiSoundfont_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.MidiSoundfont*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_MidiSoundfont" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.MidiSoundfont">MidiSoundfont</h4>
<div class="markdown level1 summary"><p>The soundfont currently selected by the renderer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">uint MidiSoundfont { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_Mono.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.Mono%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L67">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_Mono_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Mono*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_Mono" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Mono">Mono</h4>
<div class="markdown level1 summary"><p>Whether the sound will play in stereo or mono.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool Mono { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_PlayerTick.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.PlayerTick%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L87">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_PlayerTick_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.PlayerTick*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_PlayerTick" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.PlayerTick">PlayerTick</h4>
<div class="markdown level1 summary"><p>Gets or sets (seeks) the current tick of the MIDI player.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int PlayerTick { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_PlayerTotalTick.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.PlayerTotalTick%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L82">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_PlayerTotalTick_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.PlayerTotalTick*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_PlayerTotalTick" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.PlayerTotalTick">PlayerTotalTick</h4>
<div class="markdown level1 summary"><p>Gets the total number of ticks possible for the MIDI player.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int PlayerTotalTick { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_RendererState.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.RendererState%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L189">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_RendererState_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.RendererState*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_RendererState" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.RendererState">RendererState</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">MidiRendererState RendererState { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Robust.Client.Audio.Midi.MidiRendererState.html">MidiRendererState</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_SequencerTick.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.SequencerTick%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L92">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_SequencerTick_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SequencerTick*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_SequencerTick" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SequencerTick">SequencerTick</h4>
<div class="markdown level1 summary"><p>Gets the current tick of the sequencer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">uint SequencerTick { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_SequencerTimeScale.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.SequencerTimeScale%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L97">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_SequencerTimeScale_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SequencerTimeScale*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_SequencerTimeScale" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SequencerTimeScale">SequencerTimeScale</h4>
<div class="markdown level1 summary"><p>Gets the Time Scale of the sequencer in ticks per second. Default is 1000 for 1 tick per millisecond.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">double SequencerTimeScale { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Double</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_Status.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.Status%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L62">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_Status_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Status*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_Status" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.Status">Status</h4>
<div class="markdown level1 summary"><p>The current status of the renderer.
&quot;None&quot; if the renderer isn't playing from input or a midi file.
&quot;Input&quot; if the renderer is playing from midi input.
&quot;File&quot; if the renderer is playing from a midi file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">MidiRendererStatus Status { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Robust.Client.Audio.Midi.MidiRendererStatus.html">MidiRendererStatus</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_TrackingCoordinates.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.TrackingCoordinates%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L187">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_TrackingCoordinates_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.TrackingCoordinates*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_TrackingCoordinates" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.TrackingCoordinates">TrackingCoordinates</h4>
<div class="markdown level1 summary"><p>The position that will be used for positional audio.
This is only used if <a class="xref" href="Robust.Client.Audio.Midi.IMidiRenderer.html#Robust_Client_Audio_Midi_IMidiRenderer_Mono">Mono</a> is set to True
and <a class="xref" href="Robust.Client.Audio.Midi.IMidiRenderer.html#Robust_Client_Audio_Midi_IMidiRenderer_TrackingEntity">TrackingEntity</a> is null.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">MapCoordinates? TrackingCoordinates { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="../Robust.Shared/Robust.Shared.Map.MapCoordinates.html">MapCoordinates</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_TrackingEntity.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.TrackingEntity%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L180">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_TrackingEntity_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.TrackingEntity*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_TrackingEntity" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.TrackingEntity">TrackingEntity</h4>
<div class="markdown level1 summary"><p>The entity whose position will be used for positional audio.
This is only used if <a class="xref" href="Robust.Client.Audio.Midi.IMidiRenderer.html#Robust_Client_Audio_Midi_IMidiRenderer_Mono">Mono</a> is set to True.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">EntityUid? TrackingEntity { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="../Robust.Shared/Robust.Shared.GameObjects.EntityUid.html">EntityUid</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_VelocityOverride.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.VelocityOverride%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L118">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_VelocityOverride_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.VelocityOverride*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_VelocityOverride" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.VelocityOverride">VelocityOverride</h4>
<div class="markdown level1 summary"><p>Allows you to override all NoteOn velocities. Set to null to disable.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">byte? VelocityOverride { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Byte</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_VolumeBoost.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.VolumeBoost%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L38">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_VolumeBoost_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.VolumeBoost*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_VolumeBoost" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.VolumeBoost">VolumeBoost</h4>
<div class="markdown level1 summary"><p>This increases all note on velocities to 127.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool VolumeBoost { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_ApplyState_Robust_Client_Audio_Midi_MidiRendererState_System_Boolean_.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.ApplyState(Robust.Client.Audio.Midi.MidiRendererState%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L209">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_ApplyState_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.ApplyState*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_ApplyState_Robust_Client_Audio_Midi_MidiRendererState_System_Boolean_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.ApplyState(Robust.Client.Audio.Midi.MidiRendererState,System.Boolean)">ApplyState(MidiRendererState, Boolean)</h4>
<div class="markdown level1 summary"><p>Apply a certain state to the renderer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void ApplyState(MidiRendererState state, bool filterChannels = false)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Robust.Client.Audio.Midi.MidiRendererState.html">MidiRendererState</a></td>
<td><span class="parametername">state</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">filterChannels</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_ClearAllEvents.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.ClearAllEvents%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L154">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_ClearAllEvents_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.ClearAllEvents*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_ClearAllEvents" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.ClearAllEvents">ClearAllEvents()</h4>
<div class="markdown level1 summary"><p>Clears all scheduled events.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void ClearAllEvents()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_CloseInput.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.CloseInput%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L134">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_CloseInput_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.CloseInput*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_CloseInput" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.CloseInput">CloseInput()</h4>
<div class="markdown level1 summary"><p>Stops listening for midi input.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool CloseInput()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_CloseMidi.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.CloseMidi%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L139">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_CloseMidi_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.CloseMidi*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_CloseMidi" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.CloseMidi">CloseMidi()</h4>
<div class="markdown level1 summary"><p>Stops playing midi files.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool CloseMidi()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_LoadSoundfont_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.LoadSoundfont(System.String%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L164">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_LoadSoundfont_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.LoadSoundfont*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_LoadSoundfont_System_String_System_Boolean_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.LoadSoundfont(System.String,System.Boolean)">LoadSoundfont(String, Boolean)</h4>
<div class="markdown level1 summary"><p>Loads a new soundfont into the renderer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void LoadSoundfont(string filename, bool resetPresets = false)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">filename</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">resetPresets</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_OpenInput.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.OpenInput%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L123">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_OpenInput_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.OpenInput*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_OpenInput" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.OpenInput">OpenInput()</h4>
<div class="markdown level1 summary"><p>Start listening for midi input.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool OpenInput()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_OpenMidi_ReadOnlySpan_System_Byte__.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.OpenMidi(ReadOnlySpan%7BSystem.Byte%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L129">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_OpenMidi_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.OpenMidi*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_OpenMidi_ReadOnlySpan_System_Byte__" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.OpenMidi(ReadOnlySpan{System.Byte})">OpenMidi(ReadOnlySpan&lt;Byte&gt;)</h4>
<div class="markdown level1 summary"><p>Start playing a midi file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool OpenMidi(ReadOnlySpan&lt;byte&gt; buffer)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">ReadOnlySpan</span>&lt;<span class="xref">System.Byte</span>&gt;</td>
<td><span class="parametername">buffer</span></td>
<td><p>Bytes of the midi file</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_ScheduleMidiEvent_Robust_Shared_Audio_Midi_RobustMidiEvent_System_UInt32_System_Boolean_.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.ScheduleMidiEvent(Robust.Shared.Audio.Midi.RobustMidiEvent%2CSystem.UInt32%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L204">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_ScheduleMidiEvent_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.ScheduleMidiEvent*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_ScheduleMidiEvent_Robust_Shared_Audio_Midi_RobustMidiEvent_System_UInt32_System_Boolean_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.ScheduleMidiEvent(Robust.Shared.Audio.Midi.RobustMidiEvent,System.UInt32,System.Boolean)">ScheduleMidiEvent(RobustMidiEvent, UInt32, Boolean)</h4>
<div class="markdown level1 summary"><p>Schedule a MIDI event to be played at a later time.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void ScheduleMidiEvent(RobustMidiEvent midiEvent, uint time, bool absolute)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.Midi.RobustMidiEvent.html">RobustMidiEvent</a></td>
<td><span class="parametername">midiEvent</span></td>
<td><p>the midi event in question</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">time</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">absolute</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_SendMidiEvent_Robust_Shared_Audio_Midi_RobustMidiEvent_System_Boolean_.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.SendMidiEvent(Robust.Shared.Audio.Midi.RobustMidiEvent%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L196">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_SendMidiEvent_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SendMidiEvent*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_SendMidiEvent_Robust_Shared_Audio_Midi_RobustMidiEvent_System_Boolean_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SendMidiEvent(Robust.Shared.Audio.Midi.RobustMidiEvent,System.Boolean)">SendMidiEvent(RobustMidiEvent, Boolean)</h4>
<div class="markdown level1 summary"><p>Send a midi event for the renderer to play.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void SendMidiEvent(RobustMidiEvent midiEvent, bool raiseEvent = true)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="../Robust.Shared/Robust.Shared.Audio.Midi.RobustMidiEvent.html">RobustMidiEvent</a></td>
<td><span class="parametername">midiEvent</span></td>
<td><p>The midi event to be played</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">raiseEvent</span></td>
<td><p>Whether to raise an event for this event.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_StopAllNotes.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.StopAllNotes%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L144">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_StopAllNotes_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.StopAllNotes*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_StopAllNotes" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.StopAllNotes">StopAllNotes()</h4>
<div class="markdown level1 summary"><p>Stops all notes being played currently.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void StopAllNotes()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_SystemReset.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.SystemReset%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L149">View Source</a>
</span>
<a id="Robust_Client_Audio_Midi_IMidiRenderer_SystemReset_" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SystemReset*"></a>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_SystemReset" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.SystemReset">SystemReset()</h4>
<div class="markdown level1 summary"><p>Reset renderer back to a clean state.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void SystemReset()</code></pre>
</div>
<h3 id="events">Events
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_OnMidiEvent.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.OnMidiEvent%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L169">View Source</a>
</span>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_OnMidiEvent" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.OnMidiEvent">OnMidiEvent</h4>
<div class="markdown level1 summary"><p>Invoked whenever a new midi event is registered.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event Action&lt;RobustMidiEvent&gt; OnMidiEvent</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Action</span>&lt;<a class="xref" href="../Robust.Shared/Robust.Shared.Audio.Midi.RobustMidiEvent.html">RobustMidiEvent</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer_OnMidiPlayerFinished.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer.OnMidiPlayerFinished%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L174">View Source</a>
</span>
<h4 id="Robust_Client_Audio_Midi_IMidiRenderer_OnMidiPlayerFinished" data-uid="Robust.Client.Audio.Midi.IMidiRenderer.OnMidiPlayerFinished">OnMidiPlayerFinished</h4>
<div class="markdown level1 summary"><p>Invoked when the midi player finishes playing a song.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">event Action OnMidiPlayerFinished</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Action</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/space-wizards/RobustToolbox/new/master/apiSpec/new?filename=Robust_Client_Audio_Midi_IMidiRenderer.md&amp;value=---%0Auid%3A%20Robust.Client.Audio.Midi.IMidiRenderer%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/space-wizards/RobustToolbox/blob/master/Robust.Client/Audio/Midi/IMidiRenderer.cs/#L18" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<div class="toggle-mode">
<div class="icon">
<i aria-hidden="true">☀</i>
</div>
<label class="switch">
<input type="checkbox" id="switch-style">
<span class="slider round"></span>
</label>
<div class="icon">
<i aria-hidden="true">☾</i>
</div>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<div class="pull-left">
<span>Generated by <strong>DocFX</strong></span>
</div>
<div class="toggle-mode pull-right visible-sm visible-xs">
<div class="icon">
<i aria-hidden="true">☀</i>
</div>
<label class="switch">
<input type="checkbox" id="switch-style-m">
<span class="slider round"></span>
</label>
<div class="icon">
<i aria-hidden="true">☾</i>
</div>
</div>
</div>
</div>
<script type="text/javascript" src="../../styles/toggle-theme.js"></script>
</footer> </div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink