post_decode_audio_source_stream::set_custom_stream_context

Configures an optional, custom pointer-sized context value with this stream object.

Syntax

void set_custom_stream_context(  
    void* customStreamContext  
)  

Parameters

customStreamContext   _In_
Type: void*

An arbitrary, pointer-sized value to store with the stream object.

Return value

Type: void

Remarks

The custom stream context is typically used as a "shortcut" that simplifies accessing local, app-specific memory associated with the stream without requiring a mapping lookup. The value is retrieved using the post_decode_audio_source_stream::custom_stream_context.

Any configured value is treated as opaque by the library, and is only valid on the local device; it is not transmitted over the network.

Requirements

Header: GameChat2.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

post_decode_audio_source_stream
post_decode_audio_source_stream::custom_stream_context