Interface IStoneProvider

Provides Stone platform and controller layout data

Namespace: Snowflake.Services

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface IStoneProvider

Properties

Controllers

Gets the list of controllers loaded for this core service

Declaration

IReadOnlyDictionary<ControllerId, IControllerLayout> Controllers { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<ControllerId, IControllerLayout>

Platforms

Gets the list of platforms loaded for this core service

Declaration

IReadOnlyDictionary<PlatformId, IPlatformInfo> Platforms { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<PlatformId, IPlatformInfo>

StoneVersion

Gets the version of stone definitions loaded

Declaration

Version StoneVersion { get; }

Property Value

Type	Description
System.Version

Methods

GetFileSignature(String, Stream)

Attempts to get a the filesignature for the given mimetype and ROM stream, preserving the position of the stream.

Declaration

IFileSignature GetFileSignature(string mimetype, Stream romStream)

Parameters

Type	Name	Description
System.String	mimetype	The mimetype of the ROM. Use GetStoneMimetype(PlatformId, Stream, String) to determine this.
System.IO.Stream	romStream	A stream containing the ROM file.

Returns

Type	Description
IFileSignature	A IFileSignature compatible with this mimetype and file, or null if none is found.

GetSignatures(String)

If a filesignature is known for a mimetype, returns the filesignature object. Otherwise, returns null.

Declaration

IEnumerable<IFileSignature> GetSignatures(string mimetype)

Parameters

Type	Name	Description
System.String	mimetype	A stone mimetype

Returns

Type	Description
System.Collections.Generic.IEnumerable<IFileSignature>	A list of possible signatures for the mimetype.

GetStoneMimetype(PlatformId, Stream, String)

Attempts to get a Stone mimetype from a file stream by reading the file headers provided, if the platform is known.

If a mimetype can not be found through the inbuilt file signatures, it will rely on the extension fallback, which may be a filename or the known extension of the file. If extensionFallback is null or empty, or is unable to be found in the platform, then the miemtype is unknown, and will return an empty string.

This method will preserve the stream position.

Declaration

string GetStoneMimetype(PlatformId knownPlatform, Stream romStream, string extensionFallback)

Parameters

Type	Name	Description
PlatformId	knownPlatform	The platform that the provided ROM is for
System.IO.Stream	romStream	A stream containing the ROM file.
System.String	extensionFallback	A fallback extension to look up for in case the stream analysis fails.

Returns

Type	Description
System.String	A Stone mimetype if the file format is known, or the empty string otherwise.

GetStoneMimetype(Stream)

Attempts to discover the mimetype from all known file signatures. No fallback is available for this method, so if the file does not match a known file signature, this method will return the empty string.

This method will preserve the stream position.

Declaration

string GetStoneMimetype(Stream romStream)

Parameters

Type	Name	Description
System.IO.Stream	romStream	A stream containing the ROM file.

Returns

Type	Description
System.String	A stone mimetype if the file format is known, or the empty string otherwise.