Captions interface

Captions 개체의 데이터 구조

Extends

상속된 속성

activeSpokenLanguage

BCP 47 형식의 호출에서 현재 활성 음성 언어를 나타냅니다.

isCaptionsFeatureActive

현재 호출에서 캡션이 활성 상태인지를 나타냅니다.

kind

현재 캡션 개체의 캡션 유형을 나타냅니다.

supportedSpokenLanguages

BCP 47 형식의 캡션 서비스와 함께 사용할 지원되는 음성 언어 목록

메서드

off("CaptionsActiveChanged", PropertyChangedEvent)

CaptionsPropertyChangedEventType 이벤트에 대한 구독 취소 함수

off("CaptionsReceived", CaptionsHandler)

CaptionsPropertyChangedEventType 이벤트에 대한 구독 취소 함수

off("SpokenLanguageChanged", PropertyChangedEvent)

SpokenLanguageChangedEventType 이벤트에 대한 구독 취소 함수

on("CaptionsActiveChanged", PropertyChangedEvent)

CaptionsPropertyChangedEventType 이벤트에 대한 Subscribe 함수

on("CaptionsReceived", CaptionsHandler)

CaptionsReceivedEventType 이벤트에 대한 Subscribe 함수

on("SpokenLanguageChanged", PropertyChangedEvent)

SpokenLanguageChangedEventType 이벤트에 대한 Subscribe 함수

상속된 메서드

setSpokenLanguage(string)

진행 중인 전사/캡션의 언어를 업데이트합니다.

startCaptions(StartCaptionsOptions)

이 클라이언트에 대해 제공된 처리기를 사용하여 이 호출에서 캡션 처리를 시작합니다.

stopCaptions()

stopCaptions를 시작한 사용자에 대한 호출에서 캡션 데이터 검색을 중지합니다.

상속된 속성 세부 정보

activeSpokenLanguage

BCP 47 형식의 호출에서 현재 활성 음성 언어를 나타냅니다.

activeSpokenLanguage: string

속성 값

string

CaptionsCommon.activeSpokenLanguage 상속된

isCaptionsFeatureActive

현재 호출에서 캡션이 활성 상태인지를 나타냅니다.

isCaptionsFeatureActive: boolean

속성 값

boolean

CaptionsCommon.isCaptionsFeatureActive 상속된

kind

현재 캡션 개체의 캡션 유형을 나타냅니다.

kind: CaptionsKind

속성 값

CaptionsCommon.kind 상속된

supportedSpokenLanguages

BCP 47 형식의 캡션 서비스와 함께 사용할 지원되는 음성 언어 목록

supportedSpokenLanguages: string[]

속성 값

string[]

CaptionsCommon.supportedSpokenLanguages 상속된

메서드 세부 정보

off("CaptionsActiveChanged", PropertyChangedEvent)

CaptionsPropertyChangedEventType 이벤트에 대한 구독 취소 함수

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

매개 변수

event

"CaptionsActiveChanged"

이벤트 이름

listener
PropertyChangedEvent

이 이벤트를 구독하는 데 사용된 콜백 fn

off("CaptionsReceived", CaptionsHandler)

CaptionsPropertyChangedEventType 이벤트에 대한 구독 취소 함수

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

매개 변수

event

"CaptionsReceived"

이벤트 이름

listener
CaptionsHandler

이 이벤트를 구독하는 데 사용된 콜백 fn

off("SpokenLanguageChanged", PropertyChangedEvent)

SpokenLanguageChangedEventType 이벤트에 대한 구독 취소 함수

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

매개 변수

event

"SpokenLanguageChanged"

이벤트 이름

listener
PropertyChangedEvent

이 이벤트를 구독하는 데 사용된 콜백 fn

on("CaptionsActiveChanged", PropertyChangedEvent)

CaptionsPropertyChangedEventType 이벤트에 대한 Subscribe 함수

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

매개 변수

event

"CaptionsActiveChanged"

이벤트 이름

listener
PropertyChangedEvent

이 이벤트를 구독하는 데 사용된 콜백 fn

on("CaptionsReceived", CaptionsHandler)

CaptionsReceivedEventType 이벤트에 대한 Subscribe 함수

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

매개 변수

event

"CaptionsReceived"

이벤트 이름

listener
CaptionsHandler

이 이벤트를 구독하는 데 사용된 콜백 fn

on("SpokenLanguageChanged", PropertyChangedEvent)

SpokenLanguageChangedEventType 이벤트에 대한 Subscribe 함수

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

매개 변수

event

"SpokenLanguageChanged"

이벤트 이름

listener
PropertyChangedEvent

이 이벤트를 구독하는 데 사용된 콜백 fn

상속된 메서드 세부 정보

setSpokenLanguage(string)

진행 중인 전사/캡션의 언어를 업데이트합니다.

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

매개 변수

language

string

음성을 캡션으로 사용할 언어입니다. BCP 47 형식이어야 합니다(예: "en-us")

반환

Promise<void>

언어 설정 작업의 완료를 나타내는 Promise입니다. 이 약속의 완료는 언어가 변경되었음을 나타내지 않습니다. 언어가 실제로 성공적으로 변경되면 'SpokenLanguageChanged' 이벤트가 내보내질 것입니다.

CaptionsCommon.setSpokenLanguage 상속된

startCaptions(StartCaptionsOptions)

이 클라이언트에 대해 제공된 처리기를 사용하여 이 호출에서 캡션 처리를 시작합니다.

function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>

매개 변수

startCaptionsOptions
StartCaptionsOptions

캡션을 시작하는 추가 옵션입니다.

반환

Promise<void>

시작 캡션 작업에 대한 초기화 프로세스의 완료를 나타내는 Promise입니다. 이 약속의 완료는 캡션이 시작되었음을 나타내지 않습니다. 캡션이 실제로 성공적으로 시작되면 'CaptionsActiveChanged' 이벤트가 내보내질 것입니다.

CaptionsCommon.startCaptions 상속된

stopCaptions()

stopCaptions를 시작한 사용자에 대한 호출에서 캡션 데이터 검색을 중지합니다.

function stopCaptions(): Promise<void>

반환

Promise<void>

캡션 중지 작업의 완료를 나타내는 약속입니다. 이 약속의 완료는 캡션 봇이 통화를 떠났다는 것을 나타내지 않습니다. 참가자는 성공적으로 중지되면 캡션 데이터 수신을 취소합니다.

CaptionsCommon.stopCaptions 상속됨