Class ImagePluginBase
An implementation of IImage which delegates all member access to the Inner implementation, unless the member is overridden in a derived class which changes the behavior.
Implements
Inherited Members
Namespace: StrixMusic.Sdk.Plugins.Model
Assembly: StrixMusic.Sdk.dll
Syntax
public class ImagePluginBase : IModelPlugin, IImage, IImageBase, ICollectionItemBase, IAppModel, IMerged<ICoreImage>, IEquatable<ICoreImage>, IMerged, IDelegatable<IImage>
Constructors
| Improve this Doc View SourceImagePluginBase(ModelPluginMetadata, IImage)
Creates a new instance of ImagePluginBase.
Declaration
protected ImagePluginBase(ModelPluginMetadata registration, IImage inner)
Parameters
Type | Name | Description |
---|---|---|
ModelPluginMetadata | registration | Metadata about the plugin which was provided during registration. |
IImage | 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 SourceHeight
The height of the image, if known. A hint to help render the image at the correct size.
Declaration
public virtual double? Height { get; }
Property Value
Type | Description |
---|---|
double? |
Inner
Declaration
public virtual IImage Inner { get; }
Property Value
Type | Description |
---|---|
IImage |
Metadata
The plugin metadata that was provided during registration.
Declaration
public ModelPluginMetadata Metadata { get; }
Property Value
Type | Description |
---|---|
ModelPluginMetadata |
MimeType
The mime type of the image, if known. A hint to help optimize image rendering.
Declaration
public virtual string? MimeType { get; }
Property Value
Type | Description |
---|---|
string |
Sources
The sources that make up this merged item.
Declaration
public IReadOnlyList<ICoreImage> Sources { get; }
Property Value
Type | Description |
---|---|
IReadOnlyList<ICoreImage> |
Width
The width of the image, if known. A hint to help render the image at the correct size.
Declaration
public virtual double? Width { get; }
Property Value
Type | Description |
---|---|
double? |
Methods
| Improve this Doc View SourceEquals(ICoreImage?)
Declaration
public virtual bool Equals(ICoreImage? other)
Parameters
Type | Name | Description |
---|---|---|
ICoreImage | other |
Returns
Type | Description |
---|---|
bool |
OpenStreamAsync()
Opens a stream to the image resource.
Declaration
public virtual Task<Stream> OpenStreamAsync()
Returns
Type | Description |
---|---|
Task<Stream> | A Task containing a Stream of the raw image resource. |
Events
| Improve this Doc View SourceSourcesChanged
Raised when any of the sources have changed.
Declaration
public event EventHandler? SourcesChanged
Event Type
Type | Description |
---|---|
EventHandler |