Search Results for

    Show / Hide Table of Contents

    Class AudioStreamingHandler

    Implementation of IStreamingHandler for audio clips.

    Inheritance
    IStreamingHandler
    AudioStreamingHandler
    Inherited Members
    IStreamingHandler::~IStreamingHandler()
    Assembly: FlaxEngine.dll
    File: Engine/Streaming/StreamingHandlers.h
    Syntax
    public class AudioStreamingHandler : public IStreamingHandler

    Methods

    CalculateRequestedResidency(StreamableResource* resource, int32 targetResidency)

    Calculates the residency level to stream for a given resource and target residency.

    Declaration
    public virtual int32 CalculateRequestedResidency(StreamableResource* resource, int32 targetResidency) override
    Parameters
    StreamableResource resource

    The resource.

    int32 targetResidency

    The target residency level.

    Returns
    int32

    Residency level to stream

    Overrides
    IStreamingHandler::CalculateRequestedResidency(StreamableResource* resource, int32 targetResidency)

    CalculateResidency(StreamableResource* resource, float quality)

    Calculates the residency level for a given resource and quality level.

    Declaration
    public virtual int32 CalculateResidency(StreamableResource* resource, float quality) override
    Parameters
    StreamableResource resource

    The resource.

    float quality

    The quality level (0-1).

    Returns
    int32

    Residency level

    Overrides
    IStreamingHandler::CalculateResidency(StreamableResource* resource, float quality)

    CalculateTargetQuality(StreamableResource* resource, double currentTime)

    Calculates target quality level (0-1) for the given resource.

    Declaration
    public virtual float CalculateTargetQuality(StreamableResource* resource, double currentTime) override
    Parameters
    StreamableResource resource

    The resource.

    double currentTime

    The current platform time (seconds).

    Returns
    float

    Target quality (0-1).

    Overrides
    IStreamingHandler::CalculateTargetQuality(StreamableResource* resource, double currentTime)

    RequiresStreaming(StreamableResource* resource, int32 currentResidency, int32 targetResidency)

    Determines if the specified resource requires the streaming.

    Declaration
    public virtual bool RequiresStreaming(StreamableResource* resource, int32 currentResidency, int32 targetResidency) override
    Parameters
    StreamableResource resource

    The resource.

    int32 currentResidency

    The current residency level.

    int32 targetResidency

    The target residency level.

    Returns
    bool

    True if perform resource streaming, otherwise false.

    Overrides
    IStreamingHandler::RequiresStreaming(StreamableResource* resource, int32 currentResidency, int32 targetResidency)
    • Improve this Doc
    • View Source
    In This Article
    • Methods
      • CalculateRequestedResidency(StreamableResource* resource, int32 targetResidency)
      • CalculateResidency(StreamableResource* resource, float quality)
      • CalculateTargetQuality(StreamableResource* resource, double currentTime)
      • RequiresStreaming(StreamableResource* resource, int32 currentResidency, int32 targetResidency)
    Back to top Copyright © 2012-2024 Wojciech Figat