> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetShapeEqCompPeakMagnitude

> GetShapeEqCompPeakMagnitude

# GetShapeEqCompPeakMagnitude

ピーク マグニチュードを取得します。

## Syntax

```cpp theme={null}
float GetShapeEqCompPeakMagnitude(  
         const SHAPE_EQCOMP_CONTEXT* context  
)  
```

### パラメーター

*context*   \_In\_\
型: [SHAPE\_EQCOMP\_CONTEXT\*](https://docs.xbox.com/ja-jp/reference/audio/shapeeqcompcontext/structs/shape_eqcomp_context.md)

`SHAPE_EQCOMP_CONTEXT` オブジェクトへのポインター。

### 戻り値

型: float

ピーク マグニチュード。

## 解説

各ハードウェア ブロックは、そのハードウェア ブロックの出力のマグニチュードを表す 2 つの 4 ビット値を保持しています。マグニチュードは、オーディオ フレーム中のピーク出力を判定し、そのピークの絶対値の先頭ゼロをカウントすることで算出されます。1 つの 4 ビット値は継続的に保持されるピーク マグニチュードとして維持され、もう 1 つはオーディオ フレームごとにハードウェアによってリセットされます。

詳細については、[SHAPE の概要](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/shape-overview.md)の[オーバーフロー、マグニチュード、および飽和](https://docs.xbox.com/ja-jp/build/console-features/audio/overviews/shape-overview.md#ID4ELAAC)を参照してください。

## 要件

**ヘッダー:** shapeeqcompcontext.h

**対応プラットフォーム:** XBOX One ファミリ本体および XBOX Series 本体

## 関連項目

[GetShapeEqCompMixBufferPeakMagnitude](https://docs.xbox.com/ja-jp/reference/audio/shapeeqcompcontext/functions/getshapeeqcompmixbufferpeakmagnitude.md)\
[ShapeEqCompContext](https://docs.xbox.com/ja-jp/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members.md)


## Related topics

- [GetShapeEqCompMixBufferPeakMagnitude](https://docs.xbox.com/ja-jp/reference/audio/shapeeqcompcontext/functions/getshapeeqcompmixbufferpeakmagnitude.md)
- [GetShapeEqCompInternalSaturate](https://docs.xbox.com/ja-jp/reference/audio/shapeeqcompcontext/functions/getshapeeqcompinternalsaturate.md)
- [ShapeEqCompContext](https://docs.xbox.com/ja-jp/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members.md)
- [GetShapeDmaPeakMagnitude](https://docs.xbox.com/ja-jp/reference/audio/shapedmacontext/functions/getshapedmapeakmagnitude.md)
- [GetShapeFiltVolPeakMagnitude](https://docs.xbox.com/ja-jp/reference/audio/shapefiltvolcontext/functions/getshapefiltvolpeakmagnitude.md)