VModal Android SDK/com.vmodal.sdk/CoroutineCollectionsResource

CoroutineCollectionsResource

Coroutine counterpart of CollectionsResource. It retains blocking validation, request models, mutation no-retry behavior, typed errors, and disabled-operation behavior. Gateway requests use cancellable transport suspension; signed video cancellation also cancels its UploadHandle.

Functions

addAssets

suspend fun addAssets(collectionId: String, assetIds: List<String>, mode: String, groupName: String, streamName: String = "astream"): CollectionAddAssetsResponse

Suspending counterpart of CollectionsResource.addAssets.

autoIndexGet

suspend fun autoIndexGet(): Nothing

Suspending counterpart of disabled CollectionsResource.autoIndexGet.

autoIndexSet

suspend fun autoIndexSet(): Nothing

Suspending counterpart of disabled CollectionsResource.autoIndexSet.

create

suspend fun create(): Nothing

Suspending counterpart of disabled CollectionsResource.create.

delete

suspend fun delete(groupName: String, mode: String, scope: String = "all", dryRun: Boolean = false, confirm: Boolean = false): DeleteCollectionResponse

Suspending counterpart of CollectionsResource.delete.

edit

suspend fun edit(): Nothing

Suspending counterpart of disabled CollectionsResource.edit.

listGroups

suspend fun listGroups(mode: String? = null): GroupsResponse

Suspending counterpart of CollectionsResource.listGroups.

updateDescription

suspend fun updateDescription(groupName: String, mode: String, streamName: String, filenameSanitized: String, description: String? = null, tag: List<String>? = null): CollectionDescriptionUpdateResponse

Suspending counterpart of CollectionsResource.updateDescription.

uploadFile

suspend fun uploadFile(part: VmodalFilePart, groupName: String = "", mode: String = "vid_file", streamName: String = "astream", description: String = "", tag: List<String> = emptyList()): UploadResponse

Suspending counterpart of CollectionsResource.uploadFile.

suspend fun uploadFile(file: File, groupName: String = "", mode: String = "vid_file", streamName: String = "astream", description: String = "", tag: List<String> = emptyList()): UploadResponse

Suspending file convenience counterpart of CollectionsResource.uploadFile.

uploadFolder

suspend fun uploadFolder(): Nothing

Suspending counterpart of disabled CollectionsResource.uploadFolder.

uploadMetadataJsonl

suspend fun uploadMetadataJsonl(part: VmodalFilePart, mode: String = "img_file", groupName: String = "", streamName: String = "", writeMode: String = "append", allowOverlap: Boolean = false): MetadataParquetUploadResponse

Suspending counterpart of CollectionsResource.uploadMetadataJsonl.

videoUpload

suspend fun videoUpload(source: UploadSource, collectionName: String, subCollectionName: String, mode: String = "vid_file", modality: String = "vid_raw", ttl: Int = 12600, options: VideoUploadOptions = VideoUploadOptions(), onProgress: (UploadProgress) -> Unit = {}): VideoUploadResponse

Suspending result counterpart of CollectionsResource.videoUploadAsync.

videoUploadEvents

fun videoUploadEvents(source: UploadSource, collectionName: String, subCollectionName: String, mode: String = "vid_file", modality: String = "vid_raw", ttl: Int = 12600, options: VideoUploadOptions = VideoUploadOptions()): Flow<VideoUploadEvent>

Cold Flow counterpart of CollectionsResource.videoUploadAsync.