org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-08AA357E-7499-4A8E-B756-4FCDFBEDB9FC.html
<!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" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="startvibra()"/><meta name="DC.Relation" scheme="URI" content="GUID-236F8C40-96D8-4408-97A7-CAA7E0B1FE46"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-1A678A11-0BDD-4F64-9F40-013F6CDB81D7"/><meta name="DC.Relation" scheme="URI" content="GUID-6B348161-2ED2-498E-A166-C3B28C58BC68"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-08AA357E-7499-4A8E-B756-4FCDFBEDB9FC"/><title>startvibra() </title><script type="text/javascript">
function initPage() {}
</script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-08AA357E-7499-4A8E-B756-4FCDFBEDB9FC">startvibra()</h1><div>
<p><strong>Syntax:</strong></p>
<pre class="codeblock" id="GUID-020E888D-0B68-4868-B6EE-0DACB8C61176">[void] sysinfo.startvibra(Int duration, Int intensity)</pre>
<p><strong>Description:</strong></p>
<p>The <code>startvibra</code> method turns the device vibration on for the specified duration with the specified intensity (frequency).</p>
<p><strong>Argument:</strong></p>
<ul>
<li><p><code>duration</code>:</p>
<p>Duration of the vibration measured in milliseconds. The value <code>0</code> specifies that the vibration should continue indefinitely or till the hardware-imposed limit, and should be stopped with a call to the <a href="GUID-236F8C40-96D8-4408-97A7-CAA7E0B1FE46.html#GUID-236F8C40-96D8-4408-97A7-CAA7E0B1FE46"><code>stopvibra</code></a> method.</p>
<p><code>duration</code> argument can have the maximum value of <a href="GUID-C1F8A945-7C9C-4E3B-8F54-B9AFC502482A.html#GUID-C1F8A945-7C9C-4E3B-8F54-B9AFC502482A"><code>vibramaxduration</code></a></p>
</li>
</ul>
<div class="note"><p><strong class="note_title">Note: </strong>A device may have implementation-defined or hardware-imposed limits to the duration of the vibration feature. In such circumstances, any vibration will stop at that limit even if the duration parameter is greater than the limit or specified as infinity.</p>
</div>
<ul>
<li><p><code>intensity</code>:</p>
<p>Intensity of the vibra is in the range of -100 to 100, which shows the percentage of the vibra motor's full rotation speed. When intensity is negative, the vibra motor rotates in the negative direction. When intensity is positive, the vibra motor rotates in the positive direction.</p>
</li>
</ul>
<div class="note"><p><strong class="note_title">Note: </strong>The device might have hardware-imposed limits on the supported vibra intensity values, so the actual effect might vary between different hardware.</p>
</div>
<p><strong>Return value:</strong></p>
<p>This method does not return a value.</p>
<p><strong>Remarks:</strong></p>
<p>If the vibration setting in the device's active profile is set to "off", <code>startvibra()</code> will not cause the vibration feature to vibrate. Use the <a href="GUID-B0F9DE3D-8F22-4976-8BE3-F7F40A90D6FC.html#GUID-B0F9DE3D-8F22-4976-8BE3-F7F40A90D6FC"><code>vibrasettings</code></a> property to detect whether vibration is allowed.</p>
<p><strong>Example code:</strong></p>
<pre class="codeblock" id="GUID-0B98EF08-0E63-4E62-B1C5-4A6569DB2638">function startVibration()
{
// get the system defined maximum duration
var duration = sysinfo.vibramaxduration;
// get the system defined minimum intensity
var intensity = sysinfo.vibraminintensity
// start vibration
sysinfo.startvibra(duration, intensity);
}</pre>
</div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>