VModal
class VModalScope
Immutable operation scope for one project, collection, and stream.
Organization values cannot be overridden by individual operations.
Properties
Functions
Link copied to clipboard
suspend fun addAssets(collectionId: String, assetIds: List<String>, options: ScopedAddAssetsOptions = ScopedAddAssetsOptions()): CollectionAddAssetsResponse
Associates existing asset identifiers with this collection and stream.
Link copied to clipboard
suspend fun createIndex(options: ScopedCreateIndexOptions = ScopedCreateIndexOptions()): IndexationSubmitResponse
Creates an index job for this collection and stream.
Link copied to clipboard
suspend fun deleteCollection(options: ScopedDeleteCollectionOptions = ScopedDeleteCollectionOptions()): DeleteCollectionResponse
Deletes the complete logical collection, including all of its streams.
Link copied to clipboard
suspend fun deleteIndex(version: String, options: ScopedDeleteIndexOptions = ScopedDeleteIndexOptions()): IndexationDeleteResponse
Deletes one index version from this collection.
Link copied to clipboard
Reads one index job without accepting alternate organization values.
Link copied to clipboard
suspend fun listIndexJobs(options: ScopedIndexJobsOptions = ScopedIndexJobsOptions()): IndexationJobsListResponse
Lists index jobs filtered to this collection.
Link copied to clipboard
suspend fun search(query: String, options: ScopedSearchOptions = ScopedSearchOptions()): SearchResponse
Searches only this collection and stream.
Link copied to clipboard
suspend fun updateAsset(filename: String, changes: ScopedAssetChanges): CollectionDescriptionUpdateResponse
Updates one asset in this collection and stream.
Link copied to clipboard
suspend fun upload(source: UploadSource, options: ScopedUploadOptions = ScopedUploadOptions()): VideoUploadResponse
Uploads and indexes one asset using this scope.
Link copied to clipboard
fun uploadEvents(source: UploadSource, options: ScopedUploadOptions = ScopedUploadOptions()): Flow<VideoUploadEvent>
Returns a cold upload progress flow using this scope.
Link copied to clipboard
suspend fun uploadMetadata(part: VmodalFilePart, options: ScopedMetadataOptions = ScopedMetadataOptions()): MetadataParquetUploadResponse
Uploads collection metadata using this scope.