kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-09 14:36:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

res_fax: Add XML documentation for channel variables.

Browse Source 
Document the channel variables currently set by SendFAX and ReceiveFAX.

Resolves: #1505
This commit is contained in:
Naveen Albert
2025-10-02 13:46:29 -04:00
committed by github-actions[bot]
parent c597c8b5c0
commit 3c21fbf69c
1 changed files with 72 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
res/res_fax.c
View File

@@ -120,8 +120,44 @@
<para>This application is provided by res_fax, which is a FAX technology agnostic module
that utilizes FAX technology resource modules to complete a FAX transmission.</para>
<para>Session arguments can be set by the FAXOPT function and to check results of the ReceiveFAX() application.</para>
<variablelist>
<variable name="FAXSTATUS">
<para>Whether the fax transmission was successful</para>
<value name="SUCCESS"/>
<value name="FAILURE"/>
</variable>
<variable name="FAXERROR">
<para>Description of what caused the fax to fail</para>
<value name="MEMORY_ERROR"/>
<value name="Channel Problems"/>
</variable>
<variable name="FAXSTATUSSTRING">
<para>Detailed description of the status of the fax transmission</para>
</variable>
<variable name="LOCALSTATIONID">
<para>Local Station ID</para>
</variable>
<variable name="REMOTESTATIONID">
<para>Remote Station ID</para>
</variable>
<variable name="FAXPAGES">
<para>Number of pages in the fax</para>
</variable>
<variable name="FAXBITRATE">
<para>Bit rate of the fax transmission</para>
</variable>
<variable name="FAXRESOLUTION">
<para>Resolution of the fax document</para>
</variable>
<variable name="FAXMODE">
<para>Fax transmission mode</para>
<value name="audio"/>
<value name="T38"/>
</variable>
</variablelist>
</description>
<see-also>
<ref type="application">SendFAX</ref>
<ref type="function">FAXOPT</ref>
</see-also>
</application>
@@ -162,8 +198,44 @@
<para>This application is provided by res_fax, which is a FAX technology agnostic module
that utilizes FAX technology resource modules to complete a FAX transmission.</para>
<para>Session arguments can be set by the FAXOPT function and to check results of the SendFAX() application.</para>
<variablelist>
<variable name="FAXSTATUS">
<para>Whether the fax transmission was successful</para>
<value name="SUCCESS"/>
<value name="FAILURE"/>
</variable>
<variable name="FAXERROR">
<para>Description of what caused the fax to fail</para>
<value name="MEMORY_ERROR"/>
<value name="Channel Problems"/>
</variable>
<variable name="FAXSTATUSSTRING">
<para>Detailed description of the status of the fax transmission</para>
</variable>
<variable name="LOCALSTATIONID">
<para>Local Station ID</para>
</variable>
<variable name="REMOTESTATIONID">
<para>Remote Station ID</para>
</variable>
<variable name="FAXPAGES">
<para>Number of pages in the fax</para>
</variable>
<variable name="FAXBITRATE">
<para>Bit rate of the fax transmission</para>
</variable>
<variable name="FAXRESOLUTION">
<para>Resolution of the fax document</para>
</variable>
<variable name="FAXMODE">
<para>Fax transmission mode</para>
<value name="audio"/>
<value name="T38"/>
</variable>
</variablelist>
</description>
<see-also>
<ref type="application">ReceiveFAX</ref>
<ref type="function">FAXOPT</ref>
</see-also>
</application>