package
5.3.1
Repository: https://github.com/cycoresystems/ari.git
Documentation: pkg.go.dev

# Functions

DigitTimeouts sets the digit timeouts.
InvalidPrependURI sets a prepend URI set to be played when Replay count > 0, such as when a user has entered and invalid DMTF sequence.
MatchAny indicates that the playback should be considered Matched and terminated if any DTMF digit is received during the playback or post-playback time.
MatchDiscrete indicates that the playback should be considered Matched and terminated if the received DTMF digits match any of the discrete list of strings.
MatchFunc uses the provided match function to determine when the playback should be terminated based on DTMF input.
MatchHash indicates that the playback should be considered Matched and terminated if it contains a hash (#).
MatchLen indicates that the playback should be considered Matched and terminated if the given number of DTMF digits are receieved.
MatchLenOrTerminator indicates that the playback should be considered Matched and terminated if the given number of DTMF digits are receieved or if the given terminator is received.
MatchNone indicates that the playback should never be terminated due to DTMF.
MatchTerminator indicates that the playback shoiuld be considered Matched and terminated if it contains the provided Terminator string.
NewDefaultOptions returns a set of options which represent reasonable defaults for most simple playbacks.
NewPlay creates a new audio Options suitable for general audio playback.
NewPrompt creates a new audio Options suitable for prompt-style playback-and-get-response situations.
NewPromptOptions returns a set of options which represent reasonable defaults for most prompt playbacks.
NoExitOnDTMF disables exiting the playback when DTMF is received.
Play plays a set of media URIs.
PlaybackStartTimeout overrides the default playback start timeout.
Prompt plays the given media URIs and waits for a DTMF response.
Replays sets the number of replays of the audio sequence before exiting.
URI adds a set of audio URIs to a playback.

# Constants

AllDTMF is a string which contains all possible DTMF digits.
Cancelled indicates that the audio was cancelled.
Complete indicates that a match was found and the current DTMF pattern is complete.
Failed indicates that the audio playback failed.
Finished indicates that the playback completed playing all bound audio URIs in full.
Hangup indicates that the audio playback was interrupted due to a hangup.
Incomplete indicates that there are not enough digits to determine a match.
InProgress indicates that the audio is currently playing or is staged to play.
Invalid indicates that a match cannot befound from the current DTMF received set.
Timeout indicates that audio playback timed out.

# Variables

DefaultFirstDigitTimeout is the default amount of time to wait, after the playback for all audio completes, for the first digit to be received.
DefaultInterDigitTimeout is the maximum time to wait for additional digits after the first is received.
DefaultMaxPlaybackTime is the default maximum amount of time any playback is allowed to run.
DefaultOverallDigitTimeout is the default maximum time to wait for a response, after the playback for all audio is complete, regardless of the number of received digits or pattern matching.
DefaultPlaybackStartTimeout is the default amount of time to wait for a playback to start before declaring that the playback has failed.
DigitBufferSize is the number of digits stored in the received-digit event buffer before further digit events are ignored.
Logger defaults to a discard handler (null output).

# Structs

Options represent the various playback options which can modify the operation of a Playback.
Result describes the result of a playback operation.

# Interfaces

Session describes a structured Play session.

# Type aliases

MatchResult indicates the status of a match for the received DTMF of a playback.
OptionFunc defines an interface for functions which can modify a play session's Options.
Status indicates the final status of a playback, be it individual of an entire sequence.