Class ImageCollectionPluginBase

An implementation of IImageCollection which delegates all member access to the Inner implementation, unless the member is overridden in a derived class which changes the behavior.

Inheritance
System.Object
ImageCollectionPluginBase
Namespace: StrixMusic.Sdk.Plugins.Model
Assembly: StrixMusic.Sdk.dll
Syntax
public class ImageCollectionPluginBase : object, IModelPlugin, IImageCollection, IImageCollectionBase, ICollectionBase, IAppModel, IMerged<ICoreImageCollection>, IMerged

Constructors

| Improve this Doc View Source

ImageCollectionPluginBase(ModelPluginMetadata, IImageCollection)

Creates a new instance of ImageCollectionPluginBase.

Declaration
protected ImageCollectionPluginBase(ModelPluginMetadata registration, IImageCollection inner)
Parameters
Type Name Description
ModelPluginMetadata registration

Metadata about the plugin which was provided during registration.
IImageCollection inner

The implementation which all member access is delegated to, unless the member is overridden in a derived class which changes the behavior.

Properties

| Improve this Doc View Source

Inner

Declaration
public IImageCollection Inner { get; set; }
Property Value
Type Description
IImageCollection
| Improve this Doc View Source

Metadata

Declaration
public ModelPluginMetadata Metadata { get; }
Property Value
Type Description
ModelPluginMetadata
| Improve this Doc View Source

Sources

Declaration
public IReadOnlyList<ICoreImageCollection> Sources { get; }
Property Value
Type Description
IReadOnlyList<ICoreImageCollection>
| Improve this Doc View Source

TotalImageCount

Declaration
public virtual int TotalImageCount { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

AddImageAsync(IImage, Int32, CancellationToken)

Declaration
public virtual Task AddImageAsync(IImage image, int index, CancellationToken cancellationToken = null)
Parameters
Type Name Description
IImage image
System.Int32 index
CancellationToken cancellationToken
Returns
Type Description
Task
| Improve this Doc View Source

DisposeAsync()

Declaration
public virtual ValueTask DisposeAsync()
Returns
Type Description
ValueTask
| Improve this Doc View Source

Equals(ICoreImageCollection)

Declaration
public virtual bool Equals(ICoreImageCollection other)
Parameters
Type Name Description
ICoreImageCollection other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetImagesAsync(Int32, Int32, CancellationToken)

Declaration
public virtual IAsyncEnumerable<IImage> GetImagesAsync(int limit, int offset, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 limit
System.Int32 offset
CancellationToken cancellationToken
Returns
Type Description
IAsyncEnumerable<IImage>
| Improve this Doc View Source

IsAddImageAvailableAsync(Int32, CancellationToken)

Declaration
public virtual Task<bool> IsAddImageAvailableAsync(int index, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 index
CancellationToken cancellationToken
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

IsRemoveImageAvailableAsync(Int32, CancellationToken)

Declaration
public virtual Task<bool> IsRemoveImageAvailableAsync(int index, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 index
CancellationToken cancellationToken
Returns
Type Description
Task<System.Boolean>
| Improve this Doc View Source

RemoveImageAsync(Int32, CancellationToken)

Declaration
public virtual Task RemoveImageAsync(int index, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.Int32 index
CancellationToken cancellationToken
Returns
Type Description
Task

Events

| Improve this Doc View Source

ImagesChanged

Declaration
public virtual event CollectionChangedEventHandler<IImage>? ImagesChanged
Event Type
Type Description
System.Nullable<CollectionChangedEventHandler<IImage>>
| Improve this Doc View Source

ImagesCountChanged

Declaration
public virtual event EventHandler<int>? ImagesCountChanged
Event Type
Type Description
System.Nullable<EventHandler<System.Int32>>
| Improve this Doc View Source

SourcesChanged

Declaration
public event EventHandler? SourcesChanged
Event Type
Type Description
System.Nullable<EventHandler>

Implements

IAsyncDisposable
IEquatable<>
IDelegatable<>