SetShapePcmLoopStartOrWritePointer

Sets the loop start for linear buffers or a write pointer for circular buffers.

Syntax

HRESULT SetShapePcmLoopStartOrWritePointer(  
         SHAPE_PCM_CONTEXT* context,  
         UINT32 loopStartOrWritePointerInSamples  
)  

Parameters

context _Inout_
Type: SHAPE_PCM_CONTEXT* Pointer to a SHAPE_PCM_CONTEXT structure. loopStartOrWritePointerInSamples
Type: UINT32 Specifies the loop start or a write pointer.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

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 the SHAPE_SRC_COMMAND_TYPE enumeration.
Infinite looping linear PCM	Set the Pulse Code Modulation (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.

Requirements

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

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

SetShapePcmLoopStartOrWritePointer

SetShapePcmLoopStartOrWritePointer

Syntax

Parameters

Return value

Remarks

Requirements

See also

​SetShapePcmLoopStartOrWritePointer

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

SetShapePcmLoopStartOrWritePointer

Syntax

Parameters

Return value

Remarks

Requirements

See also