Note: Voiceflow processing generating callbacks from STVoiceFlowRunner module cover most of the events needed by an application including a subset of realtime event notifications from STMediaRunner module. For a complete set of realtime media event notifications from STMediaRunner module, the application must implement STMedia_EventNotification function defined in STEventsObserverDelegate protocol.

Note: VoiceFfow processing callbacks from STVoiceFlowRunner module occur on the main thread of an application. The application should be careful not to tie its main thread with complex and time consuming tasks so these callbacks and events are received timely. Also the application should release the callback and event notfication methods quickly without leveraging these methods to execute complex and time comsuming tasks.

Sample implementation code:

#import STVoiceFlow

public final class MyVoiceFlowClass: NSObject, STVoiceFlowCallback {

    var voiceFlowRunner: STVoiceFlowRunner? = nil

    func initializeSTVoiceFlowRunner () {
        voiceFlowRunner = STVoiceFlowRunner()
        _ = voiceFlowRunner.initialize()
        voiceFlowRunner!.setVoiceFlowCallback(self)
    }

    // Optional implementation of callback methods from STVoiceFlowCallback protocol
    func STVFC_PreModuleStart(vfModuleID: String) {
    }

    func STVFC_PreModuleEnd(vfModuleID: String) {
    }

    func STVFC_SRHypothesis(vfModuleID: String, srData: STSRData) {
    }

    func STVFC_MediaEvent(vfModuleID: String, mediaItemID: String, mediaFunction:STNotifyMediaFunction, mediaEvent:STNotifyMediaEvent, mediaEventData: [AnyHashable : Any]) {
    }

    func STVFC_PlayAudioSegmentData(vfModuleID: String, promptID:String, audioSegmentType:STAudioSegmentType, audioFile: String?, textString: String?, textFile: String?) {
    }

    func STVFC_PermissionEvent(permissionEvent:STNotifyMediaEvent) {
    }
}