TeamsCaptions interface

Paket:

@azure/communication-calling

Struktur data untuk objek TeamsCaptions

Memperluas

CaptionsCommon

Properti

activeCaptionLanguage	Menunjukkan bahasa keterangan aktif saat ini dalam format ISO 639-1
supportedCaptionLanguages	Daftar bahasa keterangan yang didukung untuk digunakan dengan layanan keterangan dalam format ISO 639-1

Properti yang Diwariskan

activeSpokenLanguage	Menunjukkan bahasa lisan aktif saat ini dalam panggilan dalam format BCP 47
isCaptionsFeatureActive	Menunjukkan apakah keterangan aktif dalam panggilan saat ini
kind	Menunjukkan jenis Keterangan untuk objek keterangan aktif
supportedSpokenLanguages	Daftar bahasa lisan yang didukung untuk digunakan dengan layanan keterangan dalam format BCP 47

Metode

off("CaptionLanguageChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionLanguageChangedEventType
off("CaptionsActiveChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType
off("CaptionsReceived", TeamsCaptionsHandler)	Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType
off("SpokenLanguageChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk salah satu peristiwa SpokenLanguageChangedEventType
on("CaptionLanguageChanged", PropertyChangedEvent)	Berlangganan fungsi untuk salah satu peristiwa CaptionLanguageChangedEventType
on("CaptionsActiveChanged", PropertyChangedEvent)	Berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType
on("CaptionsReceived", TeamsCaptionsHandler)	Berlangganan fungsi untuk peristiwa CaptionsReceivedEventType
on("SpokenLanguageChanged", PropertyChangedEvent)	Berlangganan fungsi untuk salah satu peristiwa SpokenLanguageChangedEventType
setCaptionLanguage(string)	Memperbarui bahasa Transkripsi / Keterangan yang sedang berlangsung

Metode yang Diwarisi

setSpokenLanguage(string)	Memperbarui bahasa Transkripsi / Keterangan yang sedang berlangsung
startCaptions(StartCaptionsOptions)	Memulai pemrosesan keterangan dalam panggilan ini dengan handler yang disediakan untuk klien ini
stopCaptions()	Menghentikan pengambilan data keterangan dalam panggilan untuk pengguna yang memulai stopCaptions

Detail Properti

activeCaptionLanguage

Menunjukkan bahasa keterangan aktif saat ini dalam format ISO 639-1

activeCaptionLanguage: string

Nilai Properti

string

supportedCaptionLanguages

Daftar bahasa keterangan yang didukung untuk digunakan dengan layanan keterangan dalam format ISO 639-1

supportedCaptionLanguages: string[]

Nilai Properti

string[]

Detail Properti yang Diwariskan

activeSpokenLanguage

Menunjukkan bahasa lisan aktif saat ini dalam panggilan dalam format BCP 47

activeSpokenLanguage: string

Nilai Properti

string

Diwariskan DariCaptionsCommon.activeSpokenLanguage

isCaptionsFeatureActive

Menunjukkan apakah keterangan aktif dalam panggilan saat ini

isCaptionsFeatureActive: boolean

Nilai Properti

boolean

Diwariskan Dari keteranganCommon.isCaptionsFeatureActive

kind

Menunjukkan jenis Keterangan untuk objek keterangan aktif

kind: CaptionsKind

Nilai Properti

CaptionsKind

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("CaptionLanguageChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionLanguageChangedEventType

function off(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parameter

event

"CaptionLanguageChanged"

nama peristiwa

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini

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", TeamsCaptionsHandler)

Berhenti berlangganan fungsi untuk salah satu peristiwa CaptionsPropertyChangedEventType

function off(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parameter

event

"CaptionsReceived"

nama peristiwa

listener

TeamsCaptionsHandler

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("CaptionLanguageChanged", PropertyChangedEvent)

Berlangganan fungsi untuk salah satu peristiwa CaptionLanguageChangedEventType

function on(event: "CaptionLanguageChanged", listener: PropertyChangedEvent)

Parameter

event

"CaptionLanguageChanged"

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", TeamsCaptionsHandler)

Berlangganan fungsi untuk peristiwa CaptionsReceivedEventType

function on(event: "CaptionsReceived", listener: TeamsCaptionsHandler)

Parameter

event

"CaptionsReceived"

nama peristiwa

listener

TeamsCaptionsHandler

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

setCaptionLanguage(string)

Memperbarui bahasa Transkripsi / Keterangan yang sedang berlangsung

function setCaptionLanguage(language: string): Promise<void>

Parameter

language

string

Bahasa untuk teks sebagai. Harus berformat ISO 639-1 (misalnya "en")

Mengembalikan

Promise<void>

Janji yang mewakili penyelesaian operasi Atur Bahasa Penyelesaian janji ini TIDAK menunjukkan bahasa telah berubah. Peristiwa 'CaptionLanguageChanged' akan dipancarkan ketika bahasa tersebut benar-benar berhasil diubah.

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