SetShapePcmFormat

Sets the PCM format.

Syntax

HRESULT SetShapePcmFormat(  
         SHAPE_PCM_CONTEXT* context,  
         SHAPE_PCM_FORMAT format  
)  

context _Inout_
Type: SHAPE_PCM_CONTEXT* Pointer to a SHAPE_PCM_CONTEXT structure. format
Type: SHAPE_PCM_FORMAT One member of the SHAPE_PCM_FORMAT enumeration.

Type: HRESULT HRESULT success or error code.

Function	Description
Non-looping linear PCM	Start the voice using the `SHAPE_SRC_COMMAND_TYPE_START` constant for the Sample Rate Convertor (SRC). Let the voice play to the end, or optionally stop it short of the end using the `SHAPE_SRC_COMMAND_TYPE_STOP_IMMEDIATE` constant. For more information, see SHAPE_SRC_COMMAND_TYPE enumeration.
Infinite looping linear PCM	Set the PCM context loop count loopCount to the `SHAPE_PCM_INFINITE_LOOP_COUNT` constant. Start the voice using `SHAPE_SRC_COMMAND_TYPE_START` for the SRC. Let the voice play until you want to stop, either at the end of a loop using `SHAPE_SRC_COMMAND_TYPE_STOP_END` and let the voice play out, or immediately by using `SHAPE_SRC_COMMAND_TYPE_STOP_IMMEDIATE`.
Finite looping linear PCM	Set the PCM context loop count loopCount to [0, 254]. Start the voice using `SHAPE_SRC_COMMAND_TYPE_START` for the SRC. Let the voice play to the end, or optionally stop it at the end of a loop using `SHAPE_SRC_COMMAND_TYPE_STOP_END` and let the voice play out, or stop it immediately by using `SHAPE_SRC_COMMAND_TYPE_STOP_IMMEDIATE`.
Circular PCM	Start the voice using `SHAPE_SRC_COMMAND_TYPE_START` for the SRC. Keep streaming data, updating the PCM context write pointer, until you want to stop. Use `SHAPE_SRC_COMMAND_TYPE_STOP_END` to let the SRC play to the current PCM write pointer `loopStartWritePointer`, or `SHAPE_SRC_COMMAND_TYPE_STOP_IMMEDIATE` to stop it immediately.

Input sample formats:\

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