Class LauncherApiMediaBase

Namespace

Hi3Helper.Plugin.Core.Management.Api

Assembly

Hi3Helper.Plugin.Core.dll

[GeneratedComClass]
[ComExposedClass<ComClassInformation>]
public abstract class LauncherApiMediaBase : LauncherApiBase, ILauncherApiMedia, ILauncherApi, IInitializableTask, IFree

Inheritance

object

InitializableTask

LauncherApiBase

LauncherApiMediaBase

Implements

ILauncherApiMedia

ILauncherApi

IInitializableTask

IFree

Inherited Members

LauncherApiBase.ThisInstanceLock

LauncherApiBase.ApiResponseHttpClient

LauncherApiBase.ApiResponseBaseUrl

LauncherApiBase.IsDisposed

LauncherApiBase.DownloadAssetAsync(LauncherPathEntry, FileHandle, PluginFiles.FileReadProgressDelegate, in Guid, out nint)

LauncherApiBase.DownloadAssetAsync(string, FileHandle, PluginFiles.FileReadProgressDelegate, in Guid, out nint)

LauncherApiBase.DownloadAssetAsyncInner(HttpClient, string, Stream, PluginDisposableMemory<byte>, PluginFiles.FileReadProgressDelegate, CancellationToken)

LauncherApiBase.Free()

LauncherApiBase.Dispose()

InitializableTask.InitAsync(in Guid, out nint)

InitializableTask.InitAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetBackgroundEntries(out nint, out int, out bool, out bool)

Get the background image's URL entries for the launcher.
This method returns a handle to the PluginDisposableMemory<T> of LauncherPathEntry.
Pass this method to ToManagedSpan<T>(MarshalToMemorySelectorDelegate) to get the span.

public abstract void GetBackgroundEntries(out nint handle, out int count, out bool isDisposable, out bool isAllocated)

Parameters

handle nint

The handle to the LauncherPathEntry struct

count int

How much data is available from the handle

isDisposable bool

Whether if the handle can be freed or not

isAllocated bool

true if it's not empty. Otherwise, false

GetBackgroundFlag(out LauncherBackgroundFlag)

Gets the current background flag, which indicates the type and source of the launcher background.

public abstract void GetBackgroundFlag(out LauncherBackgroundFlag result)

Parameters

result LauncherBackgroundFlag

A LauncherBackgroundFlag value which representing the type (image, image sequence, video) and source (file, zip) of the background.

Remarks

This method returns a LauncherBackgroundFlag value via result which representing the type (image, image sequence, video) and source (file, zip) of the background.

GetBackgroundSpriteFps(out float)

Gets the background sprite FPS (frames per second) for the launcher background image sequence.

public virtual void GetBackgroundSpriteFps(out float result)

Parameters

result float

Frames per second for the sprites to cycle. Returns 0 if the background image is static.

GetLogoFlag(out LauncherBackgroundFlag)

Gets the current logo flag, which indicates the type and source of the logo.

public abstract void GetLogoFlag(out LauncherBackgroundFlag result)

Parameters

result LauncherBackgroundFlag

A LauncherBackgroundFlag value which representing the type (image, image sequence, video) and source (file, zip) of the logo.

Remarks

This method returns a LauncherBackgroundFlag value via resultwhich representing the type (image, image sequence, video) and source (file, zip) of the logo.

GetLogoOverlayEntries(out nint, out int, out bool, out bool)

Gets the logo overlay's URL entries for the launcher.
This method returns a handle to the PluginDisposableMemory<T> of LauncherPathEntry.
Pass this method to ToManagedSpan<T>(MarshalToMemorySelectorDelegate) to get the span.

public abstract void GetLogoOverlayEntries(out nint handle, out int count, out bool isDisposable, out bool isAllocated)

Parameters

handle nint

The handle to the LauncherPathEntry struct

count int

How much data is available from the handle

isDisposable bool

Whether if the handle can be freed or not

isAllocated bool

true if it's not empty. Otherwise, false