Connection class

Paket:

microsoft-cognitiveservices-speech-sdk

Koneksi adalah kelas proksi untuk mengelola koneksi ke layanan ucapan dari Recognizer yang ditentukan. Secara default, Recognizer secara otonom mengelola koneksi ke layanan saat diperlukan. Kelas Koneksi menyediakan metode tambahan bagi pengguna untuk secara eksplisit membuka atau menutup koneksi dan berlangganan perubahan status koneksi. Penggunaan Koneksi bersifat opsional, dan terutama untuk skenario di mana penyetelan perilaku aplikasi yang halus berdasarkan status koneksi diperlukan. Pengguna dapat secara opsional memanggil Open() untuk menyiapkan koneksi secara manual terlebih dahulu sebelum memulai pengenalan pada Recognizer yang terkait dengan Koneksi ini. Jika Recognizer perlu menyambungkan atau memutuskan sambungan ke layanan, recognizer akan mengatur atau mematikan koneksi secara independen. Dalam hal ini Koneksi akan diberi tahu dengan perubahan status koneksi melalui peristiwa Tersambung/Terputus. Ditambahkan dalam versi 1.2.1.

Properti

connected	Peristiwa Tersambung untuk menunjukkan bahwa recognizer terhubung ke layanan.
disconnected	Peristiwa Terputus untuk menunjukkan bahwa pengenal terputus dari layanan.
messageReceived	Setiap pesan yang diterima dari Layanan Ucapan.
messageSent	Pesan apa pun yang dikirim ke Layanan Ucapan.
receivedServiceMessage	Setiap pesan dari layanan yang tidak sedang diproses oleh pengenal tingkat atas lainnya. Akan dihapus dalam 2.0.

Metode

close()	Buang sumber daya terkait.
closeConnection(() => void, (error: string) => void)	Menutup koneksi layanan. Pengguna dapat secara opsional memanggil closeConnection() untuk mematikan koneksi Recognizer terkait secara manual. Jika closeConnection() dipanggil selama pengenalan, pengenalan akan gagal dan dibatalkan dengan kesalahan.
fromRecognizer(Recognizer | ConversationTranscriber)	Mendapatkan instans Koneksi dari recognizer yang ditentukan.
fromSynthesizer(SpeechSynthesizer)	Mendapatkan instans Koneksi dari synthesizer yang ditentukan.
openConnection(() => void, (error: string) => void)	Mulai menyetel koneksi ke layanan. Pengguna dapat secara opsional memanggil openConnection() untuk menyiapkan koneksi secara manual terlebih dahulu sebelum memulai pengenalan pada Recognizer yang terkait dengan Koneksi ini. Setelah memulai pengenalan, memanggil Open() tidak akan berpengaruh Catatan: Saat kembali, koneksi mungkin belum siap. Silakan berlangganan peristiwa Tersambung untuk diberi tahu ketika koneksi dibuat.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Mengirim pesan ke layanan ucapan. Ditambahkan dalam versi 1.13.0.
setMessageProperty(string, string, string | object)	Menambahkan parameter dalam pesan ke layanan. Ditambahkan dalam versi 1.12.1.

Detail Properti

connected

Peristiwa Tersambung untuk menunjukkan bahwa recognizer terhubung ke layanan.

connected: (args: ConnectionEventArgs) => void

Nilai Properti

(args: ConnectionEventArgs) => void

disconnected

Peristiwa Terputus untuk menunjukkan bahwa pengenal terputus dari layanan.

disconnected: (args: ConnectionEventArgs) => void

Nilai Properti

(args: ConnectionEventArgs) => void

messageReceived

Setiap pesan yang diterima dari Layanan Ucapan.

messageReceived: (args: ConnectionMessageEventArgs) => void

Nilai Properti

(args: ConnectionMessageEventArgs) => void

messageSent

Pesan apa pun yang dikirim ke Layanan Ucapan.

messageSent: (args: ConnectionMessageEventArgs) => void

Nilai Properti

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Setiap pesan dari layanan yang tidak sedang diproses oleh pengenal tingkat atas lainnya.

Akan dihapus dalam 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Nilai Properti

(args: ServiceEventArgs) => void

Detail Metode

close()

Buang sumber daya terkait.

function close()

closeConnection(() => void, (error: string) => void)

Menutup koneksi layanan. Pengguna dapat secara opsional memanggil closeConnection() untuk mematikan koneksi Recognizer terkait secara manual.

Jika closeConnection() dipanggil selama pengenalan, pengenalan akan gagal dan dibatalkan dengan kesalahan.

function closeConnection(cb?: () => void, err?: (error: string) => void)

Parameter

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Mendapatkan instans Koneksi dari recognizer yang ditentukan.

static function fromRecognizer(recognizer: Recognizer | ConversationTranscriber): Connection

Parameter

recognizer

Recognizer | ConversationTranscriber

Pengenal yang terkait dengan koneksi.

Mengembalikan

Connection

Instans Koneksi pengenal.

fromSynthesizer(SpeechSynthesizer)

Mendapatkan instans Koneksi dari synthesizer yang ditentukan.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parameter

synthesizer

SpeechSynthesizer

Synthesizer yang terkait dengan koneksi.

Mengembalikan

Connection

Instans Koneksi dari synthesizer.

openConnection(() => void, (error: string) => void)

Mulai menyetel koneksi ke layanan. Pengguna dapat secara opsional memanggil openConnection() untuk menyiapkan koneksi secara manual terlebih dahulu sebelum memulai pengenalan pada Recognizer yang terkait dengan Koneksi ini. Setelah memulai pengenalan, memanggil Open() tidak akan berpengaruh

Catatan: Saat kembali, koneksi mungkin belum siap. Silakan berlangganan peristiwa Tersambung untuk diberi tahu ketika koneksi dibuat.

function openConnection(cb?: () => void, err?: (error: string) => void)

Parameter

cb

() => void

err

(error: string) => void

sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)

Mengirim pesan ke layanan ucapan. Ditambahkan dalam versi 1.13.0.

function sendMessageAsync(path: string, payload: string | ArrayBuffer, success?: () => void, error?: (error: string) => void)

Parameter

path

string

Jalur WebSocket pesan

payload

string | ArrayBuffer

Payload pesan. Ini adalah string json atau ArrayBuffer.

success

() => void

Panggilan balik untuk menunjukkan keberhasilan.

error

(error: string) => void

Panggilan balik untuk menunjukkan kesalahan.

setMessageProperty(string, string, string | object)

Menambahkan parameter dalam pesan ke layanan. Ditambahkan dalam versi 1.12.1.

function setMessageProperty(path: string, propertyName: string, propertyValue: string | object)

Parameter

path

string

Jalur pesan jaringan.

propertyName

string

Nama properti

propertyValue

string | object

Nilai properti. Ini adalah string json.