Captions interface
Captions オブジェクトのデータ構造
- Extends
継承されたプロパティ
| active |
BCP 47 形式の呼び出しで現在アクティブな音声言語を示します |
| is |
現在の呼び出しでキャプションがアクティブかどうかを示します |
| kind | アクティブなキャプション オブジェクトの Captions の種類を示します |
| supported |
BCP 47 形式のキャプション サービスで使用するサポートされている音声言語の一覧 |
メソッド
| off("Captions |
CaptionsPropertyChangedEventType イベントの Unsubscribe 関数 |
| off("Captions |
CaptionsPropertyChangedEventType イベントの Unsubscribe 関数 |
| off("Spoken |
SpokenLanguageChangedEventType イベントの Unsubscribe 関数 |
| on("Captions |
CaptionsPropertyChangedEventType イベントのサブスクライブ関数 |
| on("Captions |
CaptionsReceivedEventType イベントの Subscribe 関数 |
| on("Spoken |
SpokenLanguageChangedEventType イベントのサブスクライブ関数 |
継承されたメソッド
| set |
進行中の文字起こし/キャプションの言語を更新します |
| start |
このクライアントに対して指定されたハンドラーを使用して、この呼び出しでキャプションの処理を開始します |
| stop |
stopCaptions を開始したユーザーの呼び出しでキャプション データの取得を停止します |
継承されたプロパティの詳細
activeSpokenLanguage
BCP 47 形式の呼び出しで現在アクティブな音声言語を示します
activeSpokenLanguage: stringプロパティ値
string
isCaptionsFeatureActive
現在の呼び出しでキャプションがアクティブかどうかを示します
isCaptionsFeatureActive: booleanプロパティ値
boolean
kind
アクティブなキャプション オブジェクトの Captions の種類を示します
kind: CaptionsKindプロパティ値
supportedSpokenLanguages
BCP 47 形式のキャプション サービスで使用するサポートされている音声言語の一覧
supportedSpokenLanguages: string[]プロパティ値
string[]
Inherited FromCaptionsCommon.supportedSpokenLanguages
メソッドの詳細
off("CaptionsActiveChanged", PropertyChangedEvent)
CaptionsPropertyChangedEventType イベントの Unsubscribe 関数
function off(event: "CaptionsActiveChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"CaptionsActiveChanged"
イベント名
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn
off("CaptionsReceived", CaptionsHandler)
CaptionsPropertyChangedEventType イベントの Unsubscribe 関数
function off(event: "CaptionsReceived", listener: CaptionsHandler)パラメーター
- event
-
"CaptionsReceived"
イベント名
- listener
- CaptionsHandler
このイベントのサブスクライブに使用されたコールバック fn
off("SpokenLanguageChanged", PropertyChangedEvent)
SpokenLanguageChangedEventType イベントの Unsubscribe 関数
function off(event: "SpokenLanguageChanged", listener: PropertyChangedEvent)パラメーター
- event
-
"SpokenLanguageChanged"
イベント名
- listener
- PropertyChangedEvent
このイベントのサブスクライブに使用されたコールバック fn
on("CaptionsActiveChanged", PropertyChangedEvent)
CaptionsPropertyChangedEventType イベントのサブスクライブ関数
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 イベントのサブスクライブ関数
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' イベントが生成されます。
startCaptions(StartCaptionsOptions)
このクライアントに対して指定されたハンドラーを使用して、この呼び出しでキャプションの処理を開始します
function startCaptions(startCaptionsOptions?: StartCaptionsOptions): Promise<void>パラメーター
- startCaptionsOptions
- StartCaptionsOptions
キャプションを開始するための追加オプション。
戻り値
Promise<void>
キャプションの開始操作の初期化プロセスの完了を表す Promise この Promise の完了は、キャプションが開始されたことを示すものではありません。 キャプションが実際に正常に開始されると、'CaptionsActiveChanged' イベントが生成されます。
stopCaptions()
stopCaptions を開始したユーザーの呼び出しでキャプション データの取得を停止します
function stopCaptions(): Promise<void>戻り値
Promise<void>
キャプションの停止操作の完了を表す Promise この Promise の完了は、キャプション ボットが呼び出しを終了したことを示すものではありません。 参加者は、正常に停止したときにキャプション データの受信を停止します。
Inherited FromCaptionsCommon.stopCaptions