play

import PlayableSounds from ./_sharedtables/playable_sounds.mdx; Play file(s), ringtones, speech or silence. | Name | Type | Default | Description | |:--|:|:--|:-| | playRequired | object | - | An object that accepts the [play parameters](#parameters). | ## **play Parameters** {#parameters} | Name | Type | Default | Description | |:-|:--|:--|:-| | urls (or url)Required | string \| string[] | - | Either a [playable sound](#playable-sounds), or an array of [playable sounds](#playable-sounds)
Cannot pass both url and urls at the sametime. Authentication can also be set in the url in the format of username:password@url. | | volumeOptional | number | 0 | Volume gain to apply to played URLs. Allowed values from -40.0 to 40.0. | | say_voiceOptional | string | Polly.Salli | Voice to use with say: for text to speech. | | say_languageOptional | string | en-US | Language to use with say: for text to speech. | | say_genderOptional | string | female | Gender to use with say: for text to speech. | ## **Playable sounds** ## **Variables** Read by the method: - **say_voice:** (in) - Optional voice to use for text to speech. - **say_language:** (in) - Optional language to use for text to speech. - **say_gender:** (in) - Optional gender to use for text to speech. ## **Possible Values for Voice, Language and Ringtone** import VoiceTable from ./_sharedtables/voicetable.mdx; ## **Examples** ### Playing a single URL yaml andJson version: 1.0.0 sections: main: - play: url: https://cdn.signalwire.com/swml/audio.mp3 ### Playing multiple URLs yaml andJson version: 1.0.0 sections: main: - play: urls: - https://cdn.signalwire.com/swml/audio.mp3 - say: this is something to say - silence: 3.0 - ring:10.0:us ### Playing multiple URLs with volume adjusted yaml andJson version: 1.0.0 sections: main: - play: volume: 20 urls: - https://cdn.signalwire.com/swml/audio.mp3 - say: this is something to say - silence: 3.0 - ring:10.0:us ### Specifying a voice to use for speaking **Globally** yaml andJson version: 1.0.0 sections: main: - set: say_voice: gcloud.en-US-Neural2-A - play: url: say:Hi, do I sound different? - play: url: say:I dont, do I? **For just one instance** yaml andJson version: 1.0.0 sections: main: - play: url: say:Hi, do I sound different? say_voice: gcloud.en-US-Neural2-A - play: url: say:I was down with the flu