post_decode_audio_source_stream::custom_stream_context

Retrieves the app's optional, private, custom pointer-sized context value previously associated with this stream object.

Syntax

void* custom_stream_context(  
)  

Parameters

None.

Return value

Type: void*

The pointer-sized value previously associated with this stream object; otherwise, a null pointer.

Remarks

This method retrieves the app's optional, private, custom pointer-sized context value previously associated with this post_decode_audio_source_stream object. If no custom stream context has been set yet for this post_decode_audio_source_stream object, this method returns a null pointer.

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. Use the post_decode_audio_source_stream::set_custom_stream_context method to set the custom stream context for a post_decode_audio_source_stream object.

Requirements

Header: GameChat2.h

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

See also

Intro to Game Chat 2
post_decode_audio_source_stream