Note: Voiceflow processing generating callbacks from BZVoiceFlow framework cover most of the events needed by an application including a subset of realtime event notifications from BZMedia framework. For a complete set of realtime event notifications from BZMedia framework, the application must implement bzMedia_EventNotification function from BZEventsObserverDelegate.

Note: VoiceFfow processing callbacks from BZVoiceFlow framework 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 BZVoiceFlow_Framework

public final class MyVoiceFlowClass: NSObject, BZVoiceFlowCallback {

    var bzEventsObserver: BZEventsObserver? = nil
    var bzVoiceFlowController: BZVoiceFlowController? = nil

    func InitializeBZVoiceFlowController () {
        bzVoiceFlowController = BZVoiceFlowController()
        _ = bzVoiceFlowController.initialize()
        bzVoiceFlowController!.setVoiceFlowCallback(self)
    }

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

    func BZVFC_PreModuleEnd(vfModuleID: String) {
    }

    func BZVFC_SRHypothesis(vfModuleID: String, srData: BZSRData) {
    }

    func BZVFC_MediaEvent(vfModuleID: String, mediaItemID: String, mediaFunction:BZNotifyMediaFunction, mediaEvent:BZNotifyMediaEvent, mediaEventData: [AnyHashable : Any]) {
    }

    func BZVFC_PlayAudioSegmentData(vfModuleID: String, promptID:String, audioSegmentType:BZAudioSegmentType, audioFile: String?, textString: String?, textFile: String?) {
    }

    func BZVFC_PermissionEvent(permissionEvent:BZNotifyMediaEvent) {
    }
}