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

# GetShapeXmaOutputBufferNumFramesAvailable

> GetShapeXmaOutputBufferNumFramesAvailable

# GetShapeXmaOutputBufferNumFramesAvailable

Gets the number of frames available for reading from the output buffer.

<a id="syntaxSection" />

## Syntax

```cpp theme={null}
UINT32 GetShapeXmaOutputBufferNumFramesAvailable(  
         const SHAPE_XMA_CONTEXT* context  
)  
```

<a id="parametersSection" />

### Parameters

*context*   \_In\_\
Type: [SHAPE\_XMA\_CONTEXT](/reference/audio/shapexmacontext/structs/shape_xma_context)\*

Pointer to a [SHAPE\_XMA\_CONTEXT](/reference/audio/shapexmacontext/structs/shape_xma_context) object.

<a id="retvalSection" />

### Return value

Type: UINT32

Number of frames available for reading.

<a id="remarksSection" />

## Remarks

To get the number of bytes available for reading, use [GetShapeXmaOutputBufferNumBytesAvailable](/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffernumbytesavailable).

To get the current read offset of the output buffer, use [GetShapeXmaOutputBufferReadOffset](/reference/audio/shapexmacontext/functions/getshapexmaoutputbufferreadoffset).

For more information, see the [XMA](/build/console-features/audio/overviews/shape-overview#ID4EYD) section of [Overview of SHAPE](/build/console-features/audio/overviews/shape-overview).

<a id="requirementsSection" />

## Requirements

**Header:** shapexmacontext.h

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

<a id="seealsoSection" />

## See also

[ShapeXmaContext](/reference/audio/shapexmacontext/shapexmacontext_members)


## Related topics

- [GetShapeXmaOutputBufferNumBytesAvailable](/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffernumbytesavailable.md)
- [ShapeXmaContext](/reference/audio/shapexmacontext/shapexmacontext_members.md)
- [GetShapeXmaOutputBuffer](/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffer.md)
- [GetShapeXmaOutputBufferSize](/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffersize.md)
- [GetShapeXmaOutputBufferValid](/reference/audio/shapexmacontext/functions/getshapexmaoutputbuffervalid.md)