Struct rrise::AkOutputSettings

#[repr(C)]
pub struct AkOutputSettings {
    pub audioDeviceShareset: AkUniqueID,
    pub idDevice: AkUInt32,
    pub ePanningRule: AkPanningRule,
    pub channelConfig: AkChannelConfig,
}

Platform-independent initialization settings of output devices.

Fields

audioDeviceShareset: AkUniqueID

Unique ID of a custom audio device to be used. Custom audio devices are defined in the Audio Device Shareset section of the Wwise project. If you want to output normally through the output device defined on the Master Bus in your project, leave this field to its default value (AK_INVALID_UNIQUE_ID, or value 0). Typical usage: AkInitSettings.eOutputSettings.audioDeviceShareset = AK::SoundEngine::GetIDFromString(“InsertYourAudioDeviceSharesetNameHere”);

idDevice: AkUInt32

Device specific identifier, when multiple devices of the same type are possible. If only one device is possible, leave to 0.

• PS4 Controller-Speakers: UserID as returned from sceUserServiceGetLoginUserIdList
• XBoxOne Controller-Headphones: Use the AK::GetDeviceID function to get the ID from an IMMDevice. Find the player’s device with the WASAPI API (IMMDeviceEnumerator, see Microsoft documentation) or use AK::GetDeviceIDFromName.
• Windows: Use AK::GetDeviceID or AK::GetDeviceIDFromName to get the correct ID. Leave to 0 for the default Windows device as seen in Audio Properties.
• All other outputs: use 0 to select the default for the selected audio device type (shareset)

ePanningRule: AkPanningRule

Rule for 3D panning of signals routed to a stereo bus. In AkPanningRule_Speakers mode, the angle of the front loudspeakers (uSpeakerAngles[0]) is used. In AkPanningRule_Headphones mode, the speaker angles are superseded with constant power panning between two virtual microphones spaced 180 degrees apart.

channelConfig: AkChannelConfig

Channel configuration for this output. Call AkChannelConfig::Clear() to let the engine use the default output configuration. Hardware might not support the selected configuration.

Implementations

impl AkOutputSettings

pub unsafe fn new(
    in_szDeviceShareSet: *const c_char,
    in_idDevice: AkUniqueID,
    in_channelConfig: AkChannelConfig,
    in_ePanning: AkPanningRule
) -> Self

pub unsafe fn new1(
    in_szDeviceShareSet: *const u16,
    in_idDevice: AkUniqueID,
    in_channelConfig: AkChannelConfig,
    in_ePanning: AkPanningRule
) -> Self

Trait Implementations

impl Clone for AkOutputSettings

fn clone(&self) -> AkOutputSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AkOutputSettings

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

Formats the value using the given formatter.

impl Copy for AkOutputSettings