Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 10.7 KB

File metadata and controls

30 lines (27 loc) · 10.7 KB

//ve-export-sdk/com.banuba.sdk.export.data

Package com.banuba.sdk.export.data

Types

Name Summary
BackgroundExportFlowManager [androidJvm]
class BackgroundExportFlowManager(exportDataProvider: ExportDataProvider, sessionParamsProvider: SessionParamsProvider, exportSessionHelper: ExportSessionHelper, exportNotificationManager: ExportNotificationManager, exportDir: Uri, shouldClearSessionOnFinish: Boolean, publishManager: PublishManager, errorParser: ExportErrorParser, exportBundleProvider: ExportBundleProvider) : ExportFlowManager
ExportFlowManager implementation which provides export in the background
DefaultExportErrorParser [androidJvm]
class DefaultExportErrorParser : ExportErrorParser
Default implementation of ExportErrorParser. Transforms exception into internal ExportError.
DefaultExportNotificationManger [androidJvm]
class DefaultExportNotificationManger(context: Context, notificationManager: NotificationManager) : ExportNotificationManager
Default ExportNotificationManager implementation. It creates a separate channel for export notifications and sends notifications on started, failed and successfully finished export. Successful export notification has a PendingIntent to open an activity with the intent action provided in string resource R.string.export_action_name.
DefaultPublishManager [androidJvm]
class DefaultPublishManager : PublishManager
Default PublishManager implementation. It is just an empty class which does not do anything.
EmptyExportSessionHelper [androidJvm]
class EmptyExportSessionHelper : ExportSessionHelper
Default ExportSessionHelper implementation. It does not do anything. Stub for the case when export api is being utilized without session logic.
ExportBundleProvider [androidJvm]
interface ExportBundleProvider
Interface to provide ExportResult.Success.additionalExportData
ExportedPreview [androidJvm]
data class ExportedPreview(imageUri: Uri)
Data class containing Uri to the exported video preview image
ExportedVideo [androidJvm]
data class ExportedVideo(sourceUri: Uri, width: Int, height: Int, soundTrackUri: Uri, interactivePreviewUri: Uri, durationMs: Long) : Parcelable
Data class representing the video after successful export.
ExportError [androidJvm]
enum ExportError : Enum<ExportError>
Types of export errors which are possible during export
ExportErrorParser [androidJvm]
interface ExportErrorParser
Interface for parsing export errors
ExportFlowManager [androidJvm]
interface ExportFlowManager
Main interface that is used to manage export flow. There are two implementations for different cases: BackgroundExportFlowManager for export which is processed in the background; ForegroundExportFlowManager for export which is processed in the foreground.
ExportNotificationManager [androidJvm]
interface ExportNotificationManager
Interface for managing status bar notifications during export. It is used only in case of BackgroundExportFlowManager.
ExportParams [androidJvm]
data class ExportParams(resolution: VideoResolution, aspectRatio: AspectRatio, effects: Effects, videoRangeList: VideoRangeList, debugEnabled: Boolean, destDir: File, fileExt: String, fileName: String, volumeVideo: Float, musicEffects: List<MusicEffect>, extraAudioFile: Uri, interactivePreviewParams: GifMaker.Params?, size: Size)
Data class to configure export request.
ExportParamsProvider [androidJvm]
interface ExportParamsProvider
Interface which customizes requested export.
ExportResult [androidJvm]
sealed class ExportResult
The state of export process
ExportResultData [androidJvm]
data class ExportResultData(result: Result<ExportedVideo>, info: VideoInfo)
ExportSessionHelper [androidJvm]
interface ExportSessionHelper
Interface which manages session data during export.
ExportTaskParams [androidJvm]
data class ExportTaskParams(videoRanges: VideoRangeList, effects: Effects, musicEffects: List<MusicEffect>, videoVolume: Float, coverUri: Uri, coverFrameSize: Size, aspect: AspectRatio, videoResolution: VideoResolution.Exact?, additionalExportData: Parcelable?, doOnStart: () -> Unit?)
Data class which contains video, effects, music and cover params utilizing on export. It is passed into ExportFlowManager.startExport function.
ForegroundExportFlowManager [androidJvm]
class ForegroundExportFlowManager(exportDataProvider: ExportDataProvider, sessionParamsProvider: SessionParamsProvider, exportSessionHelper: ExportSessionHelper, exportDir: Uri, mediaFileNameHelper: MediaFileNameHelper, shouldClearSessionOnFinish: Boolean, publishManager: PublishManager, errorParser: ExportErrorParser, exportBundleProvider: ExportBundleProvider) : ExportFlowManager
ExportFlowManager implementation which provides export in the foreground
PublishManager [androidJvm]
interface PublishManager
Interface for managing publication of exported videos into device's gallery
SimpleExportBundleProvider [androidJvm]
class SimpleExportBundleProvider : ExportBundleProvider
Default ExportBundleProvider implementation which only provides a Parcelable object passed into VideoCreationActivity launching intent
SimpleExportParamsProvider [androidJvm]
class SimpleExportParamsProvider(exportDir: Uri, mediaFileNameHelper: MediaFileNameHelper, watermarkBuilder: WatermarkBuilder) : ExportParamsProvider
Default ExportParamsProvider implementation. It requests single exported video and configures request parameters by utilizing ExportParams.Builder.