| ILyncPlatformLibraryInteraction Interface |
Encapsulates a SIP audio call.
Namespace: Inkostar.Interfaces
Assembly: LyncPlatformLibrary (in LyncPlatformLibrary.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe ILyncPlatformLibraryInteraction type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Answer |
Amswers the incoming call.
|
| CancelGetDigits |
Stops the GetDigits operation and flushes the digits buffer then raises an WaitingForDigitsCancelled on completion.
|
| GetDigits |
Starts waiting indefintaely for DTMF input then raises an WaitingForDigits event on completion.
|
| GetDigits(String) |
Starts waiting for DTMF input specifying a terminating digit then raises an WaitingForDigits event on completion.
|
| GetDigits(Int32, Int32) |
Starts waiting for DTMF input specifying the number of digits to collect and a digit timeout then raises an WaitingForDigits event on completion.
|
| GetDigits(String, Int32) |
Starts waiting for DTMF input specifying the terminating DTMF digit and a digit timeout then raises an WaitingForDigits event on completion.
|
| Hold |
Puts the existing connected call on-hold.
|
| Hold(String, Boolean) |
Puts the existing connected call on-hold and plays an on-hold media.
|
| Hold(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.
|
| Hold(String, LyncPlatformLibraryAudioType, String, LyncPlatformLibraryAudioType, Int32, Boolean) |
Puts the existing connected call on-hold and alternates between two media contents for on-hold playback, specifying the media type as LyncPlatformLibraryAudioType and duration for each content.
To be used when needing to specify content on-hold from more than one source, and both content are of type LyncPlatformLibraryAudioType for example: music and a fixed prompt.
|
| Play(String) |
Plays an audio file then raises an PlaybackEnded event on completion.
|
| Play(String, Boolean) |
Plays an audio file specifying whether the playback will be repeated then raises an PlaybackEnded event on completion.
|
| Play(RetrieveCustomPrompt, LyncPlatformLibraryAudioType, Boolean) |
Plays a media content whose source is generated dynamically from a custom function, specifying the client delegate where the media content will be generated and the LyncPlatformLibraryAudioType content type.
To be used when the content to be played changes and can be dynamically generated, for example: current expected waiting time.
|
| Play(String, LyncPlatformLibraryAudioType, RetrieveCustomPrompt, LyncPlatformLibraryAudioType, Int32, Boolean) |
Alternates playback between two media contents, where the first content is of type LyncPlatformLibraryAudioType and the second content is generated from a client delegate.
To be used when needing to play content from more than one source and the second content needs to be dynamically generated, for example: music and current expected waiting time.
|
| Play(String, LyncPlatformLibraryAudioType, String, LyncPlatformLibraryAudioType, Int32, Boolean) |
Alternates the playback between two media contents, specifying the media type as LyncPlatformLibraryAudioType and duration for each content.
To be used when needing to play an audio from more than one source, and both content are of type LyncPlatformLibraryAudioType for example: music and a fixed prompt.
|
| Record |
Records the current voice path to a given WMA file then raises an event of type RecordingStarted on completion.
|
| Release |
Releases the existing connected call.
|
| Retrieve |
Retrieves the current call from the on-hold state then raises an CallRetrieved event on completion.
|
| SendDigits |
Sends the specified DTMF digits or tones to the call instance then raises an DigitsSent event on completion.
|
| Speak(String) |
Speaks a text using the TTS engine then raises an PlaybackEnded event on completion.
|
| Speak(String, LyncPlatformLibrarySamplesPerSecond, LyncPlatformLibraryAudioBitsPerSample, LyncPlatformLibraryAudioChannel) |
Speaks a text using the TTS engine specifying the LyncPlatformLibrarySamplesPerSecond,
LyncPlatformLibraryAudioBitsPerSample and LyncPlatformLibraryAudioChannel
then raises an PlaybackEnded event on completion.
|
| TransferTo |
Transfers the existing call to another SIP endpoint specifying the LyncPlatformLibraryTransferType then raises an CallTransferred on completion.
|
Properties| Name | Description | |
|---|---|---|
 | Conference |
Gets the Lync conference object.
|
| DestinationAddress |
Gets the existing interaction SIP destination address or endpoint.
|
| InteractionState |
Gets the existing interaction state LyncPlatformLibraryCallState enun value.
|
| InteractionType |
Gets the existing interacton type LyncPlatformLibraryInteractionType enum value.
|
| SessionId |
Gets the session identifier for the current SIP connection under which all events will be raised.
|
| SourceAddress |
Gets the existing interaction SIP source address or endpoint.
|
See Also