Language:
Configure Audio Overlays
VideoEditor SDK supports several configuration options for the AudioGalleryToolPanel
allowing flexible adaptation to different needs and use cases.
Add audio clips#
To add custom audio clips, we first add them to the AssetConfig
and then configure UiConfigAudio
to set the audioTrackLists
. For details, consult the section on adding audio overlays from resources.
Set allowed actions#
The quickOptionList
contains all the actions that users can perform on a frame. It also contains SpaceItem
s that are used to space out the actions. In our example, we only allow the play/pause action. SpaceItem.fillListSpacedByGroups()
automatically adds SpaceItem
s to space out the actions.
File:
class AudioOverlayConfiguration(private val activity: AppCompatActivity) : Example(activity) {override fun invoke() {// In this example, we do not need access to the Uri(s) after the editor is closed// so we pass false in the constructorval settingsList = VideoEditorSettingsList(false)// Set the source as the Uri of the video to be loaded.configure<LoadSettings> {it.source = activity.resourceUri(R.raw.skater)}// Add the custom audio clips to the asset configsettingsList.config.addAsset(AudioTrackAsset("id_elsewhere", AudioSource.create(R.raw.elsewhere)),AudioTrackAsset("id_trapped", AudioSource.create(R.raw.trapped_in_the_upside_down)),AudioTrackAsset("id_dance", AudioSource.create(R.raw.dance_harder)),AudioTrackAsset("id_far_from_home", AudioSource.create(R.raw.far_from_home)),)settingsList.configure<UiConfigAudio> {// Set the audio track list using the ids defined in the AudioTrackAssets aboveit.setAudioTrackLists(AudioTrackCategoryItem("audio_cat_elsewhere", "Elsewhere", AudioTrackItem("id_elsewhere"), AudioTrackItem("id_trapped")),AudioTrackCategoryItem("audio_cat_others", "Others", AudioTrackItem("id_dance"), AudioTrackItem("id_far_from_home")),CustomAudioTrackCategoryItem(id = "audio_custom_category",fragmentClass = ExampleAudioFragment::class.java,name = "Custom"))// By default the editor allows all available quick actions that can be used in this tool// For this example, only the play/pause button is enabled// Here, we use the fillListSpacedByGroups() method. Alternatively, we could have added the SpaceItems manually.SpaceItem.fillListSpacedByGroups(list = it.quickOptionList, groups = listOf(listOf(),listOf(ToggleOption(AudioOverlayOptionsToolPanel.OPTION_PLAY_PAUSE,"Play/Pause",ImageSource.create(ly.img.android.pesdk.ui.R.drawable.imgly_icon_play_pause_option))),listOf()))}// Start the video editor using VideoEditorBuilder// The result will be obtained in onActivityResult() corresponding to EDITOR_REQUEST_CODEVideoEditorBuilder(activity).setSettingsList(settingsList).startActivityForResult(activity, EDITOR_REQUEST_CODE)// Release the SettingsList once donesettingsList.release()}override fun onActivityResult(requestCode: Int, resultCode: Int, intent: Intent?) {intent ?: returnif (requestCode == EDITOR_REQUEST_CODE) {// Wrap the intent into an EditorSDKResultval result = EditorSDKResult(intent)when (result.resultStatus) {EditorSDKResult.Status.CANCELED -> showMessage("Editor cancelled")EditorSDKResult.Status.EXPORT_DONE -> showMessage("Result saved at ${result.resultUri}")else -> {}}}}}