| ILyncPlatformLibraryInteractionHold Method (String, LyncPlatformLibraryAudioType, RetrieveCustomPrompt, LyncPlatformLibraryAudioType, Int32, Boolean) |
Puts the existing connected call on-hold and alternates between two media contents for on-hold playback, where the first content is of type
LyncPlatformLibraryAudioType and the second content is generated from a client delegate.
To be used when needing to speccify content on-hold from more than one source and the second content needs to be dynamically generated, for example: music and current expected waiting time.
Namespace: Inkostar.InterfacesAssembly: LyncPlatformLibrary (in LyncPlatformLibrary.dll) Version: 1.0.0.0 (1.0.0.0)
Syntaxvoid Hold(
string onHoldContent1,
LyncPlatformLibraryAudioType content1Type,
RetrieveCustomPrompt customPromptDelegate,
LyncPlatformLibraryAudioType content2Type,
int alternateIntervalSeconds,
bool loopPlayback
)
Sub Hold (
onHoldContent1 As String,
content1Type As LyncPlatformLibraryAudioType,
customPromptDelegate As RetrieveCustomPrompt,
content2Type As LyncPlatformLibraryAudioType,
alternateIntervalSeconds As Integer,
loopPlayback As Boolean
)
void Hold(
String^ onHoldContent1,
LyncPlatformLibraryAudioType content1Type,
RetrieveCustomPrompt^ customPromptDelegate,
LyncPlatformLibraryAudioType content2Type,
int alternateIntervalSeconds,
bool loopPlayback
)
abstract Hold :
onHoldContent1 : string *
content1Type : LyncPlatformLibraryAudioType *
customPromptDelegate : RetrieveCustomPrompt *
content2Type : LyncPlatformLibraryAudioType *
alternateIntervalSeconds : int *
loopPlayback : bool -> unit
Parameters
- onHoldContent1
- Type: SystemString
The first media file or TTS text to be played.
- content1Type
- Type: Inkostar.EnumsLyncPlatformLibraryAudioType
Specifies the media content type of the first content to be played back, one of LyncPlatformLibraryAudioType enumeration values.
- customPromptDelegate
- Type: Inkostar.DelegatesRetrieveCustomPrompt
The delegate to the client function which will generate the second content to be played.
- content2Type
- Type: Inkostar.EnumsLyncPlatformLibraryAudioType
Specifies the media content type of the second content to be played back, one of LyncPlatformLibraryAudioType enumeration values.
- alternateIntervalSeconds
- Type: SystemInt32
The duration in seconds after which each content will alternate.
- loopPlayback
- Type: SystemBoolean
Set to True to specify that the content playback will be repeated when reaching the end, otherwise set to False.
See Also