Asynchronously plays a server-located WAV file into the call.

Namespace: ININ.IceLib.Interactions
Assembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void PlayWaveAudioAsync(
	string fileName,
	bool isRemoteFile,
	bool enableDigits,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub PlayWaveAudioAsync ( _
	fileName As String, _
	isRemoteFile As Boolean, _
	enableDigits As Boolean, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

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.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

When playback is complete, the PlayWaveAudioComplete event will be fired.

Remarks

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionA parameter contains an invalid value.

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.

See Also