@bitmovin/api-sdk/dist/models/AzureSpeechToCaptionsSettings.d.ts

Bitmovin JS/TS API SDK

import AzureSpeechServicesCredentials from './AzureSpeechServicesCredentials';
import AzureSpeechToCaptionsProfanity from './AzureSpeechToCaptionsProfanity';
/**
 * @export
 * @class AzureSpeechToCaptionsSettings
 */
export declare class AzureSpeechToCaptionsSettings {
    /**
     * Credential settings to access Azure Speech Services
     * @type {AzureSpeechServicesCredentials}
     * @memberof AzureSpeechToCaptionsSettings
     */
    azureSpeechServicesCredentials?: AzureSpeechServicesCredentials;
    /**
     * Azure Speech Services Region Identifier. The list of speech service supported regions can be found at Azure's official documentation.
     * @type {string}
     * @memberof AzureSpeechToCaptionsSettings
     */
    region?: string;
    /**
     * Azure Speech Services API endpoint. This information can be found in Azure's Speech resource data.
     * @type {string}
     * @memberof AzureSpeechToCaptionsSettings
     */
    apiEndpoint?: string;
    /**
     * Azure Speech to captions supported language (IETF BCP 47 language tag). The list of supported languages can be found at Azure's official documentation.
     * @type {string}
     * @memberof AzureSpeechToCaptionsSettings
     */
    language?: string;
    /**
     * How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience. The minimum value is 0.
     * @type {number}
     * @memberof AzureSpeechToCaptionsSettings
     */
    captionDelay?: number;
    /**
     * How many MILLISECONDS a caption should remain on screen if it is not replaced by another. The minimum value is 0.
     * @type {number}
     * @memberof AzureSpeechToCaptionsSettings
     */
    captionRemainTime?: number;
    /**
     * The maximum number of characters per line for a caption.  The minimum value is 20.
     * @type {number}
     * @memberof AzureSpeechToCaptionsSettings
     */
    captionMaxLineLength?: number;
    /**
     * The number of lines for a caption. The minimum value is 1.
     * @type {number}
     * @memberof AzureSpeechToCaptionsSettings
     */
    captionLines?: number;
    /**
     * The profanity filter options are:  - Masked: Replaces letters in profane words with asterisk (*) characters. - Raw: Include the profane words verbatim. - Removed: Removes profane words.
     * @type {AzureSpeechToCaptionsProfanity}
     * @memberof AzureSpeechToCaptionsSettings
     */
    profanityOption?: AzureSpeechToCaptionsProfanity;
    constructor(obj?: Partial<AzureSpeechToCaptionsSettings>);
}
export default AzureSpeechToCaptionsSettings;