179 lines
13 KiB
HTML
179 lines
13 KiB
HTML
<!-- HTML header for doxygen 1.8.8-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<!-- For Mobile Devices -->
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta name="generator" content="Doxygen 1.8.12"/>
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<title>audio-ess: ewol sound set: Tutoral: use sound-set</title>
|
|
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
|
|
<script type="text/javascript" src="doxy-boot.js"></script>
|
|
</head>
|
|
<body>
|
|
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<a class="navbar-brand">audio-ess: ewol sound set 0.4.0</a>
|
|
</div>
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li><a href="index.html">Main Page</a></li>
|
|
<li><a href="pages.html">Related Pages</a></li>
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
</ul>
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
|
|
Link-libs<span class="caret"></span>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
|
|
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
|
|
<li><a href="http://atria-soft.github.io/echrono">echrono</a></li>
|
|
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
|
|
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
|
|
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
|
|
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
|
|
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
|
|
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
|
|
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
|
|
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
|
|
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
|
|
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
|
|
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
|
|
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
|
|
<li><a href="http://atria-soft.github.io/etranslate">etranslate</a></li>
|
|
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-ess">audio-ess</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div id="search-box" class="input-group">
|
|
<div class="input-group-btn">
|
|
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
|
|
<span class="glyphicon glyphicon-search"></span>
|
|
<span class="caret"></span>
|
|
</button>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">All</a></li>
|
|
<li><a href="#">Classes</a></li>
|
|
<li><a href="#">Namespaces</a></li>
|
|
<li><a href="#">Files</a></li>
|
|
<li><a href="#">Functions</a></li>
|
|
<li><a href="#">Variables</a></li>
|
|
<li><a href="#">Typedefs</a></li>
|
|
<li><a href="#">Enumerations</a></li>
|
|
<li><a href="#">Enumerator</a></li>
|
|
<li><a href="#">Friends</a></li>
|
|
<li><a href="#">Macros</a></li>
|
|
<li><a href="#">Pages</a></li>
|
|
</ul>
|
|
</div>
|
|
<button id="search-close" type="button" class="close" aria-label="Close">
|
|
<span aria-hidden="true"></span>
|
|
</button>
|
|
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
|
|
</div>
|
|
</div><!--/.nav-collapse -->
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="content" id="content">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
|
|
<div style="margin-bottom: 15px;margin-top: 60px;">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.12 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Tutoral: use sound-set </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="toc"><h3>Table of Contents</h3>
|
|
<ul><li class="level1"><a href="#audio_ess_tuto_objectif">Objectifs: </a></li>
|
|
<li class="level1"><a href="#audio_ess_tuto_config_file">Create a configuration file </a></li>
|
|
<li class="level1"><a href="#audio_ess_tuto_include">what you need to do first: </a></li>
|
|
<li class="level1"><a href="#audio_ess_tuto_play_music">Play a background music: </a></li>
|
|
<li class="level1"><a href="#audio_ess_tuto_play_effect">Play an effect: </a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="textblock"><h1><a class="anchor" id="audio_ess_tuto_objectif"></a>
|
|
Objectifs: </h1>
|
|
<ul>
|
|
<li>Understand config file</li>
|
|
<li>Create a simple playing sounds</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="audio_ess_tuto_config_file"></a>
|
|
Create a configuration file </h1>
|
|
<p>configuration file is really simple: </p><div class="fragment"><div class="line">soundSet.json</div></div><!-- fragment --><p> it contain 2 mains object:</p><ul>
|
|
<li><b>musics:</b> That containig the list of all music files</li>
|
|
<li><b>effects:</b> That contain all effects files</li>
|
|
</ul>
|
|
<p>A simple example: </p><div class="fragment"><div class="line">{</div><div class="line"> musics:{</div><div class="line"> "BG-1":"DATA:audio/Clean Soul.ogg"</div><div class="line"> "BG-22":"DATA:audio/Dark knight.ogg"</div><div class="line"> },</div><div class="line"> effects:{</div><div class="line"> "end":"DATA:audio/end.wav",</div><div class="line"> "error":"DATA:audio/error.wav",</div><div class="line"> "levelup":"DATA:audio/levelup.wav",</div><div class="line"> "ok":"DATA:audio/ok.wav"</div><div class="line"> }</div><div class="line">}</div></div><!-- fragment --><h1><a class="anchor" id="audio_ess_tuto_include"></a>
|
|
what you need to do first: </h1>
|
|
<p>Include and basic init: </p><div class="fragment"><div class="line"><span class="preprocessor">#include <audio/ess/ess.hpp></span></div><div class="line"></div><div class="line"><span class="comment">//in the main application:</span></div><div class="line"><span class="keywordtype">int</span> main(...) {</div><div class="line"> audio::ess::init();</div><div class="line"> <span class="comment">/*</span></div><div class="line"><span class="comment"> * Do your stuff</span></div><div class="line"><span class="comment"> */</span></div><div class="line"> audio::ess::unInit();</div><div class="line"> <span class="keywordflow">return</span> 0;</div><div class="line">}</div></div><!-- fragment --><p>Select your sound set file: </p><div class="fragment"><div class="line">audio::ess::soundSetLoad(<span class="stringliteral">"DATA:soundSet.json"</span>);</div></div><!-- fragment --><h1><a class="anchor" id="audio_ess_tuto_play_music"></a>
|
|
Play a background music: </h1>
|
|
<p>Start playing: </p><div class="fragment"><div class="line">audio::ess::musicPlay(<span class="stringliteral">"BG-22"</span>);</div></div><!-- fragment --><p>Stop playing: </p><div class="fragment"><div class="line">audio::ess::musicStop();</div></div><!-- fragment --><p>Change volume: (reduce at -5dB) </p><div class="fragment"><div class="line">audio::ess::musicSetVolume(-5.0f);</div></div><!-- fragment --><h1><a class="anchor" id="audio_ess_tuto_play_effect"></a>
|
|
Play an effect: </h1>
|
|
<p>Start playing: </p><div class="fragment"><div class="line">audio::ess::effectPlay(<span class="stringliteral">"error"</span>);</div><div class="line">sleep(1);</div><div class="line">audio::ess::effectPlay(<span class="stringliteral">"levelup"</span>);</div></div><!-- fragment --><p>or (faster way): </p><div class="fragment"><div class="line">int32_t effectId = audio::ess::effectGetId(<span class="stringliteral">"error"</span>);</div><div class="line">audio::ess::effectPlay(effectId);</div></div><!-- fragment --><p> <b>Note:</b> An effect can not stopped ...</p>
|
|
<p>Change volume: (reduce at -5dB) </p><div class="fragment"><div class="line">audio::ess::effectSetVolume(-5.0f);</div></div><!-- fragment --> </div></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.8-->
|
|
<!-- start footer part -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Oct 24 2016 15:35:48 for audio-ess: ewol sound set by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.12
|
|
</small></address>
|
|
</body>
|
|
</html>
|