Storyboard API: Audio Object
Audio Object is part of Storyboard API and can be used to provide audio settings for video generation
Parameter Name | Parameter Type | Description | Default value |
---|---|---|---|
autoBackgroundMusic | boolean | Let Pictory AI choose Background Music on its own. Default value: false. | false |
backGroundMusicUri | URL | Background music URI is the custom music URI Default Value: null | null |
backGroundMusicVolume | double | Music Volume. Range: 0 to 1. Default Value: 0.1 | 0.1 |
aiVoiceOver | AIVoiceOver | AIVoiceOver provides settings of AI Voice used to speak the text in the video. | null |
voiceOverUri | URL | If the user wants to provide his custom voice, he can upload the URL of his voice. If voiceOverUri value is provided then please also provide the value of autoSyncVoiceOver as true. | null |
voiceOverSegments | VoiceOverSegments | This object defines the start time and end time of the custom voice provided in voiceOverUri . | |
autoSyncVoiceOver | boolean | Auto-sync the voice-over with the text/subtitles | false |
AIVoiceOver
AIVoiceOver Object defines the values of AI Voice that need to provide Voice for text-to-speech in the Video Output.
Parameter Name | Parameter Type | Description |
---|---|---|
speaker | Choice (Required) | Name of the AI Speaker that will be used to speak the text in the video. The speaker list is available on voice-over page. |
speed | int (Required) | Speed of the voice-over. Normal Speed: 100 Slow Speed: 50 Fast Speed: 200. |
amplifyLevel | int | AI voice volume: Mute: -1, Normal: 0 up to 1 (double volume) |
VoiceOverSegments
VoiceOverSegments object can be passed to mention the start time and end time of the audio that needs to be clipped from the voiceOverUri
.
Parameter Name | Parameter Type | Description |
---|---|---|
start | int | The start time of the audio that needs to be clipped from the voiceOverUri mentioned in audio.voiceOverUri |
end | int | The start time of the audio that needs to be clipped from the voiceOverUri mentioned in audio.voiceOverUri |
voiceOverSegments : [{
start: startTime,
end: endTime
}]
Updated 6 months ago