BitmovinApiSdk\Models\AzureSpeechToCaptionsSettings
Synopsis
class AzureSpeechToCaptionsSettings
extends ApiResource
{
- // members
- public AzureSpeechServicesCredentials $azureSpeechServicesCredentials;
- public string $region;
- public string $apiEndpoint;
- public string $language;
- public int $captionDelay;
- public int $captionRemainTime;
- public int $captionMaxLineLength;
- public int $captionLines;
- public AzureSpeechToCaptionsProfanity $profanityOption;
- // methods
- public void __construct()
- public $this azureSpeechServicesCredentials()
- public $this region()
- public $this apiEndpoint()
- public $this language()
- public $this captionDelay()
- public $this captionRemainTime()
- public $this captionMaxLineLength()
- public $this captionLines()
- public $this profanityOption()
- // Inherited methods from ApiResource
- public void __construct()
- public static $this create()
- public void toArray()
Hierarchy
Members
public
- $apiEndpoint — string
- $azureSpeechServicesCredentials — BitmovinApiSdk\Models\AzureSpeechServicesCredentials
- $captionDelay — int
- $captionLines — int
- $captionMaxLineLength — int
- $captionRemainTime — int
- $language — string
- $profanityOption — BitmovinApiSdk\Models\AzureSpeechToCaptionsProfanity
- $region — string
Methods
public
- __construct()
- apiEndpoint() — Azure Speech Services API endpoint. This information can be found in Azure's Speech resource data.
- azureSpeechServicesCredentials() — Credential settings to access Azure Speech Services
- captionDelay() — How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience. The minimum value is 0.
- captionLines() — The number of lines for a caption. The minimum value is 1.
- captionMaxLineLength() — The maximum number of characters per line for a caption. The minimum value is 20.
- captionRemainTime() — How many MILLISECONDS a caption should remain on screen if it is not replaced by another. The minimum value is 0.
- language() — Azure Speech to captions supported language (IETF BCP 47 language tag). The list of supported languages can be found at Azure's official documentation.
- profanityOption() — The profanity filter options are: - Masked: Replaces letters in profane words with asterisk (*) characters. - Raw: Include the profane words verbatim. - Removed: Removes profane words.
- region() — Azure Speech Services Region Identifier. The list of speech service supported regions can be found at Azure's official documentation.