@hahnpro/ms-speech-sdk/distrib/lib/src/sdk/Connection.d.ts.map

Microsoft Cognitive Services Speech SDK for JavaScript

{"version":3,"sources":["src/sdk/Connection.ts"],"names":[],"mappings":"AAqBA,OAAO,EACH,mBAAmB,EACnB,0BAA0B,EAC1B,uBAAuB,EACvB,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACpB,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAU;IACnB,OAAO,CAAC,gBAAgB,CAA+C;IACvE,OAAO,CAAC,iBAAiB,CAAc;IACvC,OAAO,CAAC,wBAAwB,CAAc;IAE9C;;;;OAIG;WACW,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,uBAAuB,GAAG,UAAU;IAS1F;;;;OAIG;WACW,eAAe,CAAC,WAAW,EAAE,iBAAiB,GAAG,UAAU;IAUzE;;;;;;;OAOG;IACI,cAAc,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAI3E;;;;;OAKG;IACI,eAAe,CAAC,EAAE,CAAC,EAAE,MAAM,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAQ5E;;;;;;OAMG;IACI,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAyBnG;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,EAAE,OAAO,CAAC,EAAE,MAAM,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIjI;;;;OAIG;IACI,sBAAsB,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAEhE;;OAEG;IACI,eAAe,EAAE,CAAC,IAAI,EAAE,0BAA0B,KAAK,IAAI,CAAC;IAEnE;;OAEG;IACI,WAAW,EAAE,CAAC,IAAI,EAAE,0BAA0B,KAAK,IAAI,CAAC;IAE/D;;OAEG;IACI,SAAS,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACI,YAAY,EAAE,CAAC,IAAI,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEzD;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB,OAAO,CAAC,WAAW;CA2BtB","file":"Connection.d.ts","sourcesContent":["//\n// Copyright (c) Microsoft. All rights reserved.\n// Licensed under the MIT license. See LICENSE.md file in the project root for full license information.\n//\n\nimport {\n    ServiceRecognizerBase,\n    SynthesisAdapterBase,\n} from \"../common.speech/Exports.js\";\nimport {\n    ConnectionEvent,\n    ConnectionMessageReceivedEvent,\n    ConnectionMessageSentEvent,\n    IDetachable,\n    marshalPromiseToCallbacks,\n    ServiceEvent,\n} from \"../common/Exports.js\";\nimport {\n    ConnectionMessageImpl\n} from \"./ConnectionMessage.js\";\nimport { Contracts } from \"./Contracts.js\";\nimport {\n    ConnectionEventArgs,\n    ConnectionMessageEventArgs,\n    ConversationTranscriber,\n    Recognizer,\n    ServiceEventArgs,\n    SpeechSynthesizer,\n} from \"./Exports.js\";\n\n/**\n * Connection is a proxy class for managing connection to the speech service of the specified Recognizer.\n * By default, a Recognizer autonomously manages connection to service when needed.\n * The Connection class provides additional methods for users to explicitly open or close a connection and\n * to subscribe to connection status changes.\n * The use of Connection is optional, and mainly for scenarios where fine tuning of application\n * behavior based on connection status is needed. Users can optionally call Open() to manually set up a connection\n * in advance before starting recognition on the Recognizer associated with this Connection.\n * If the Recognizer needs to connect or disconnect to service, it will\n * setup or shutdown the connection independently. In this case the Connection will be notified by change of connection\n * status via Connected/Disconnected events.\n * Added in version 1.2.1.\n */\nexport class Connection {\n    private privInternalData: ServiceRecognizerBase | SynthesisAdapterBase;\n    private privEventListener: IDetachable;\n    private privServiceEventListener: IDetachable;\n\n    /**\n     * Gets the Connection instance from the specified recognizer.\n     * @param recognizer The recognizer associated with the connection.\n     * @return The Connection instance of the recognizer.\n     */\n    public static fromRecognizer(recognizer: Recognizer | ConversationTranscriber): Connection {\n        const recoBase = recognizer.internalData as ServiceRecognizerBase;\n        const ret: Connection = new Connection();\n\n        ret.privInternalData = recoBase;\n        ret.setupEvents();\n        return ret;\n    }\n\n    /**\n     * Gets the Connection instance from the specified synthesizer.\n     * @param synthesizer The synthesizer associated with the connection.\n     * @return The Connection instance of the synthesizer.\n     */\n    public static fromSynthesizer(synthesizer: SpeechSynthesizer): Connection {\n        const synthBase: SynthesisAdapterBase = synthesizer.internalData as SynthesisAdapterBase;\n\n        const ret: Connection = new Connection();\n\n        ret.privInternalData = synthBase;\n        ret.setupEvents();\n        return ret;\n    }\n\n    /**\n     * Starts to set up connection to the service.\n     * Users can optionally call openConnection() to manually set up a connection in advance before starting recognition on the\n     * Recognizer associated with this Connection. After starting recognition, calling Open() will have no effect\n     *\n     * Note: On return, the connection might not be ready yet. Please subscribe to the Connected event to\n     * be notified when the connection is established.\n     */\n    public openConnection(cb?: () => void, err?: (error: string) => void): void {\n        marshalPromiseToCallbacks(this.privInternalData.connect(), cb, err);\n    }\n\n    /**\n     * Closes the connection the service.\n     * Users can optionally call closeConnection() to manually shutdown the connection of the associated Recognizer.\n     *\n     * If closeConnection() is called during recognition, recognition will fail and cancel with an error.\n     */\n    public closeConnection(cb?: () => void, err?: (error: string) => void): void {\n        if (this.privInternalData instanceof SynthesisAdapterBase) {\n            throw new Error(\"Disconnecting a synthesizer's connection is currently not supported\");\n        } else {\n            marshalPromiseToCallbacks(this.privInternalData.disconnect(), cb, err);\n        }\n    }\n\n    /**\n     * Appends a parameter in a message to service.\n     * Added in version 1.12.1.\n     * @param path The path of the network message.\n     * @param propertyName Name of the property\n     * @param propertyValue Value of the property. This is a json string.\n     */\n    public setMessageProperty(path: string, propertyName: string, propertyValue: string | object): void {\n        Contracts.throwIfNullOrWhitespace(propertyName, \"propertyName\");\n\n        if (this.privInternalData instanceof ServiceRecognizerBase) {\n            if (path.toLowerCase() !== \"speech.context\") {\n                throw new Error(\"Only speech.context message property sets are currently supported for recognizer\");\n            } else {\n                const context = this.privInternalData.speechContext.getContext();\n                context[propertyName] = propertyValue;\n            }\n        } else if (this.privInternalData instanceof SynthesisAdapterBase) {\n            if (path.toLowerCase() !== \"speech.config\" && path.toLowerCase() !== \"synthesis.context\") {\n                throw new Error(\"Only speech.config and synthesis.context message paths are currently supported for synthesizer\");\n            } else if (path.toLowerCase() === \"speech.config\") {\n                if (propertyName.toLowerCase() !== \"context\") {\n                    throw new Error(\"Only context property is currently supported for speech.config message path for synthesizer\");\n                } else {\n                    this.privInternalData.synthesizerConfig.setContextFromJson(propertyValue);\n                }\n            } else {\n                this.privInternalData.synthesisContext.setSection(propertyName, propertyValue);\n            }\n        }\n    }\n\n    /**\n     * Sends a message to the speech service.\n     * Added in version 1.13.0.\n     * @param path The WebSocket path of the message\n     * @param payload The payload of the message. This is a json string or a ArrayBuffer.\n     * @param success A callback to indicate success.\n     * @param error A callback to indicate an error.\n     */\n    public sendMessageAsync(path: string, payload: string | ArrayBuffer, success?: () => void, error?: (error: string) => void): void {\n        marshalPromiseToCallbacks(this.privInternalData.sendNetworkMessage(path, payload), success, error);\n    }\n\n    /**\n     * Any message from service that is not being processed by any other top level recognizers.\n     *\n     * Will be removed in 2.0.\n     */\n    public receivedServiceMessage: (args: ServiceEventArgs) => void;\n\n    /**\n     * Any message received from the Speech Service.\n     */\n    public messageReceived: (args: ConnectionMessageEventArgs) => void;\n\n    /**\n     * Any message sent to the Speech Service.\n     */\n    public messageSent: (args: ConnectionMessageEventArgs) => void;\n\n    /**\n     * The Connected event to indicate that the recognizer is connected to service.\n     */\n    public connected: (args: ConnectionEventArgs) => void;\n\n    /**\n     * The Disconnected event to indicate that the recognizer is disconnected from service.\n     */\n    public disconnected: (args: ConnectionEventArgs) => void;\n\n    /**\n     * Dispose of associated resources.\n     */\n    public close(): void {\n        /* eslint-disable no-empty */\n    }\n\n    private setupEvents(): void {\n        this.privEventListener = this.privInternalData.connectionEvents.attach((connectionEvent: ConnectionEvent): void => {\n            if (connectionEvent.name === \"ConnectionEstablishedEvent\") {\n                if (!!this.connected) {\n                    this.connected(new ConnectionEventArgs(connectionEvent.connectionId));\n                }\n            } else if (connectionEvent.name === \"ConnectionClosedEvent\") {\n                if (!!this.disconnected) {\n                    this.disconnected(new ConnectionEventArgs(connectionEvent.connectionId));\n                }\n            } else if (connectionEvent.name === \"ConnectionMessageSentEvent\") {\n                if (!!this.messageSent) {\n                    this.messageSent(new ConnectionMessageEventArgs(new ConnectionMessageImpl((connectionEvent as ConnectionMessageSentEvent).message)));\n                }\n            } else if (connectionEvent.name === \"ConnectionMessageReceivedEvent\") {\n                if (!!this.messageReceived) {\n                    this.messageReceived(new ConnectionMessageEventArgs(new ConnectionMessageImpl((connectionEvent as ConnectionMessageReceivedEvent).message)));\n                }\n            }\n        });\n\n        this.privServiceEventListener = this.privInternalData.serviceEvents.attach((e: ServiceEvent): void => {\n            if (!!this.receivedServiceMessage) {\n                this.receivedServiceMessage(new ServiceEventArgs(e.jsonString, e.name));\n            }\n        });\n    }\n}\n"]}