<!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" xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta name="generator" content="JsDoc Toolkit" /> <title>JsDoc Reference - SIPml.Session.Configuration</title> <style type="text/css"> /* default.css */ body { font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; width: 800px; } .header { clear: both; background-color: #ccc; padding: 8px; } h1 { font-size: 150%; font-weight: bold; padding: 0; margin: 1em 0 0 .3em; } hr { border: none 0; border-top: 1px solid #7F8FB1; height: 1px; } pre.code { display: block; padding: 8px; border: 1px dashed #ccc; } #index { margin-top: 24px; float: left; width: 160px; position: absolute; left: 8px; background-color: #F3F3F3; padding: 8px; } #content { margin-left: 190px; width: 600px; } .classList { list-style-type: none; padding: 0; margin: 0 0 0 8px; font-family: arial, sans-serif; font-size: 1em; overflow: auto; } .classList li { padding: 0; margin: 0 0 8px 0; } .summaryTable { width: 100%; } h1.classTitle { font-size:170%; line-height:130%; } h2 { font-size: 110%; } caption, div.sectionTitle { background-color: #7F8FB1; color: #fff; font-size:130%; text-align: left; padding: 2px 6px 2px 6px; border: 1px #7F8FB1 solid; } div.sectionTitle { margin-bottom: 8px; } .summaryTable thead { display: none; } .summaryTable td { vertical-align: top; padding: 4px; border-bottom: 1px #7F8FB1 solid; border-right: 1px #7F8FB1 solid; } /*col#summaryAttributes {}*/ .summaryTable td.attributes { border-left: 1px #7F8FB1 solid; width: 140px; text-align: right; } td.attributes, .fixedFont { line-height: 15px; color: #002EBE; font-family: "Courier New",Courier,monospace; font-size: 13px; } .summaryTable td.nameDescription { text-align: left; font-size: 13px; line-height: 15px; } .summaryTable td.nameDescription, .description { line-height: 15px; padding: 4px; padding-left: 4px; } .summaryTable { margin-bottom: 8px; } ul.inheritsList { list-style: square; margin-left: 20px; padding-left: 0; } .detailList { margin-left: 20px; line-height: 15px; } .detailList dt { margin-left: 20px; } .detailList .heading { font-weight: bold; padding-bottom: 6px; margin-left: 0; } .light, td.attributes, .light a:link, .light a:visited { color: #777; font-style: italic; } .fineprint { text-align: right; font-size: 10px; } </style> </head> <body> <!-- ============================== header ================================= --> <!-- begin static/header.html --> <div id="header"> </div> <!-- end static/header.html --> <!-- ============================== classes index ============================ --> <div id="index"> <!-- begin publish.classesIndex --> <div align="center"><a href="../index.html">Class Index</a> | <a href="../files.html">File Index</a></div> <hr /> <h2>Classes</h2> <ul class="classList"> <li><i><a href="../symbols/_global_.html">_global_</a></i></li> <li><a href="../symbols/SIPml.html">SIPml</a></li> <li><a href="../symbols/SIPml.Event.html">SIPml.Event</a></li> <li><a href="../symbols/SIPml.EventTarget.html">SIPml.EventTarget</a></li> <li><a href="../symbols/SIPml.Session.html">SIPml.Session</a></li> <li><a href="../symbols/SIPml.Session.Call.html">SIPml.Session.Call</a></li> <li><a href="../symbols/SIPml.Session.Configuration.html">SIPml.Session.Configuration</a></li> <li><a href="../symbols/SIPml.Session.Event.html">SIPml.Session.Event</a></li> <li><a href="../symbols/SIPml.Session.Message.html">SIPml.Session.Message</a></li> <li><a href="../symbols/SIPml.Session.Publish.html">SIPml.Session.Publish</a></li> <li><a href="../symbols/SIPml.Session.Registration.html">SIPml.Session.Registration</a></li> <li><a href="../symbols/SIPml.Session.Subscribe.html">SIPml.Session.Subscribe</a></li> <li><a href="../symbols/SIPml.Stack.html">SIPml.Stack</a></li> <li><a href="../symbols/SIPml.Stack.Configuration.html">SIPml.Stack.Configuration</a></li> <li><a href="../symbols/SIPml.Stack.Event.html">SIPml.Stack.Event</a></li> </ul> <hr /> <!-- end publish.classesIndex --> </div> <div id="content"> <!-- ============================== class title ============================ --> <h1 class="classTitle"> AnonymousClass SIPml.Session.Configuration </h1> <!-- ============================== class summary ========================== --> <p class="description"> SIPml.Session.Configuration <br /><i>Defined in: </i> <a href="../symbols/src/SIPml.js.html">SIPml.js</a>. </p> <!-- ============================== constructor summary ==================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class SIPml.Session.Configuration."> <caption>AnonymousClass Summary</caption> <thead> <tr> <th scope="col">Constructor Attributes</th> <th scope="col">Constructor Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription" > <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#constructor">SIPml.Session.Configuration</a></b> </div> <div class="description">Anonymous SIP Session configuration object.</div> </td> </tr> </tbody> </table> <!-- ============================== properties summary ===================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class SIPml.Session.Configuration."> <caption>Field Summary</caption> <thead> <tr> <th scope="col">Field Attributes</th> <th scope="col">Field Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#audio_remote">audio_remote</a></b> </div> <div class="description"><a href="https://developer.mozilla.org/en-US/docs/DOM/HTMLAudioElement">HTMLAudioElement<a> used to playback the remote audio stream.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#bandwidth">bandwidth</a></b> </div> <div class="description">Defines the maximum audio and video bandwidth to use.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#expires">expires</a></b> </div> <div class="description">Session timeout in seconds.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#from">from</a></b> </div> <div class="description">Set the source uri string to be used in the <i>From</i> header (available since API version 1.2.170).</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#sip_caps">sip_caps</a></b> </div> <div class="description"><i>{name,value}</i> pairs defining the SIP capabilities associated to this session.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#sip_headers">sip_headers</a></b> </div> <div class="description"><i>{name,value,session}</i> trios defining the SIP headers associated to this session.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#video_local">video_local</a></b> </div> <div class="description"><a href="https://developer.mozilla.org/en-US/docs/DOM/HTMLVideoElement">HTMLVideoElement<a> where to display the local video preview.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#video_remote">video_remote</a></b> </div> <div class="description"><a href="https://developer.mozilla.org/en-US/docs/DOM/HTMLVideoElement">HTMLVideoElement<a> where to display the remote video stream.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/SIPml.Session.Configuration.html#video_size">video_size</a></b> </div> <div class="description">Defines the maximum and minimum video size to be used.</div> </td> </tr> </tbody> </table> <!-- ============================== methods summary ======================== --> <!-- ============================== events summary ======================== --> <!-- ============================== constructor details ==================== --> <div class="details"><a name="constructor"> </a> <div class="sectionTitle"> AnonymousClass Detail </div> <div class="fixedFont"> <b>SIPml.Session.Configuration</b> </div> <div class="description"> Anonymous SIP Session configuration object. </div> <pre class="code"> var configuration = { expires: 200, audio_remote: document.getElementById('audio_remote'), // <audio id="audio_remote" .../> video_local: document.getElementById('video_local'), // <video id="video_local" .../> video_remote: document.getElementById('video_remote'), // <video id="video_remote" .../> sip_caps: [ {name: '+g.oma.sip-im'}, {name: '+sip.ice'}, {name: 'language', value: '\"en,fr\"'} ], sip_headers: [ {name: 'What', value: 'Audio/Video call', session: false}, {name: 'Organization', value: 'Doubango Telecom', session: false} ] }</pre> </div> <!-- ============================== field details ========================== --> <div class="sectionTitle"> Field Detail </div> <a name="audio_remote"> </a> <div class="fixedFont"> <span class="light">{HTMLAudioElement}</span> <b>audio_remote</b> </div> <div class="description"> <a href="https://developer.mozilla.org/en-US/docs/DOM/HTMLAudioElement">HTMLAudioElement<a> used to playback the remote audio stream. This propety should be only used for <a href="SIPml.Session.Call.html">audio sessions</a>. </div> <hr /> <a name="bandwidth"> </a> <div class="fixedFont"> <span class="light">{Object}</span> <b>bandwidth</b> </div> <div class="description"> Defines the maximum audio and video bandwidth to use. This will change the outhoing SDP to include a "b:AS=" attribute. Use <i>0</i> to let the browser negotiates the right value using RTCP-REMB and congestion control. A default value for all sessions could be defined at stack level.<br /> <i>Available since version 1.3.203</i>. <br /> Example: <i>{ audio:64, video:512 }</i> </div> <hr /> <a name="expires"> </a> <div class="fixedFont"> <span class="light">{Integer}</span> <b>expires</b> </div> <div class="description"> Session timeout in seconds. </div> <hr /> <a name="from"> </a> <div class="fixedFont"> <span class="light">{String}</span> <b>from</b> </div> <div class="description"> Set the source uri string to be used in the <i>From</i> header (available since API version 1.2.170). </div> <hr /> <a name="sip_caps"> </a> <div class="fixedFont"> <span class="light">{Array}</span> <b>sip_caps</b> </div> <div class="description"> <i>{name,value}</i> pairs defining the SIP capabilities associated to this session. The capabilities are added to the Contact header. Please refer to <a href="http://tools.ietf.org/html/rfc3840">rfc3840</a> and <a href="http://tools.ietf.org/html/rfc3841">rfc3841</a> for more information. </div> <hr /> <a name="sip_headers"> </a> <div class="fixedFont"> <span class="light">{Array}</span> <b>sip_headers</b> </div> <div class="description"> <i>{name,value,session}</i> trios defining the SIP headers associated to this session. <i>session</i> is a boolean defining whether the header have to be added to all outgoing request or not (initial only). </div> <hr /> <a name="video_local"> </a> <div class="fixedFont"> <span class="light">{HTMLVideoElement}</span> <b>video_local</b> </div> <div class="description"> <a href="https://developer.mozilla.org/en-US/docs/DOM/HTMLVideoElement">HTMLVideoElement<a> where to display the local video preview. This propety should be only used for <a href="SIPml.Session.Call.html">video sessions</a>. </div> <hr /> <a name="video_remote"> </a> <div class="fixedFont"> <span class="light">{HTMLVideoElement}</span> <b>video_remote</b> </div> <div class="description"> <a href="https://developer.mozilla.org/en-US/docs/DOM/HTMLVideoElement">HTMLVideoElement<a> where to display the remote video stream. This propety should be only used for <a href="SIPml.Session.Call.html">video sessions</a>. </div> <hr /> <a name="video_size"> </a> <div class="fixedFont"> <span class="light">{Object}</span> <b>video_size</b> </div> <div class="description"> Defines the maximum and minimum video size to be used. All values are optional. The browser will try to find the best video size between <i>max</i> and <i>min</i> based on the camera capabilities. A default value for all sessions could be defined at stack level.<br /> <i>Available since version 1.3.203</i>. <br /> Example: <i>{ minWidth:640, minHeight:480, maxWidth:1920, maxHeight:1080 }</i> </div> <!-- ============================== method details ========================= --> <!-- ============================== event details ========================= --> <hr /> </div> <!-- ============================== footer ================================= --> <div class="fineprint" style="clear:both"> Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Wed Sep 25 2013 03:40:14 GMT+0200 (CEST) </div> </body> </html>