Skip to main content

SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, UINT32)

Sets the sample rate.

Syntax

Parameters

context   _Inout_
Type: SHAPE_XMA_CONTEXT*
Pointer to a SHAPE_XMA_CONTEXT object. sampleRate   
Type: UINT32
The sample rate, in hertz.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

The sampleRate parameter is converted to a member of the SHAPE_XMA_SAMPLE_RATE enumeration, as shown in the following table. To set the sample rate by using a member of the SHAPE_XMA_SAMPLE_RATE enumeration instead of an integer, use SetShapeXmaSampleRate(SHAPE_XMA_CONTEXT*, SHAPE_XMA_SAMPLE_RATE). To get the current sample rate, use GetShapeXmaSampleRate. For more information, see the XMA section of Overview of SHAPE.

Requirements

Header: shapexmacontext.h Supported platforms: XBOX One family consoles and XBOX Series consoles

See also

ShapeXmaContext
Last modified on October 19, 2026