| | | | |
| Offset 1, 77 lines modified | Offset 1, 675 lines modified |
| 1 | <?xml·version="1.0"·encoding="utf-8"?> | 1 | <?xml·version="1.0"·encoding="utf-8"?> |
| 2 | <!DOCTYPE·docs | 2 | <!DOCTYPE·docs |
| 3 | ··SYSTEM·'appdocsxml.dtd'> | 3 | ··SYSTEM·'appdocsxml.dtd'> |
| 4 | <?xml-stylesheet·type="text/xsl"·href="appdocsxml.xslt"?> | 4 | <?xml-stylesheet·type="text/xsl"·href="appdocsxml.xslt"?> |
| 5 | <docs·xmlns:xi="http://www.w3.org/2001/XInclude"> | 5 | <docs·xmlns:xi="http://www.w3.org/2001/XInclude"> |
| 6 | ··<module·language="en_US"·name="chan_skinny"> | 6 | ··<module·language="en_US"·name="dialplan_functions"> |
| 7 | ····<support_level>extended</support_level> | 7 | ····<support_level>core</support_level> |
| 8 | ····<deprecated_in>19</deprecated_in> | |
| 9 | ····<removed_in>21</removed_in> | |
| 10 | ··</module> | 8 | ··</module> |
| 11 | ··<manager·name="SKINNYdevices"·language="en_US"> | |
| 12 | ····<synopsis>List·SKINNY·devices·(text·format).</synopsis> | 9 | ··<function·name="PJSIP_DIAL_CONTACTS"·language="en_US"> |
| | 10 | ····<synopsis>Return·a·dial·string·for·dialing·all·contacts·on·an·AOR.</synopsis> |
| 13 | ····<syntax> | 11 | ····<syntax> |
| 14 | ······<xi:include·xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])"/> | 12 | ······<parameter·name="endpoint"·required="true"> |
| | 13 | ········<para>Name·of·the·endpoint</para> |
| | 14 | ······</parameter> |
| | 15 | ······<parameter·name="aor"·required="false"> |
| | 16 | ········<para>Name·of·an·AOR·to·use,·if·not·specified·the·configured·AORs·on·the·endpoint·are·used</para> |
| | 17 | ······</parameter> |
| | 18 | ······<parameter·name="request_user"·required="false"> |
| | 19 | ········<para>Optional·request·user·to·use·in·the·request·URI</para> |
| | 20 | ······</parameter> |
| 15 | ····</syntax> | 21 | ····</syntax> |
| 16 | ····<description> | 22 | ····<description> |
| | 23 | ······<para>Returns·a·properly·formatted·dial·string·for·dialing·all·contacts·on·an·AOR.</para> |
| 17 | ······<para>Lists·Skinny·devices·in·text·format·with·details·on·current·status. | |
| 18 | » » » Devicelist·will·follow·as·separate·events,·followed·by·a·final·event·called | |
| 19 | » » » DevicelistComplete.</para> | |
| 20 | ····</description> | 24 | ····</description> |
| 21 | ··</manager> | |
| 22 | ··<manager·name="SKINNYshowdevice"·language="en_US"> | |
| 23 | ····<synopsis>Show·SKINNY·device·(text·format).</synopsis> | 25 | ··</function> |
| | 26 | ··<function·name="PJSIP_MEDIA_OFFER"·language="en_US"> |
| | 27 | ····<synopsis>Media·and·codec·offerings·to·be·set·on·an·outbound·SIP·channel·prior·to·dialing.</synopsis> |
| 24 | ····<syntax> | 28 | ····<syntax> |
| 25 | ······<xi:include·xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])"/> | |
| 26 | ······<parameter·name="Device"·required="true"> | 29 | ······<parameter·name="media"·required="true"> |
| 27 | ········<para>The·device·name·you·want·to·check.</para> | 30 | ········<para>types·of·media·offered</para> |
| 28 | ······</parameter> | 31 | ······</parameter> |
| 29 | ····</syntax> | 32 | ····</syntax> |
| 30 | ····<description> | 33 | ····<description> |
| 31 | ······<para>Show·one·SKINNY·device·with·details·on·current·status.</para> | 34 | ······<para>When·read,·returns·the·codecs·offered·based·upon·the·media·choice.</para> |
| | 35 | ······<para> |
| | 36 | ········When·written,·sets·the·codecs·to·offer·when·an·outbound·dial·attempt·is·made, |
| | 37 | » » or·when·a·session·refresh·is·sent·using |
| | 38 | ········<replaceable>PJSIP_SEND_SESSION_REFRESH</replaceable> |
| | 39 | ········. |
| | 40 | ······</para> |
| 32 | ····</description> | 41 | ····</description> |
| 33 | ··</manager> | |
| 34 | ··<manager·name="SKINNYlines"·language="en_US"> | |
| 35 | ····<synopsis>List·SKINNY·lines·(text·format).</synopsis> | 42 | ····<see-also> |
| | 43 | ······<ref·type="function">PJSIP_SEND_SESSION_REFRESH</ref> |
| | 44 | ····</see-also> |
| | 45 | ··</function> |
| | 46 | ··<function·name="PJSIP_DTMF_MODE"·language="en_US"> |
| | 47 | ····<since> |
| | 48 | ······<version>13.18.0</version> |
| | 49 | ······<version>14.7.0</version> |
| | 50 | ······<version>15.1.0</version> |
| | 51 | ······<version>16.0.0</version> |
| | 52 | ····</since> |
| | 53 | ····<synopsis>Get·or·change·the·DTMF·mode·for·a·SIP·call.</synopsis> |
| | 54 | ····<syntax/> |
| | 55 | ····<description> |
| | 56 | ······<para>When·read,·returns·the·current·DTMF·mode</para> |
| | 57 | ······<para>When·written,·sets·the·current·DTMF·mode</para> |
| | 58 | ······<para>This·function·uses·the·same·DTMF·mode·naming·as·the·dtmf_mode·configuration·option</para> |
| | 59 | ····</description> |
| | 60 | ··</function> |
| | 61 | ··<function·name="PJSIP_MOH_PASSTHROUGH"·language="en_US"> |
| | 62 | ····<synopsis>Get·or·change·the·on-hold·behavior·for·a·SIP·call.</synopsis> |
| | 63 | ····<syntax/> |
| | 64 | ····<description> |
| | 65 | ······<para>When·read,·returns·the·current·moh·passthrough·mode</para> |
| | 66 | ······<para>When·written,·sets·the·current·moh·passthrough·mode</para> |
| | 67 | ······<para> |
| | 68 | ········If |
| | 69 | ········<replaceable>yes</replaceable> |
| | 70 | ········,·on-hold·re-INVITEs·are·sent.·If |
| | 71 | ········<replaceable>no</replaceable> |
| | 72 | ········,·music·on·hold·is·generated. |
| | 73 | ······</para> |
| | 74 | ······<para>This·function·can·be·used·to·override·the·moh_passthrough·configuration·option</para> |
| | 75 | ····</description> |
| | 76 | ··</function> |
| | 77 | ··<function·name="PJSIP_SEND_SESSION_REFRESH"·language="en_US"> |
| | 78 | ····<since> |
| | 79 | ······<version>13.12.0</version> |
| | 80 | ······<version>14.1.0</version> |
| | 81 | ······<version>15.0.0</version> |
| | 82 | ····</since> |
| | 83 | ····<synopsis>W/O:·Initiate·a·session·refresh·via·an·UPDATE·or·re-INVITE·on·an·established·media·session</synopsis> |
| 36 | ····<syntax> | 84 | ····<syntax> |
| 37 | ······<xi:include·xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])"/> | 85 | ······<parameter·name="update_type"·required="false"> |
| | 86 | ········<para> |
| | 87 | ··········The·type·of·update·to·send.·Default·is |
| | 88 | ··········<literal>invite</literal> |
| | 89 | ··········. |
| | 90 | ········</para> |
| | 91 | ········<enumlist> |
| | 92 | ··········<enum·name="invite"> |
| | 93 | ············<para>Send·the·session·refresh·as·a·re-INVITE.</para> |
| | 94 | ··········</enum> |
| | 95 | ··········<enum·name="update"> |
| | 96 | ············<para>Send·the·session·refresh·as·an·UPDATE.</para> |
| | 97 | ··········</enum> |
| | 98 | ········</enumlist> |
| | 99 | ······</parameter> |
| 38 | ····</syntax> | 100 | ····</syntax> |
| 39 | ····<description> | 101 | ····<description> |
| 40 | ······<para>Lists·Skinny·lines·in·text·format·with·details·on·current·status. | |
| 41 | » » » Linelist·will·follow·as·separate·events,·followed·by·a·final·event·called | |
| 42 | » » » LinelistComplete.</para> | 102 | ······<para>This·function·will·cause·the·PJSIP·stack·to·immediately·refresh |
| | 103 | » » the·media·session·for·the·channel.·This·will·be·done·using·either·a |
| | 104 | » » re-INVITE·(default)·or·an·UPDATE·request.</para> |
| | 105 | ······<para> |
| | 106 | ········This·is·most·useful·when·combined·with·the |
| | 107 | ········<replaceable>PJSIP_MEDIA_OFFER</replaceable> |
| | 108 | ········dialplan·function,·as·it·allows·the·formats·in·use·on·a·channel·to·be |
| | 109 | » » re-negotiated·after·call·setup. |
| | 110 | ······</para> |
| | 111 | ······<warning> |
| | 112 | ········<para> |
| | 113 | ··········The·formats·the·endpoint·supports·are |
| | 114 | ··········<emphasis>not</emphasis> |
|
Max diff block lines reached; 1723411/1729787 bytes (99.63%) of diff not shown.
|