kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-16 09:52:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Indent <since> tags.

Browse Source 
Also updates the 'since' of applications/functions that existed before
XML documentation was introduced (1.6.2.0).
This commit is contained in:
Sean Bright
2025-01-23 16:35:58 -05:00
committed by asterisk-org-access-app[bot]
parent 32e6a30952
commit 82bef2ed90
210 changed files with 4020 additions and 1208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
funcs/func_aes.c
View File

@@ -39,7 +39,9 @@
/*** DOCUMENTATION
<function name="AES_ENCRYPT" language="en_US">
<since><version>1.6.1.0</version></since>
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Encrypt a string with AES given a 16 character key.
</synopsis>
@@ -61,7 +63,9 @@
</see-also>
</function>
<function name="AES_DECRYPT" language="en_US">
<since><version>1.6.1.0</version></since>
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Decrypt a string encoded in base64 with AES given a 16 character key.
</synopsis>

8
funcs/func_base64.c
View File

@@ -35,7 +35,9 @@
/*** DOCUMENTATION
<function name="BASE64_ENCODE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Encode a string in base64.
</synopsis>
@@ -54,7 +56,9 @@
</see-also>
</function>
<function name="BASE64_DECODE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Decode a base64 string.
</synopsis>

4
funcs/func_blacklist.c
View File

@@ -39,7 +39,9 @@
/*** DOCUMENTATION
<function name="BLACKLIST" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Check if the callerid is on the blacklist.
</synopsis>

4
funcs/func_callcompletion.c
View File

@@ -34,7 +34,9 @@
/*** DOCUMENTATION
<function name="CALLCOMPLETION" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Get or set a call completion configuration parameter for a channel.
</synopsis>

12
funcs/func_callerid.c
View File

@@ -70,7 +70,9 @@
*/
/*** DOCUMENTATION
<function name="CALLERID" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Gets or sets Caller*ID data on the channel.
</synopsis>
@@ -203,7 +205,9 @@
</description>
</function>
<function name="CONNECTEDLINE" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Gets or sets Connected Line data on the channel.
</synopsis>
@@ -301,7 +305,9 @@
</description>
</function>
<function name="REDIRECTING" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Gets or sets Redirecting data on the channel.
</synopsis>

8
funcs/func_cdr.c
View File

@@ -42,7 +42,9 @@
/*** DOCUMENTATION
<function name="CDR" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Gets or sets a CDR variable.
</synopsis>
@@ -168,7 +170,9 @@
</description>
</function>
<function name="CDR_PROP" language="en_US">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>
Set a property on a channel's CDR.
</synopsis>

12
funcs/func_channel.c
View File

@@ -49,7 +49,9 @@
/*** DOCUMENTATION
<function name="CHANNELS" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Gets the list of channels, optionally filtering by a regular expression.
</synopsis>
@@ -82,7 +84,9 @@
</description>
</function>
<function name="MASTER_CHANNEL" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Gets or sets variables on the master channel
</synopsis>
@@ -95,7 +99,9 @@
</description>
</function>
<function name="CHANNEL" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Gets/sets various pieces of information about the channel.
</synopsis>

4
funcs/func_config.c
View File

@@ -40,7 +40,9 @@
/*** DOCUMENTATION
<function name="AST_CONFIG" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Retrieve a variable from a configuration file.
</synopsis>

8
funcs/func_curl.c
View File

@@ -53,7 +53,9 @@
/*** DOCUMENTATION
<function name="CURL" language="en_US">
<since><version>10.0.0</version></since>
<since>
<version>10.0.0</version>
</since>
<synopsis>
Retrieve content from a remote web or ftp server
</synopsis>
@@ -96,7 +98,9 @@
</see-also>
</function>
<function name="CURLOPT" language="en_US">
<since><version>10.0.0</version></since>
<since>
<version>10.0.0</version>
</since>
<synopsis>
Sets various options for future invocations of CURL.
</synopsis>

8
funcs/func_cut.c
View File

@@ -38,7 +38,9 @@
/*** DOCUMENTATION
<function name="SORT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Sorts a list of key/vals into a list of keys, based upon the vals.
</synopsis>
@@ -59,7 +61,9 @@
</description>
</function>
<function name="CUT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Slices and dices strings, based upon a named delimiter.
</synopsis>

22
funcs/func_db.c
View File

@@ -44,7 +44,9 @@
/*** DOCUMENTATION
<function name="DB" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Read from or write to the Asterisk database.
</synopsis>
@@ -67,7 +69,9 @@
</see-also>
</function>
<function name="DB_EXISTS" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Check to see if a key exists in the Asterisk database.
</synopsis>
@@ -86,7 +90,9 @@
</see-also>
</function>
<function name="DB_KEYS" language="en_US">
<since><version>10.0.0</version></since>
<since>
<version>10.0.0</version>
</since>
<synopsis>
Obtain a list of keys within the Asterisk database.
</synopsis>
@@ -103,7 +109,11 @@
</see-also>
</function>
<function name="DB_KEYCOUNT" language="en_US">
<since><version>16.26.0</version><version>18.12.0</version><version>19.4.0</version></since>
<since>
<version>16.26.0</version>
<version>18.12.0</version>
<version>19.4.0</version>
</since>
<synopsis>
Obtain the number of keys at a prefix within the Asterisk database.
</synopsis>
@@ -120,7 +130,9 @@
</see-also>
</function>
<function name="DB_DELETE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Return a value from the database and delete it.
</synopsis>

8
funcs/func_devstate.c
View File

@@ -48,7 +48,9 @@
/*** DOCUMENTATION
<function name="DEVICE_STATE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Get or Set a device state.
</synopsis>
@@ -73,7 +75,9 @@
</description>
</function>
<function name="HINT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Get the devices set for a dialplan hint.
</synopsis>

4
funcs/func_dialgroup.c
View File

@@ -43,7 +43,9 @@
/*** DOCUMENTATION
<function name="DIALGROUP" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Manages a group of users for dialing.
</synopsis>

8
funcs/func_dialplan.c
View File

@@ -37,7 +37,9 @@
/*** DOCUMENTATION
<function name="DIALPLAN_EXISTS" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Checks the existence of a dialplan target.
</synopsis>
@@ -51,7 +53,9 @@
</description>
</function>
<function name="VALID_EXTEN" language="en_US">
<since><version>11.0.0</version></since>
<since>
<version>11.0.0</version>
</since>
<synopsis>
Determine whether an extension exists or not.
</synopsis>

16
funcs/func_enum.c
View File

@@ -50,7 +50,9 @@
/*** DOCUMENTATION
<function name="ENUMQUERY" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Initiate an ENUM query.
</synopsis>
@@ -70,7 +72,9 @@
</description>
</function>
<function name="ENUMRESULT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Retrieve results from a ENUMQUERY.
</synopsis>
@@ -91,7 +95,9 @@
</description>
</function>
<function name="ENUMLOOKUP" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
General or specific querying of NAPTR records for ENUM or ENUM-like DNS pointers.
</synopsis>
@@ -136,7 +142,9 @@
</description>
</function>
<function name="TXTCIDNAME" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
TXTCIDNAME looks up a caller name via DNS.
</synopsis>

20
funcs/func_env.c
View File

@@ -39,7 +39,9 @@
/*** DOCUMENTATION
<function name="ENV" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Gets or sets the environment variable specified.
</synopsis>
@@ -102,7 +104,9 @@
</description>
</function>
<function name="STAT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Does a check on the specified file.
</synopsis>
@@ -129,7 +133,9 @@
</description>
</function>
<function name="FILE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Read or write text file.
</synopsis>
@@ -248,7 +254,9 @@
</see-also>
</function>
<function name="FILE_COUNT_LINE" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Obtains the number of lines of a text file.
</synopsis>
@@ -284,7 +292,9 @@
</see-also>
</function>
<function name="FILE_FORMAT" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Return the newline format of a text file.
</synopsis>

12
funcs/func_evalexten.c
View File

@@ -37,7 +37,11 @@
/*** DOCUMENTATION
<function name="EVAL_EXTEN" language="en_US">
<since><version>16.26.0</version><version>18.12.0</version><version>19.4.0</version></since>
<since>
<version>16.26.0</version>
<version>18.12.0</version>
<version>19.4.0</version>
</since>
<synopsis>
Evaluates the contents of a dialplan extension and returns it as a string.
</synopsis>
@@ -91,7 +95,11 @@
</see-also>
</function>
<function name="EVAL_SUB" language="en_US">
<since><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<since>
<version>20.11.0</version>
<version>21.6.0</version>
<version>22.1.0</version>
</since>
<synopsis>
Executes a Gosub and provides its return value as a string
</synopsis>

7
funcs/func_export.c
View File

@@ -38,7 +38,12 @@
/*** DOCUMENTATION
<function name="EXPORT" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<since>
<version>16.30.0</version>
<version>18.16.0</version>
<version>19.8.0</version>
<version>20.1.0</version>
</since>
<synopsis>
Set variables or dialplan functions on any arbitrary channel that exists.
</synopsis>

4
funcs/func_extstate.c
View File

@@ -40,7 +40,9 @@
/*** DOCUMENTATION
<function name="EXTENSION_STATE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Get an extension's state.
</synopsis>

4
funcs/func_frame_trace.c
View File

@@ -39,7 +39,9 @@
/*** DOCUMENTATION
<function name="FRAME_TRACE" language="en_US">
<since><version>10.0.0</version></since>
<since>
<version>10.0.0</version>
</since>
<synopsis>
View internal ast_frames as they are read and written on a channel.
</synopsis>

24
funcs/func_global.c
View File

@@ -41,7 +41,9 @@
/*** DOCUMENTATION
<function name="GLOBAL" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Gets or sets the global variable specified.
</synopsis>
@@ -55,7 +57,11 @@
</description>
</function>
<function name="GLOBAL_DELETE" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<since>
<version>18.21.0</version>
<version>20.6.0</version>
<version>21.1.0</version>
</since>
<synopsis>
Deletes a specified global variable.
</synopsis>
@@ -74,7 +80,11 @@
</see-also>
</function>
<function name="GLOBAL_EXISTS" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<since>
<version>18.21.0</version>
<version>20.6.0</version>
<version>21.1.0</version>
</since>
<synopsis>
Check if a global variable exists or not.
</synopsis>
@@ -91,7 +101,9 @@
</see-also>
</function>
<function name="SHARED" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Gets or sets the shared variable specified.
</synopsis>
@@ -121,7 +133,9 @@
</function>
<managerEvent language="en_US" name="VarSet">
<managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a variable is shared between channels.</synopsis>
<syntax>
<channel_snapshot/>

16
funcs/func_groupcount.c
View File

@@ -35,7 +35,9 @@
/*** DOCUMENTATION
<function name="GROUP_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Counts the number of channels in the specified group.
</synopsis>
@@ -53,7 +55,9 @@
</description>
</function>
<function name="GROUP_MATCH_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Counts the number of channels in the groups matching the specified pattern.
</synopsis>
@@ -72,7 +76,9 @@
</description>
</function>
<function name="GROUP" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Gets or sets the channel group.
</synopsis>
@@ -87,7 +93,9 @@
</description>
</function>
<function name="GROUP_LIST" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Gets a list of the groups set on a channel.
</synopsis>

12
funcs/func_hangupcause.c
View File

@@ -41,7 +41,9 @@
/*** DOCUMENTATION
<function name="HANGUPCAUSE" language="en_US">
<since><version>11.0.0</version></since>
<since>
<version>11.0.0</version>
</since>
<synopsis>
Gets per-channel hangupcause information from the channel.
</synopsis>
@@ -67,7 +69,9 @@
</see-also>
</function>
<function name="HANGUPCAUSE_KEYS" language="en_US">
<since><version>11.0.0</version></since>
<since>
<version>11.0.0</version>
</since>
<synopsis>
Gets the list of channels for which hangup causes are available.
</synopsis>
@@ -80,7 +84,9 @@
</see-also>
</function>
<application name="HangupCauseClear" language="en_US">
<since><version>11.0.0</version></since>
<since>
<version>11.0.0</version>
</since>
<synopsis>
Clears hangup cause information from the channel that is available through HANGUPCAUSE.
</synopsis>

4
funcs/func_holdintercept.c
View File

@@ -41,7 +41,9 @@
/*** DOCUMENTATION
<function name="HOLD_INTERCEPT" language="en_US">
<since><version>13.7.0</version></since>
<since>
<version>13.7.0</version>
</since>
<synopsis>
Intercepts hold frames on a channel and raises an event instead of passing the frame on
</synopsis>

4
funcs/func_iconv.c
View File

@@ -42,7 +42,9 @@
/*** DOCUMENTATION
<function name="ICONV" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Converts charsets of strings.
</synopsis>

4
funcs/func_jitterbuffer.c
View File

@@ -42,7 +42,9 @@
/*** DOCUMENTATION
<function name="JITTERBUFFER" language="en_US">
<since><version>10.0.0</version></since>
<since>
<version>10.0.0</version>
</since>
<synopsis>
Add a Jitterbuffer to the Read side of the channel. This dejitters the audio stream before it reaches the Asterisk core. This is a write only function.
</synopsis>

12
funcs/func_lock.c
View File

@@ -46,7 +46,9 @@
/*** DOCUMENTATION
<function name="LOCK" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Attempt to obtain a named mutex.
</synopsis>
@@ -71,7 +73,9 @@
</see-also>
</function>
<function name="TRYLOCK" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Attempt to obtain a named mutex.
</synopsis>
@@ -94,7 +98,9 @@
</see-also>
</function>
<function name="UNLOCK" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Unlocks a named mutex.
</synopsis>

36
funcs/func_logic.c
View File

@@ -38,7 +38,9 @@
/*** DOCUMENTATION
<function name="ISNULL" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Check if a value is NULL.
</synopsis>
@@ -50,7 +52,9 @@
</description>
</function>
<function name="SET" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
SET assigns a value to a channel variable.
</synopsis>
@@ -62,7 +66,9 @@
</description>
</function>
<function name="EXISTS" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Test the existence of a value.
</synopsis>
@@ -74,7 +80,9 @@
</description>
</function>
<function name="IF" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Check for an expression.
</synopsis>
@@ -90,7 +98,9 @@
</description>
</function>
<function name="IFTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Temporal Conditional.
</synopsis>
@@ -106,7 +116,9 @@
</description>
</function>
<function name="IMPORT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Retrieve the value of a variable from another channel.
</synopsis>
@@ -118,7 +130,11 @@
</description>
</function>
<function name="DELETE" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<since>
<version>18.21.0</version>
<version>20.6.0</version>
<version>21.1.0</version>
</since>
<synopsis>
Deletes a specified channel variable.
</synopsis>
@@ -136,7 +152,11 @@
</see-also>
</function>
<function name="VARIABLE_EXISTS" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<since>
<version>18.21.0</version>
<version>20.6.0</version>
<version>21.1.0</version>
</since>
<synopsis>
Check if a dialplan variable exists or not.
</synopsis>

12
funcs/func_math.c
View File

@@ -49,7 +49,9 @@
/*** DOCUMENTATION
<function name="MATH" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Performs Mathematical Functions.
</synopsis>
@@ -78,7 +80,9 @@
</description>
</function>
<function name="INC" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Increments the value of a variable, while returning the updated value to the dialplan
</synopsis>
@@ -96,7 +100,9 @@
</description>
</function>
<function name="DEC" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Decrements the value of a variable, while returning the updated value to the dialplan
</synopsis>

4
funcs/func_md5.c
View File

@@ -37,7 +37,9 @@
/*** DOCUMENTATION
<function name="MD5" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Computes an MD5 digest.
</synopsis>

4
funcs/func_module.c
View File

@@ -33,7 +33,9 @@
/*** DOCUMENTATION
<function name="IFMODULE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Checks if an Asterisk module is loaded in memory.
</synopsis>

18
funcs/func_odbc.c
View File

@@ -48,7 +48,9 @@
/*** DOCUMENTATION
<function name="ODBC_FETCH" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Fetch a row from a multirow query.
</synopsis>
@@ -73,7 +75,9 @@
</description>
</function>
<application name="ODBCFinish" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Clear the resultset of a sucessful multirow query.
</synopsis>
@@ -86,7 +90,9 @@
</description>
</application>
<function name="SQL_ESC" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Escapes single ticks for use in SQL statements.
</synopsis>
@@ -102,7 +108,11 @@
</description>
</function>
<function name="SQL_ESC_BACKSLASHES" language="en_US">
<since><version>16.26.0</version><version>18.12.0</version><version>19.4.0</version></since>
<since>
<version>16.26.0</version>
<version>18.12.0</version>
<version>19.4.0</version>
</since>
<synopsis>
Escapes backslashes for use in SQL statements.
</synopsis>

4
funcs/func_periodic_hook.c
View File

@@ -46,7 +46,9 @@
/*** DOCUMENTATION
<function name="PERIODIC_HOOK" language="en_US">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>
Execute a periodic dialplan hook into the audio of a call.
</synopsis>

4
funcs/func_pitchshift.c
View File

@@ -73,7 +73,9 @@
/*** DOCUMENTATION
<function name="PITCH_SHIFT" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Pitch shift both tx and rx audio streams on a channel.
</synopsis>

4
funcs/func_pjsip_aor.c
View File

@@ -45,7 +45,9 @@
/*** DOCUMENTATION
<function name="PJSIP_AOR" language="en_US">
<since><version>13.2.0</version></since>
<since>
<version>13.2.0</version>
</since>
<synopsis>
Get information about a PJSIP AOR
</synopsis>

4
funcs/func_pjsip_contact.c
View File

@@ -45,7 +45,9 @@
/*** DOCUMENTATION
<function name="PJSIP_CONTACT" language="en_US">
<since><version>13.2.0</version></since>
<since>
<version>13.2.0</version>
</since>
<synopsis>
Get information about a PJSIP contact
</synopsis>

4
funcs/func_pjsip_endpoint.c
View File

@@ -46,7 +46,9 @@
/*** DOCUMENTATION
<function name="PJSIP_ENDPOINT" language="en_US">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>
Get information about a PJSIP endpoint
</synopsis>

4
funcs/func_presencestate.c
View File

@@ -44,7 +44,9 @@
/*** DOCUMENTATION
<function name="PRESENCE_STATE" language="en_US">
<since><version>11.0.0</version></since>
<since>
<version>11.0.0</version>
</since>
<synopsis>
Get or Set a presence state.
</synopsis>

4
funcs/func_rand.c
View File

@@ -38,7 +38,9 @@
/*** DOCUMENTATION
<function name="RAND" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Choose a random number in a range.
</synopsis>

20
funcs/func_realtime.c
View File

@@ -41,7 +41,9 @@
/*** DOCUMENTATION
<function name="REALTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
RealTime Read/Write Functions.
</synopsis>
@@ -78,7 +80,9 @@
</see-also>
</function>
<function name="REALTIME_STORE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
RealTime Store Function.
</synopsis>
@@ -102,7 +106,9 @@
</see-also>
</function>
<function name="REALTIME_DESTROY" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
RealTime Destroy Function.
</synopsis>
@@ -131,7 +137,9 @@
</see-also>
</function>
<function name="REALTIME_FIELD" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.2.0</version>
</since>
<synopsis>
RealTime query function.
</synopsis>
@@ -155,7 +163,9 @@
</see-also>
</function>
<function name="REALTIME_HASH" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.2.0</version>
</since>
<synopsis>
RealTime query function.
</synopsis>

4
funcs/func_sha1.c
View File

@@ -35,7 +35,9 @@
/*** DOCUMENTATION
<function name="SHA1" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Computes a SHA1 digest.
</synopsis>

4
funcs/func_shell.c
View File

@@ -76,7 +76,9 @@ static int shell_helper(struct ast_channel *chan, const char *cmd, char *data,
/*** DOCUMENTATION
<function name="SHELL" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Executes a command using the system shell and captures its output.
</synopsis>

4
funcs/func_sorcery.c
View File

@@ -39,7 +39,9 @@
/*** DOCUMENTATION
<function name="AST_SORCERY" language="en_US">
<since><version>12.2.0</version></since>
<since>
<version>12.2.0</version>
</since>
<synopsis>
Get a field from a sorcery object
</synopsis>

8
funcs/func_speex.c
View File

@@ -50,7 +50,9 @@
/*** DOCUMENTATION
<function name="AGC" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Apply automatic gain control to audio on a channel.
</synopsis>
@@ -74,7 +76,9 @@
</description>
</function>
<function name="DENOISE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Apply noise reduction to audio on a channel.
</synopsis>

4
funcs/func_sprintf.c
View File

@@ -43,7 +43,9 @@ AST_THREADSTORAGE(result_buf);
/*** DOCUMENTATION
<function name="SPRINTF" language="en_US">
<since><version>1.6.1.0</version></since>
<since>
<version>1.6.1.0</version>
</since>
<synopsis>
Format a variable according to a format string.
</synopsis>

8
funcs/func_srv.c
View File

@@ -38,7 +38,9 @@
/*** DOCUMENTATION
<function name="SRVQUERY" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Initiate an SRV query.
</synopsis>
@@ -53,7 +55,9 @@
</description>
</function>
<function name="SRVRESULT" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Retrieve results from an SRVQUERY.
</synopsis>

121
funcs/func_strings.c
View File

@@ -49,7 +49,9 @@ AST_THREADSTORAGE(tmp_buf);
/*** DOCUMENTATION
<function name="FIELDQTY" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Count the fields with an arbitrary delimiter
</synopsis>
@@ -70,7 +72,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="FIELDNUM" language="en_US">
<since><version>10.0.0</version></since>
<since>
<version>10.0.0</version>
</since>
<synopsis>
Return the 1-based offset of a field in a list
</synopsis>
@@ -95,7 +99,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="LISTFILTER" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.2.0</version>
</since>
<synopsis>Remove an item from a list, by name.</synopsis>
<syntax>
<parameter name="varname" required="true" />
@@ -109,7 +115,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="FILTER" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.40</version>
</since>
<synopsis>
Filter the string to include only the allowed characters
</synopsis>
@@ -129,7 +137,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="REPLACE" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Replace a set of characters in a given string with another character.
</synopsis>
@@ -148,7 +158,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="STRREPLACE" language="en_US">
<since><version>10.0.0</version></since>
<since>
<version>10.0.0</version>
</since>
<synopsis>
Replace instances of a substring within a string with another string.
</synopsis>
@@ -189,7 +201,12 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="TRIM" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<since>
<version>16.30.0</version>
<version>18.16.0</version>
<version>19.8.0</version>
<version>20.1.0</version>
</since>
<synopsis>
Trim leading and trailing whitespace in a string
</synopsis>
@@ -205,7 +222,12 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="LTRIM" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<since>
<version>16.30.0</version>
<version>18.16.0</version>
<version>19.8.0</version>
<version>20.1.0</version>
</since>
<synopsis>
Trim leading whitespace in a string
</synopsis>
@@ -221,7 +243,12 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="RTRIM" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<since>
<version>16.30.0</version>
<version>18.16.0</version>
<version>19.8.0</version>
<version>20.1.0</version>
</since>
<synopsis>
Trim trailing whitespace in a string
</synopsis>
@@ -237,7 +264,9 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="PASSTHRU" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Pass the given argument back as a value.
</synopsis>
@@ -257,7 +286,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="REGEX" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Check string against a regular expression.
</synopsis>
@@ -274,7 +305,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<application name="ClearHash" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Clear the keys from a specified hashname.
</synopsis>
@@ -286,7 +319,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</application>
<function name="HASH" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Implementation of a dialplan associative array
</synopsis>
@@ -301,7 +336,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="HASHKEYS" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Retrieve the keys of the HASH() function.
</synopsis>
@@ -316,7 +353,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="KEYPADHASH" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Hash the letters in string into equivalent keypad numbers.
</synopsis>
@@ -330,7 +369,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="ARRAY" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Allows setting multiple variables at once.
</synopsis>
@@ -349,7 +390,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="STRPTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Returns the epoch of the arbitrary date/time string structured as described by the format.
</synopsis>
@@ -368,7 +411,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="STRFTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Returns the current date/time in the specified format.
</synopsis>
@@ -391,7 +436,9 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="EVAL" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Evaluate stored variables
</synopsis>
@@ -413,7 +460,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="TOUPPER" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Convert string to all uppercase letters.
</synopsis>
@@ -427,7 +476,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="TOLOWER" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Convert string to all lowercase letters.
</synopsis>
@@ -441,7 +492,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="LEN" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Return the length of the string given.
</synopsis>
@@ -455,7 +508,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="QUOTE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Quotes a given string, escaping embedded quotes as necessary
</synopsis>
@@ -467,7 +522,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="CSV_QUOTE" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Quotes a given string for use in a CSV file, escaping embedded quotes as necessary
</synopsis>
@@ -479,7 +536,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="SHIFT" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Removes and returns the first item off of a variable containing delimited text
</synopsis>
@@ -501,7 +560,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="POP" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Removes and returns the last item off of a variable containing delimited text
</synopsis>
@@ -523,7 +584,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="PUSH" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Appends one or more values to the end of a variable containing delimited text
</synopsis>
@@ -542,7 +605,9 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="UNSHIFT" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Inserts one or more values to the beginning of a variable containing delimited text
</synopsis>

4
funcs/func_sysinfo.c
View File

@@ -40,7 +40,9 @@
/*** DOCUMENTATION
<function name="SYSINFO" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Returns system information specified by parameter.
</synopsis>

4
funcs/func_timeout.c
View File

@@ -38,7 +38,9 @@
/*** DOCUMENTATION
<function name="TIMEOUT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Gets or sets timeouts on the channel. Timeout values are in seconds.
</synopsis>

8
funcs/func_uri.c
View File

@@ -42,7 +42,9 @@
/*** DOCUMENTATION
<function name="URIENCODE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Encodes a string to URI-safe encoding according to RFC 2396.
</synopsis>
@@ -56,7 +58,9 @@
</description>
</function>
<function name="URIDECODE" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Decodes a URI-encoded string according to RFC 2396.
</synopsis>

4
funcs/func_version.c
View File

@@ -38,7 +38,9 @@
/*** DOCUMENTATION
<function name="VERSION" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Return the Version info for this Asterisk.
</synopsis>

4
funcs/func_vmcount.c
View File

@@ -43,7 +43,9 @@
/*** DOCUMENTATION
<function name="VMCOUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Count the voicemails in a specified mailbox or mailboxes.
</synopsis>

4
funcs/func_volume.c
View File

@@ -41,7 +41,9 @@
/*** DOCUMENTATION
<function name="VOLUME" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Set or get the TX or RX volume of a channel.
</synopsis>