Struct rrise::settings::AkDeviceSettings

#[repr(C)]
pub struct AkDeviceSettings {
    pub pIOMemory: *mut c_void,
    pub uIOMemorySize: u32,
    pub uIOMemoryAlignment: u32,
    pub ePoolAttributes: u32,
    pub uGranularity: u32,
    pub uSchedulerTypeFlags: u32,
    pub threadProperties: AkThreadProperties,
    pub fTargetAutoStmBufferLength: f32,
    pub uMaxConcurrentIO: u32,
    pub bUseStreamCache: bool,
    pub uMaxCachePinnedBytes: u32,
}

High-level IO devices initialization settings. \sa

• AK::IAkStreamMgr
• AK::StreamMgr::CreateDevice()
• \ref streamingmanager_settings

Fields

pIOMemory: *mut c_void

Pointer for I/O memory allocated by user. Pass NULL if you want memory to be allocated via AK::MemoryMgr::Malign(). If specified, uIOMemorySize, uIOMemoryAlignment and ePoolAttributes are ignored.

uIOMemorySize: u32

Size of memory for I/O (for automatic streams). It is passed directly to AK::MemoryMgr::Malign(), after having been rounded down to a multiple of uGranularity.

uIOMemoryAlignment: u32

I/O memory alignment. It is passed directly to AK::MemoryMgr::Malign().

ePoolAttributes: u32

Attributes for I/O memory. Here, specify the allocation type (AkMemType_Device, and so on). It is passed directly to AK::MemoryMgr::Malign().

uGranularity: u32

I/O requests granularity (typical bytes/request).

uSchedulerTypeFlags: u32

Scheduler type flags.

threadProperties: AkThreadProperties

Scheduler thread properties.

fTargetAutoStmBufferLength: f32

Targetted automatic stream buffer length (ms). When a stream reaches that buffering, it stops being scheduled for I/O except if the scheduler is idle.

uMaxConcurrentIO: u32

Maximum number of transfers that can be sent simultaneously to the Low-Level I/O (applies to AK_SCHEDULER_DEFERRED_LINED_UP device only).

bUseStreamCache: bool

If true the device attempts to reuse IO buffers that have already been streamed from disk. This is particularly useful when streaming small looping sounds. The drawback is a small CPU hit when allocating memory, and a slightly larger memory footprint in the StreamManager pool.

uMaxCachePinnedBytes: u32

Maximum number of bytes that can be “pinned” using AK::SoundEngine::PinEventInStreamCache() or AK::IAkStreamMgr::PinFileInCache()

Trait Implementations

impl Clone for AkDeviceSettings

fn clone(&self) -> AkDeviceSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AkDeviceSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AkDeviceSettings

fn default() -> Self

Gets the default values of the platform-independent initialization settings.

impl Copy for AkDeviceSettings