mirror of https://github.com/OpenVidu/openvidu.git
73 lines
2.2 KiB
TypeScript
73 lines
2.2 KiB
TypeScript
/*
|
|
* (C) Copyright 2017-2022 OpenVidu (https://openvidu.io)
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
*/
|
|
|
|
import { Event } from './Event';
|
|
import { Connection } from '../../OpenVidu/Connection';
|
|
import { Session } from '../../OpenVidu/Session';
|
|
import { SpeechToTextEventReason } from './Types/Types';
|
|
|
|
/**
|
|
* Triggered by {@link SessionEventMap.speechToTextMessage}
|
|
*/
|
|
export class SpeechToTextEvent extends Event {
|
|
|
|
/**
|
|
* The {@link Connection} owning the Stream that produced the speech-to-text event.
|
|
* In other words, this is the participant that spoke and produced this transcription event.
|
|
*/
|
|
connection: Connection;
|
|
|
|
/**
|
|
* The text of the event. This is the transcription for this specific piece of audio stream
|
|
*/
|
|
text: string;
|
|
|
|
/**
|
|
* All speech-to-text events are generated
|
|
*/
|
|
reason: SpeechToTextEventReason;
|
|
|
|
/**
|
|
* The original event from the speech to text engine. This can vary depending on the engine
|
|
*/
|
|
raw: string;
|
|
|
|
/**
|
|
* [BCP-47](https://tools.ietf.org/html/bcp47) language tag (like "en-US" or "es-ES") of the recognized text. This will be the same as the language provided
|
|
* in method {@link Session.subscribeToSpeechToText} method
|
|
*/
|
|
lang: string;
|
|
|
|
/**
|
|
* @hidden
|
|
*/
|
|
constructor(target: Session, connection: Connection, text: string, reason: SpeechToTextEventReason, raw: string, lang: string) {
|
|
super(false, target, 'speechToTextMessage');
|
|
this.connection = connection;
|
|
this.text = text;
|
|
this.reason = reason;
|
|
this.raw = raw;
|
|
this.lang = lang;
|
|
}
|
|
|
|
/**
|
|
* @hidden
|
|
*/
|
|
// tslint:disable-next-line:no-empty
|
|
callDefaultBehavior() { }
|
|
}
|