Captions interface
Struktur data untuk objek Keterangan
- Memperluas
Properti yang Diwariskan
| active |
Menunjukkan bahasa lisan aktif saat ini dalam panggilan dalam format BCP 47 |
| is |
Menunjukkan apakah keterangan aktif dalam panggilan saat ini |
| kind | Menunjukkan jenis Keterangan untuk objek keterangan aktif |
| supported |
Daftar bahasa lisan yang didukung untuk digunakan dengan layanan keterangan dalam format BCP 47 |
Metode
| off("Captions |
Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType |
| off("Captions |
Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType |
| off("Spoken |
Berhenti berlangganan fungsi untuk salah satu peristiwa SpokenLanguageChangedEventType |
| on("Captions |
Berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType |
| on("Captions |
Berlangganan fungsi untuk peristiwa CaptionsReceivedEventType |
| on("Spoken |
Berlangganan fungsi untuk salah satu peristiwa SpokenLanguageChangedEventType |
Metode yang Diwarisi
| set |
Memperbarui bahasa Transkripsi / Keterangan yang sedang berlangsung |
| start |
Memulai pemrosesan keterangan dalam panggilan ini dengan handler yang disediakan untuk klien ini |
| stop |
Menghentikan pengambilan data keterangan dalam panggilan untuk pengguna yang memulai stopCaptions |
Detail Properti yang Diwariskan
activeSpokenLanguage
Menunjukkan bahasa lisan aktif saat ini dalam panggilan dalam format BCP 47
activeSpokenLanguage: stringNilai Properti
string
Diwariskan DariCaptionsCommon.activeSpokenLanguage
isCaptionsFeatureActive
Menunjukkan apakah keterangan aktif dalam panggilan saat ini
isCaptionsFeatureActive: booleanNilai Properti
boolean
Diwariskan Dari keteranganCommon.isCaptionsFeatureActive
kind
Menunjukkan jenis Keterangan untuk objek keterangan aktif
kind: CaptionsKindNilai Properti
Diwariskan DariKeteranganCommon.kind
supportedSpokenLanguages
Daftar bahasa lisan yang didukung untuk digunakan dengan layanan keterangan dalam format BCP 47
supportedSpokenLanguages: string[]Nilai Properti
string[]
Diwarisi Dari keteranganCommon.supportedSpokenLanguages
Detail Metode
off("CaptionsActiveChanged", PropertyChangedEvent)
Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionsActiveChanged"
nama peristiwa
- listener
- PropertyChangedEvent
callback fn yang digunakan untuk berlangganan kejadian ini
off("CaptionsReceived", CaptionsHandler)
Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType
function off(event: "CaptionsReceived", listener: CaptionsHandler)Parameter
- event
-
"CaptionsReceived"
nama peristiwa
- listener
- CaptionsHandler
callback fn yang digunakan untuk berlangganan kejadian ini
off("SpokenLanguageChanged", PropertyChangedEvent)
Berhenti berlangganan fungsi untuk salah satu peristiwa SpokenLanguageChangedEventType
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parameter
- event
-
"SpokenLanguageChanged"
nama peristiwa
- listener
- PropertyChangedEvent
callback fn yang digunakan untuk berlangganan kejadian ini
on("CaptionsActiveChanged", PropertyChangedEvent)
Berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType
function on(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)Parameter
- event
-
"CaptionsActiveChanged"
nama peristiwa
- listener
- PropertyChangedEvent
callback fn yang digunakan untuk berlangganan kejadian ini
on("CaptionsReceived", CaptionsHandler)
Berlangganan fungsi untuk peristiwa CaptionsReceivedEventType
function on(event: "CaptionsReceived", listener: CaptionsHandler)Parameter
- event
-
"CaptionsReceived"
nama peristiwa
- listener
- CaptionsHandler
callback fn yang digunakan untuk berlangganan kejadian ini
on("SpokenLanguageChanged", PropertyChangedEvent)
Berlangganan fungsi untuk salah satu peristiwa SpokenLanguageChangedEventType
function on(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)Parameter
- event
-
"SpokenLanguageChanged"
nama peristiwa
- listener
- PropertyChangedEvent
callback fn yang digunakan untuk berlangganan kejadian ini
Detail Metode yang Diwarisi
setSpokenLanguage(string)
Memperbarui bahasa Transkripsi / Keterangan yang sedang berlangsung
function setSpokenLanguage(language: string): Promise<void>Parameter
- language
-
string
Bahasa untuk teks sebagai. Harus berformat BCP 47 (misalnya "en-us")
Mengembalikan
Promise<void>
Janji yang mewakili penyelesaian operasi Set Language. Penyelesaian janji ini TIDAK menunjukkan bahasa telah berubah. Peristiwa 'SpokenLanguageChanged' akan dipancarkan ketika bahasa tersebut benar-benar berhasil diubah.
Diwarisi DariCaptionsCommon.setSpokenLanguage
startCaptions(StartCaptionsOptions)
Memulai pemrosesan keterangan dalam panggilan ini dengan handler yang disediakan untuk klien ini
function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>Parameter
- startCaptionsOptions
- StartCaptionsOptions
Opsi tambahan untuk memulai keterangan.
Mengembalikan
Promise<void>
Janji yang mewakili penyelesaian proses intialisasi untuk operasi Mulai Keterangan Penyelesaian janji ini TIDAK menunjukkan keterangan telah dimulai. Peristiwa 'CaptionsActiveChanged' akan dipancarkan ketika keterangan benar-benar berhasil dimulai.
Diwariskan Dari keteranganCommon.startCaptions
stopCaptions()
Menghentikan pengambilan data keterangan dalam panggilan untuk pengguna yang memulai stopCaptions
function stopCaptions(): Promise<void>Mengembalikan
Promise<void>
Janji yang mewakili penyelesaian operasi Hentikan Keterangan Penyelesaian janji ini TIDAK menunjukkan bot keterangan telah meninggalkan panggilan. Peserta akan berhenti berlangganan dari menerima data keterangan setelah berhasil dihentikan.
Diwariskan Dari keteranganCommon.stopCaptions