Plays a server-located WAV file into the call.
Namespace: ININ.IceLib.InteractionsAssembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void PlayWaveAudio( string fileName, bool isRemoteFile, bool enableDigits ) |
Visual Basic |
---|
Public Sub PlayWaveAudio ( _ fileName As String, _ isRemoteFile As Boolean, _ enableDigits As Boolean _ ) |
Parameters
- fileName
- Type: System..::..String
The name of a WAV file to play. If this file is located locally, this must be the full path to the file. If it is located remotely, this must be the result of calling NewRemoteFileName(ServerFileType) or NewRemoteFileName(ServerFileType, String).
- isRemoteFile
- Type: System..::..Boolean
Whether the specified file is located locally (and needs to be uploaded) or is located on the server.
- enableDigits
- Type: System..::..Boolean
trueTruetruetrue (True in Visual Basic) to enable playing of digits into the call to skip forward and backwards, falseFalsefalsefalse (False in Visual Basic) to ignore digits.
Remarks
When playback is complete, the PlayWaveAudioComplete event will be fired.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | A parameter contains an invalid value. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.