Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize Filenames of Top-Level Files in FreeSWITCH-Explained and Introduction #93

Merged
merged 2 commits into from
Jan 11, 2024
Merged

Standardize Filenames of Top-Level Files in FreeSWITCH-Explained and Introduction #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
750b534
Initiating filename standardization effort with IVR.mdx.
hey-august Jan 11, 2024
aa194d7
Standardizing filenames in top level of /FreeSWITCH-Explained/ and to…
hey-august Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Channel-Variables-Catalog/api_on_media_16352809.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## api_on_media

string Execute a [FreeSWITCH API](../FreeSWITCH-Explained/Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) command when the far end sends media, i.e. ringing or 183/SDP.
string Execute a [FreeSWITCH API](../FreeSWITCH-Explained/Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) command when the far end sends media, i.e. ringing or 183/SDP.


The command is executed only on channels that are not already answered. Just use `export` or `export` with `nolocal:` prefix to make sure it is executed when b-leg answers.
Expand Down
2 changes: 1 addition & 1 deletion docs/Channel-Variables-Catalog/hangup_after_bridge_16352708.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Created by Ryan Harris, last modified by Attila Gulyas on 2020.08.04

boolean Controls what happens to a calling (A) party when in a [bridge state](../FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about), and the called (B) party hangs up. If `true` the [dialplan](../FreeSWITCH-Explained/Dialplan/index.mdx#0-about) will stop processing, and the A leg will be terminated when the B leg terminates. If `false` (default) the dialplan continues to be processed after the B leg terminates. This is checked after [park\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#park_after_bridge) and [transfer\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#transfer_after_bridge).
boolean Controls what happens to a calling (A) party when in a [bridge state](../FreeSWITCH-Explained/Introduction/Life-Cycle-of-a-Call.mdx#0-about), and the called (B) party hangs up. If `true` the [dialplan](../FreeSWITCH-Explained/Dialplan/index.mdx#0-about) will stop processing, and the A leg will be terminated when the B leg terminates. If `false` (default) the dialplan continues to be processed after the B leg terminates. This is checked after [park\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#park_after_bridge) and [transfer\_after\_bridge](../FreeSWITCH-Explained/Dialplan/Variables-Master-List_16352570.mdx#transfer_after_bridge).

The default value is `false`

Expand Down
10 changes: 5 additions & 5 deletions docs/Channel-Variables-Catalog/playback_terminators_16353264.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dtmf digit

## 0\. About

Allows you to set which [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) tones will terminate
Allows you to set which [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) tones will terminate

* playback (see [mod\_dptools:playback](../FreeSWITCH-Explained/Modules/mod-dptools/6586776.mdx#0-about) or [mod\_dptools:play\_and\_detect\_speech](../FreeSWITCH-Explained/Modules/mod_dptools_1970333.mdx#-c) for example), or
* recording (see `uuid_record` in [mod\_commands](../FreeSWITCH-Explained/Modules/mod_commands_1966741.mdx#--) (i.e., the FreeSWITCH API commands), [mod\_dptools:record](../FreeSWITCH-Explained/Modules/mod-dptools/6587041.mdx#0-about), and [mod\_dptools:record\_session](../FreeSWITCH-Explained/Modules/mod-dptools/6587110.mdx#about)).
Expand All @@ -24,14 +24,14 @@ The default terminator is `*` (star).
playback_terminators=123456789*0# | any | none
```

* `none` \- undefines the terminator digit, meaning no [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) tone will interrupt playback
* `any` \- any [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) will interrupt playback
* `none` \- undefines the terminator digit, meaning no [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) tone will interrupt playback
* `any` \- any [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) will interrupt playback

Digits not specified as terminators will be collected, but won't interrupt playback.

## 2\. Modifiers

* `+` (plus) - includes the following terminator digit along with the other [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) digits in the returned string
* `+` (plus) - includes the following terminator digit along with the other [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) digits in the returned string
* `x` (letter ex) - includes the following terminator digit in the returned string and also returns `SWITCH_STATUS_RESTART`

See last example below on what these modifiers do.
Expand All @@ -46,7 +46,7 @@ Make either `*` (star) or `#` (bar/pound/square) interrupt the subsequent playba
<action application="set" data="playback_terminators=#*"/>
```

If [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) 9 is dialed during playback, it will interrupt playback and return the digit 9 along with any other dialed digits; if `*` is dialed it will only interrupt playback without being included in the [DTMF](../FreeSWITCH-Explained/Introduction/Glossary_13173966.mdx#dtmf) string returned:
If [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) 9 is dialed during playback, it will interrupt playback and return the digit 9 along with any other dialed digits; if `*` is dialed it will only interrupt playback without being included in the [DTMF](../FreeSWITCH-Explained/Introduction/Glossary.mdx#dtmf) string returned:

```xml
<action application="set" data="playback_terminators=*+9"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/FreeSWITCH-Explained/Client-and-Developer-Interfaces/1048948.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ REGISTRATIONS 0

### 4.1 FreeSWITCH API

While connected, the user can issue any command in the [FreeSWITCH API](../Introduction/FreeSWITCH-API_30867723.mdx#-freeswitch--freeswitch-api-) (which are all the commands exposed in the [enabled modules](../Configuration/Configuring-FreeSWITCH/index.mdx#modulesconfxml) and [mod\_commands](../Modules/mod_commands_1966741.mdx#--)).
While connected, the user can issue any command in the [FreeSWITCH API](../Introduction/FreeSWITCH-API.mdx#-freeswitch--freeswitch-api-) (which are all the commands exposed in the [enabled modules](../Configuration/Configuring-FreeSWITCH/index.mdx#modulesconfxml) and [mod\_commands](../Modules/mod_commands_1966741.mdx#--)).

See the `console` commands for example, exposed by [mod\_console](../Modules/mod_console_1048950.mdx#about) .

Expand Down
4 changes: 2 additions & 2 deletions ...eeSWITCH-Explained/Community/Contributing-Code/Creating-New-Modules/9634354.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ An **endpoint module** deals a lot with **sessions**_._

## 2\. Sessions

A FreeSWITCH **session** is equivalent to a **[call-leg](../../../Introduction/Call-Legs_7143972.mdx#0-about)** when the **session**is managed by [mod\_sofia](../../../Modules/mod_sofia_1048707.mdx#about).
A FreeSWITCH **session** is equivalent to a **[call-leg](../../../Introduction/Call-Legs.mdx#0-about)** when the **session**is managed by [mod\_sofia](../../../Modules/mod_sofia_1048707.mdx#about).

A **session**contains a **channel** and **private data**_._

Expand Down Expand Up @@ -148,7 +148,7 @@ First follow the [New Module Checklist](./index.mdx#new-module-checklist). [Earl

## 5\. Handling calls from within your module

See [Life Cycle of a Call](../../../Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about).
See [Life Cycle of a Call](../../../Introduction/Life-Cycle-of-a-Call.mdx#0-about).

### 5.1 Common tasks to both incoming and outgoing calls

Expand Down
4 changes: 2 additions & 2 deletions docs/FreeSWITCH-Explained/Dialplan/Channel-States_7144639.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ Shell got {event,["26c739fc-8d49-43ee-9c9e-129e81236cd2",
| CS\_CONSUME\_MEDIA | 7 | Channel is consuming all media and dropping it. |
| CS\_HIBERNATE | 8 | Channel is in a sleep state. |
| CS\_RESET | 9 | Channel is in a reset state. |
| CS\_HANGUP | 10 | Channel is flagged for hangup and ready to end. Media will now end, and no further call routing will occur.The hangup state either transfers the call back to the routing state, if there is a name–value pair that requests it, or else it will hang up the call.TODO The above two sentences contradict each other on the routing part. The second sentence was moved her from [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about) (before it got moved to [Call States](./Call-States_32178212.mdx#0-about)). |
| CS\_HANGUP | 10 | Channel is flagged for hangup and ready to end. Media will now end, and no further call routing will occur.The hangup state either transfers the call back to the routing state, if there is a name–value pair that requests it, or else it will hang up the call.TODO The above two sentences contradict each other on the routing part. The second sentence was moved her from [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call.mdx#0-about) (before it got moved to [Call States](./Call-States_32178212.mdx#0-about)). |
| CS\_REPORTING | 11 | The channel is already hung up, media is already down, and now it's time to do any sort of reporting processes such as CDR logging. |
| CS\_DESTROY | 12 | Channel is ready to be destroyed and out of the state machine. Memory pools are returned to the core and utilized memory from the channel is freed. |
| CS\_NONE | 13 | TODO What does this do? In [the source](https://github.com/signalwire/freeswitch/blob/b337e77258079212aaf2f46ea42c4be0ffade28d/src/switch%5Fcore%5Fstate%5Fmachine.c#L668), it simply calls C's abort(). |
Expand All @@ -293,7 +293,7 @@ Custom state handlers can be added to the channels either globally or on a per-c
## 3\. See Also

* [Channel Variables](./Channel-Variables_16352493.mdx#about) \- specifically the `state` variable
* [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call_1048888.mdx#0-about)
* [Life Cycle of a Call](../Introduction/Life-Cycle-of-a-Call.mdx#0-about)
* [Call States](./Call-States_32178212.mdx#0-about)


Expand Down
2 changes: 1 addition & 1 deletion docs/FreeSWITCH-Explained/Dialplan/Channel-Variables_16352493.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Some variables, as shown from the [info app](../Modules/mod-dptools/6587023.mdx#
| Channel-State | state | Current [state](./Channel-States_7144639.mdx#0-about) of the channel |
| Channel-State-Number | state\_number | Integer |
| Channel-Name | channel\_name | Channel name |
| Unique-ID | uuid | uuid of this channel's [call leg](../Introduction/Call-Legs_7143972.mdx#0-about) |
| Unique-ID | uuid | uuid of this channel's [call leg](../Introduction/Call-Legs.mdx#0-about) |
| Call-Direction | direction | Inbound or Outbound |
| Answer-State | state | \- |
| Channel-Read-Codec-Name | read\_codec | the read codec variable mean the source codec |
Expand Down
Loading
Loading