Interface BackgroundAudioOptions

Configuration options for background audio.

Defines audio that plays throughout the entire SSML document, behind the spoken content. Useful for adding music or ambient sounds.

Example

const bgAudio: BackgroundAudioOptions = {
  src: 'https://example.com/music.mp3',
  volume: '0.5',      // 50% volume
  fadein: '3000ms',   // 3-second fade in
  fadeout: '2000ms'   // 2-second fade out
};

See

https://docs.microsoft.com/azure/cognitive-services/speech-service/speech-synthesis-markup#add-background-audio Background Audio Documentation

interface BackgroundAudioOptions {
    fadein?: string;
    fadeout?: string;
    src: string;
    volume?: string;
}

Index

Properties

fadein? fadeout? src volume?

Properties

`Optional`fadein

fadein?: string

Duration of the fade-in effect at the start.

Gradually increases volume from 0 to the specified volume level. Specified in milliseconds (ms) or seconds (s).

Example

"2000ms" - 2-second fade in

Example

"3s" - 3-second fade in

`Optional`fadeout

fadeout?: string

Duration of the fade-out effect at the end.

Gradually decreases volume from the specified level to 0. Specified in milliseconds (ms) or seconds (s).

Example

"1500ms" - 1.5-second fade out

Example

"2s" - 2-second fade out

src

src: string

URL of the background audio file. (Required)

Requirements:

Must be a publicly accessible HTTPS URL
Supported formats: MP3, WAV, and other common audio formats
File size limits depend on the service tier
Audio automatically loops if shorter than speech duration

Example

"https://example.com/background-music.mp3"

Example

"https://cdn.example.com/sounds/ambient.wav"

`Optional`volume

volume?: string

Volume level of the background audio.

Can be specified as:

Decimal: "0.0" (silent) to "1.0" (full volume)
Percentage: "0%" to "100%"
Decibels: "+0dB", "-6dB" (negative reduces volume)

Default Value

"1.0"

Example

"0.5" - 50% volume

Example

"30%" - 30% volume

Example

"-6dB" - Reduce by 6 decibels

Interface BackgroundAudioOptions

Example

See

Index

Properties

Properties

`Optional`fadein

Example

Example

`Optional`fadeout

Example

Example

src

Example

Example

`Optional`volume

Default Value

Example

Example

Example

Settings

On This Page

Interface BackgroundAudioOptions

Example

See

Index

Properties

Properties

Optionalfadein

Example

Example

Optionalfadeout

Example

Example

src

Example

Example

Optionalvolume

Default Value

Example

Example

Example

Settings

On This Page

`Optional`fadein

`Optional`fadeout

`Optional`volume