AkTypes.h

Wwise SDK 2021.1.14

#include <AK/AkPlatforms.h>
#include <AK/SoundEngine/Common/AkSoundEngineExport.h>

クラス
struct	AkAudioSettings
	Configured audio settings [詳解]

struct	AkDeviceDescription

struct	AkExternalSourceInfo

struct	AkVector
	3D vector. [詳解]

class	AkTransform
	Position and orientation of game objects. [詳解]

struct	AkObstructionOcclusionValues
	Obstruction/occlusion pair for a position [詳解]

struct	AkChannelEmitter
	Positioning information for a sound, with specified subset of its channels. [詳解]

struct	AkPolarCoord
	Polar coordinates. [詳解]

struct	AkSphericalCoord
	Spherical coordinates. [詳解]

class	AkEmitterListenerPair
	Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener. [詳解]

struct	AkListener
	Listener information. [詳解]

struct	AkAuxSendValue
	Auxiliary bus sends information per game object per given auxiliary bus. [詳解]

struct	AkRamp
	Volume ramp specified by end points "previous" and "next". [詳解]

struct	AkCodecDescriptor

struct	WwiseObjectIDext

struct	WwiseObjectID

struct	AkFileParser::EnvelopePoint
	Analyzed envelope point. [詳解]

名前空間
namespace	AK
	Audiokinetic namespace

	AK::SoundEngine

	AkFileParser
	Public data structures for converted file format.

マクロ定義
#define	NULL 0

#define	AK_POINTER_64

#define	AK_UNUSEDVAR(x) ((void)(x))

#define	AKCURVEINTERPOLATION_NUM_STORAGE_BIT 5
	Internal storage restriction, for internal use only. [詳解]

#define	AK_MAX_LANGUAGE_NAME_SIZE (32)

#define	AKCOMPANYID_PLUGINDEV_MIN (64)

#define	AKCOMPANYID_PLUGINDEV_MAX (255)

#define	AKCOMPANYID_AUDIOKINETIC (0)
	Audiokinetic inc. [詳解]

#define	AKCOMPANYID_AUDIOKINETIC_EXTERNAL (1)
	Audiokinetic inc. [詳解]

#define	AKCOMPANYID_MCDSP (256)
	McDSP [詳解]

#define	AKCOMPANYID_WAVEARTS (257)
	WaveArts [詳解]

#define	AKCOMPANYID_PHONETICARTS (258)
	Phonetic Arts [詳解]

#define	AKCOMPANYID_IZOTOPE (259)
	iZotope [詳解]

#define	AKCOMPANYID_CRANKCASEAUDIO (261)
	Crankcase Audio [詳解]

#define	AKCOMPANYID_IOSONO (262)
	IOSONO [詳解]

#define	AKCOMPANYID_AUROTECHNOLOGIES (263)
	Auro Technologies [詳解]

#define	AKCOMPANYID_DOLBY (264)
	Dolby [詳解]

#define	AKCOMPANYID_TWOBIGEARS (265)
	Two Big Ears [詳解]

#define	AKCOMPANYID_OCULUS (266)
	Oculus [詳解]

#define	AKCOMPANYID_BLUERIPPLESOUND (267)
	Blue Ripple Sound [詳解]

#define	AKCOMPANYID_ENZIEN (268)
	Enzien Audio [詳解]

#define	AKCOMPANYID_KROTOS (269)
	Krotos (Dehumanizer) [詳解]

#define	AKCOMPANYID_NURULIZE (270)
	Nurulize [詳解]

#define	AKCOMPANYID_SUPERPOWERED (271)
	Super Powered [詳解]

#define	AKCOMPANYID_GOOGLE (272)
	Google [詳解]

#define	AKCOMPANYID_VISISONICS (277)
	Visisonics [詳解]

#define	AKCODECID_BANK (0)
	Bank encoding [詳解]

#define	AKCODECID_PCM (1)
	PCM encoding [詳解]

#define	AKCODECID_ADPCM (2)
	ADPCM encoding [詳解]

#define	AKCODECID_XMA (3)
	XMA encoding [詳解]

#define	AKCODECID_VORBIS (4)
	Vorbis encoding [詳解]

#define	AKCODECID_WIIADPCM (5)
	ADPCM encoding on the Wii [詳解]

#define	AKCODECID_PCMEX (7)
	Standard PCM WAV file parser for Wwise Authoring [詳解]

#define	AKCODECID_EXTERNAL_SOURCE (8)
	External Source (unknown encoding) [詳解]

#define	AKCODECID_XWMA (9)
	xWMA encoding [詳解]

#define	AKCODECID_AAC (10)
	AAC encoding (only available on Apple devices) – see AkAACFactory.h [詳解]

#define	AKCODECID_FILE_PACKAGE (11)
	File package files generated by the File Packager utility. [詳解]

#define	AKCODECID_ATRAC9 (12)
	ATRAC-9 encoding [詳解]

#define	AKCODECID_VAG (13)
	VAG/HE-VAG encoding [詳解]

#define	AKCODECID_PROFILERCAPTURE (14)
	Profiler capture file (.prof) as written through AK::SoundEngine::StartProfilerCapture [詳解]

#define	AKCODECID_ANALYSISFILE (15)
	Analysis file [詳解]

#define	AKCODECID_MIDI (16)
	MIDI file [詳解]

#define	AKCODECID_OPUSNX (17)
	OpusNX encoding [詳解]

#define	AKCODECID_CAF (18)
	CAF file [詳解]

#define	AKCODECID_AKOPUS (19)
	Opus encoding, 2018.1 to 2019.2 [詳解]

#define	AKCODECID_AKOPUS_WEM (20)
	Opus encoding, wrapped in WEM [詳解]

#define	AKCODECID_MEMORYMGR_DUMP (21)
	Memory stats file as written through AK::MemoryMgr::DumpToFile(); [詳解]

#define	AKPLUGINID_METER (129)
	Meter Plugin [詳解]

#define	AKPLUGINID_RECORDER (132)
	Recorder Plugin [詳解]

#define	AKPLUGINID_IMPACTER (184)

#define	AKPLUGINID_SYSTEM_OUTPUT_META (900)
	System output metadata [詳解]

#define	AKEXTENSIONID_SPATIALAUDIO (800)
	Spatial Audio [詳解]

#define	AKEXTENSIONID_INTERACTIVEMUSIC (801)
	Interactive Music [詳解]

#define	AKEXTENSIONID_EVENTMGRTHREAD (900)
	Profiling: Event Manager [詳解]

#define	AK_WAVE_FORMAT_VAG 0xFFFB

#define	AK_WAVE_FORMAT_AT9 0xFFFC

#define	AK_WAVE_FORMAT_VORBIS 0xFFFF

#define	AK_WAVE_FORMAT_AAC 0xAAC0

#define	AK_WAVE_FORMAT_OPUSNX 0x3039

#define	AK_WAVE_FORMAT_OPUS 0x3040

#define	AK_WAVE_FORMAT_OPUS_WEM 0x3041

#define	WAVE_FORMAT_XMA2 0x166

#define	AK_PANNER_NUM_STORAGE_BITS 3

#define	AK_POSSOURCE_NUM_STORAGE_BITS 3

#define	AK_SPAT_NUM_STORAGE_BITS 3

#define	AK_MAX_BITS_METERING_FLAGS (5)

#define	AK_ALIGN(_declaration_, _alignment_) _declaration_ __attribute__( ( aligned( _alignment_ ) ) )

#define	AK_ENDIANNESS_LITTLE

#define	AK_UNALIGNED
	Refers to the __unaligned compilation flag available on some platforms. Note that so far, on the tested platform this should always be placed before the pointer symbol *. [詳解]

#define	AK_FINAL

#define	AK_ASYNC_OPEN_DEFAULT (false)
	Refers to asynchronous file opening in default low-level IO. [詳解]

#define	AK_COMM_DEFAULT_DISCOVERY_PORT 24024
	Default discovery port for most platforms using IP sockets for communication. [詳解]

#define	AkRegister

型定義
typedef AkUInt32	AkUniqueID
	Unique 32-bit ID [詳解]

typedef AkUInt32	AkStateID
	State ID [詳解]

typedef AkUInt32	AkStateGroupID
	State group ID [詳解]

typedef AkUInt32	AkPlayingID
	Playing ID [詳解]

typedef AkInt32	AkTimeMs
	Time in ms [詳解]

typedef AkUInt16	AkPortNumber
	Port number [詳解]

typedef AkReal32	AkPitchValue
	Pitch value [詳解]

typedef AkReal32	AkVolumeValue
	Volume value( also apply to LFE ) [詳解]

typedef AkUInt64	AkGameObjectID
	Game object ID [詳解]

typedef AkReal32	AkLPFType
	Low-pass filter type [詳解]

typedef AkInt32	AkMemPoolId
	Memory pool ID [詳解]

typedef AkUInt32	AkPluginID
	Source or effect plug-in ID [詳解]

typedef AkUInt32	AkCodecID
	Codec plug-in ID [詳解]

typedef AkUInt32	AkAuxBusID
	Auxilliary bus ID [詳解]

typedef AkInt16	AkPluginParamID
	Source or effect plug-in parameter ID [詳解]

typedef AkInt8	AkPriority
	Priority [詳解]

typedef AkUInt16	AkDataCompID
	Data compression format ID [詳解]

typedef AkUInt16	AkDataTypeID
	Data sample type ID [詳解]

typedef AkUInt8	AkDataInterleaveID
	Data interleaved state ID [詳解]

typedef AkUInt32	AkSwitchGroupID
	Switch group ID [詳解]

typedef AkUInt32	AkSwitchStateID
	Switch ID [詳解]

typedef AkUInt32	AkRtpcID
	Real time parameter control ID [詳解]

typedef AkReal32	AkRtpcValue
	Real time parameter control value [詳解]

typedef AkUInt32	AkBankID
	Run time bank ID [詳解]

typedef AkUInt32	AkFileID
	Integer-type file identifier [詳解]

typedef AkUInt32	AkDeviceID
	I/O device ID [詳解]

typedef AkUInt32	AkTriggerID
	Trigger ID [詳解]

typedef AkUInt32	AkArgumentValueID
	Argument value ID [詳解]

typedef AkUInt32	AkChannelMask
	Channel mask (similar to WAVE_FORMAT_EXTENSIBLE). Bit values are defined in AkSpeakerConfig.h. [詳解]

typedef AkUInt32	AkModulatorID
	Modulator ID [詳解]

typedef AkUInt32	AkAcousticTextureID
	Acoustic Texture ID [詳解]

typedef AkUInt32	AkImageSourceID
	Image Source ID [詳解]

typedef AkUInt64	AkOutputDeviceID
	Audio Output device ID [詳解]

typedef AkUInt32	AkPipelineID
	Unique node (bus, voice) identifier for profiling. [詳解]

typedef AkUInt32	AkRayID
	Unique (per emitter) identifier for an emitter-listener ray. [詳解]

typedef AkUInt64	AkAudioObjectID
	Audio Object ID [詳解]

typedef AkTransform	AkSoundPosition
	Positioning information for a sound. [詳解]

typedef AkTransform	AkListenerPosition
	Positioning information for a listener. [詳解]

typedef IAkSoftwareCodec (	AkCreateFileSourceCallback) (void *in_pCtx)
	Registered file source creation function prototype. [詳解]

typedef IAkSoftwareCodec (	AkCreateBankSourceCallback) (void *in_pCtx)
	Registered bank source node creation function prototype. [詳解]

typedef IAkFileCodec (	AkCreateFileCodecCallback) ()
	Registered FileCodec creation function prototype. [詳解]

typedef IAkGrainCodec (	AkCreateGrainCodecCallback) ()
	Registered IAkGrainCodec creation function prototype. [詳解]

typedef AkInt16	AkCaptureType
	Default value: capture type is short. [詳解]

列挙型
enum	AKRESULT { AK_NotImplemented = 0, AK_Success = 1, AK_Fail = 2, AK_PartialSuccess = 3, AK_NotCompatible = 4, AK_AlreadyConnected = 5, AK_InvalidFile = 7, AK_AudioFileHeaderTooLarge = 8, AK_MaxReached = 9, AK_InvalidID = 14, AK_IDNotFound = 15, AK_InvalidInstanceID = 16, AK_NoMoreData = 17, AK_InvalidStateGroup = 20, AK_ChildAlreadyHasAParent = 21, AK_InvalidLanguage = 22, AK_CannotAddItseflAsAChild = 23, AK_InvalidParameter = 31, AK_ElementAlreadyInList = 35, AK_PathNotFound = 36, AK_PathNoVertices = 37, AK_PathNotRunning = 38, AK_PathNotPaused = 39, AK_PathNodeAlreadyInList = 40, AK_PathNodeNotInList = 41, AK_DataNeeded = 43, AK_NoDataNeeded = 44, AK_DataReady = 45, AK_NoDataReady = 46, AK_InsufficientMemory = 52, AK_Cancelled = 53, AK_UnknownBankID = 54, AK_BankReadError = 56, AK_InvalidSwitchType = 57, AK_FormatNotReady = 63, AK_WrongBankVersion = 64, AK_FileNotFound = 66, AK_DeviceNotReady = 67, AK_BankAlreadyLoaded = 69, AK_RenderedFX = 71, AK_ProcessNeeded = 72, AK_ProcessDone = 73, AK_MemManagerNotInitialized = 74, AK_StreamMgrNotInitialized = 75, AK_SSEInstructionsNotSupported = 76, AK_Busy = 77, AK_UnsupportedChannelConfig = 78, AK_PluginMediaNotAvailable = 79, AK_MustBeVirtualized = 80, AK_CommandTooLarge = 81, AK_RejectedByFilter = 82, AK_InvalidCustomPlatformName = 83, AK_DLLCannotLoad = 84, AK_DLLPathNotFound = 85, AK_NoJavaVM = 86, AK_OpenSLError = 87, AK_PluginNotRegistered = 88, AK_DataAlignmentError = 89, AK_DeviceNotCompatible = 90, AK_DuplicateUniqueID = 91, AK_InitBankNotLoaded = 92, AK_DeviceNotFound = 93, AK_PlayingIDNotFound = 94, AK_InvalidFloatValue = 95, AK_FileFormatMismatch = 96, AK_NoDistinctListener = 97, AK_ACP_Error = 98, AK_ResourceInUse = 99 }
	Standard function call result. [詳解]

enum	AkGroupType { AkGroupType_Switch = 0, AkGroupType_State = 1 }
	Game sync group type [詳解]

enum	AkAudioDeviceState { AkDeviceState_Unknown = 0, AkDeviceState_Active = 1 << 0, AkDeviceState_Disabled = 1 << 1, AkDeviceState_NotPresent = 1 << 2, AkDeviceState_Unplugged = 1 << 3, AkDeviceState_All = AkDeviceState_Active \| AkDeviceState_Disabled \| AkDeviceState_NotPresent \| AkDeviceState_Unplugged }

enum	AkConnectionType { ConnectionType_Direct = 0x0, ConnectionType_GameDefSend = 0x1, ConnectionType_UserDefSend = 0x2, ConnectionType_ReflectionsSend = 0x3 }
	Nature of the connection binding an input to a bus. [詳解]

enum	AkCurveInterpolation { AkCurveInterpolation_Log3 = 0, AkCurveInterpolation_Sine = 1, AkCurveInterpolation_Log1 = 2, AkCurveInterpolation_InvSCurve = 3, AkCurveInterpolation_Linear = 4, AkCurveInterpolation_SCurve = 5, AkCurveInterpolation_Exp1 = 6, AkCurveInterpolation_SineRecip = 7, AkCurveInterpolation_Exp3 = 8, AkCurveInterpolation_LastFadeCurve = 8, AkCurveInterpolation_Constant = 9 }
	Curve interpolation types [詳解]

enum	AK::SoundEngine::MultiPositionType { AK::SoundEngine::MultiPositionType_SingleSource, AK::SoundEngine::MultiPositionType_MultiSources, AK::SoundEngine::MultiPositionType_MultiDirections }

enum	AkSpeakerPanningType { AK_DirectSpeakerAssignment = 0, AK_BalanceFadeHeight = 1, AK_SteeringPanner = 2 }
	Speaker panning type: type of panning logic when object is not 3D spatialized (i.e. when Ak3DSpatializationMode is AK_SpatializationMode_None). [詳解]

enum	Ak3DPositionType { AK_3DPositionType_Emitter = 0, AK_3DPositionType_EmitterWithAutomation = 1, AK_3DPositionType_ListenerWithAutomation = 2 }
	3D position type: defines what acts as the emitter position for computing spatialization against the listener. Used when Ak3DSpatializationMode is AK_SpatializationMode_PositionOnly or AK_SpatializationMode_PositionAndOrientation. [詳解]

enum	AkPanningRule { AkPanningRule_Speakers = 0, AkPanningRule_Headphones = 1 }
	Headphone / speakers panning rules [詳解]

enum	Ak3DSpatializationMode { AK_SpatializationMode_None = 0, AK_SpatializationMode_PositionOnly = 1, AK_SpatializationMode_PositionAndOrientation = 2 }
	3D spatialization mode. [詳解]

enum	AkBusHierarchyFlags { AkBusHierarchy_Primary = 1 << 0, AkBusHierarchy_Secondary = 1 << 1, AkBusHierarchy_IsMaster = 1 << 7 }
	Bus type bit field. [詳解]

enum	AkMeteringFlags { AK_NoMetering = 0, AK_EnableBusMeter_Peak = 1 << 0, AK_EnableBusMeter_TruePeak = 1 << 1, AK_EnableBusMeter_RMS = 1 << 2, AK_EnableBusMeter_KPower = 1 << 4, AK_EnableBusMeter_3DMeter = 1 << 5 }
	Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback() or AK::IAkMixerPluginContext::SetMeteringFlags(). [詳解]

enum	AkPluginType { AkPluginTypeNone = 0, AkPluginTypeCodec = 1, AkPluginTypeSource = 2, AkPluginTypeEffect = 3, AkPluginTypeMixer = 6, AkPluginTypeSink = 7, AkPluginTypeGlobalExtension = 8, AkPluginTypeMetadata = 9, AkPluginTypeMask = 0xf }

enum	AkNodeType { AkNodeType_Default, AkNodeType_Bus }

関数
AkRamp	operator* (const AkRamp &in_rLhs, const AkRamp &in_rRhs)

変数
static const AkPluginID	AK_INVALID_PLUGINID = (AkPluginID)-1
	Invalid FX ID [詳解]

static const AkGameObjectID	AK_INVALID_GAME_OBJECT = (AkGameObjectID)-1
	Invalid game object (may also mean all game objects) [詳解]

static const AkUniqueID	AK_INVALID_UNIQUE_ID = 0
	Invalid unique 32-bit ID [詳解]

static const AkRtpcID	AK_INVALID_RTPC_ID = AK_INVALID_UNIQUE_ID
	Invalid RTPC ID [詳解]

static const AkPlayingID	AK_INVALID_PLAYING_ID = AK_INVALID_UNIQUE_ID
	Invalid playing ID [詳解]

static const AkUInt32	AK_DEFAULT_SWITCH_STATE = 0
	Switch selected if no switch has been set yet [詳解]

static const AkMemPoolId	AK_INVALID_POOL_ID = -1
	Invalid pool ID [詳解]

static const AkMemPoolId	AK_DEFAULT_POOL_ID = -1
	Default pool ID, same as AK_INVALID_POOL_ID [詳解]

static const AkAuxBusID	AK_INVALID_AUX_ID = AK_INVALID_UNIQUE_ID
	Invalid auxiliary bus ID (or no Aux bus ID) [詳解]

static const AkFileID	AK_INVALID_FILE_ID = (AkFileID)-1
	Invalid file ID [詳解]

static const AkDeviceID	AK_INVALID_DEVICE_ID = (AkDeviceID)-1
	Invalid streaming device ID [詳解]

static const AkBankID	AK_INVALID_BANK_ID = AK_INVALID_UNIQUE_ID
	Invalid bank ID [詳解]

static const AkArgumentValueID	AK_FALLBACK_ARGUMENTVALUE_ID = 0
	Fallback argument value ID [詳解]

static const AkChannelMask	AK_INVALID_CHANNELMASK = 0
	Invalid channel mask [詳解]

static const AkUInt32	AK_INVALID_OUTPUT_DEVICE_ID = AK_INVALID_UNIQUE_ID
	Invalid Device ID [詳解]

static const AkPipelineID	AK_INVALID_PIPELINE_ID = AK_INVALID_UNIQUE_ID
	Invalid pipeline ID (for profiling) [詳解]

static const AkAudioObjectID	AK_INVALID_AUDIO_OBJECT_ID = (AkAudioObjectID)-1
	Invalid audio object ID [詳解]

static const AkPriority	AK_DEFAULT_PRIORITY = 50
	Default sound / I/O priority [詳解]

static const AkPriority	AK_MIN_PRIORITY = 0
	Minimal priority value [0,100] [詳解]

static const AkPriority	AK_MAX_PRIORITY = 100
	Maximal priority value [0,100] [詳解]

static const AkPriority	AK_DEFAULT_BANK_IO_PRIORITY = AK_DEFAULT_PRIORITY
	Default bank load I/O priority [詳解]

static const AkReal32	AK_DEFAULT_BANK_THROUGHPUT = 110241024/1000.f
	Default bank load throughput (1 Mb/ms) [詳解]

static const AkUInt32	AK_SOUNDBANK_VERSION = 140
	Version of the soundbank reader [詳解]

詳解

Data type definitions.

AkTypes.h に定義があります。

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう

Wwise SDK 2021.1.14

AkTypes.h

クラス

名前空間

マクロ定義

型定義

列挙型

関数

変数

詳解

このページはお役に立ちましたか？

サポートは必要ですか？

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。