chat_manager::start_processing_stream_state_changes
Retrieves an array of all Game Chat 2 audio stream state changes that occurred since the last call to this method.
Syntax
void start_processing_stream_state_changes(
uint32_t* streamStateChangeCount,
game_chat_stream_state_change_array* streamStateChanges
)
Parameters
streamStateChangeCount _Out_
Type: uint32_t*
The total number of state changes in streamStateChanges.
streamStateChanges _Outptr_result_buffer_(*streamStateChangeCount)
Type: game_chat_stream_state_change_array*
An array of game_chat_stream_state_change structure pointers that represents the stream state changes to be processed by the app.
Return value
Type: void
None.
Remarks
This method retrieves all state changes queued by Game Chat 2 for audio streams, to be processed by the app. Calling this method retrieves information about how audio streams have been updated as an array of game_chat_stream_state_change structure pointers. The app iterates over the array and processes each stream state change as needed.
Note
This method should not be called on your UI thread. Calling this method requires coordination with your audio thread.
After all stream state changes included in streamStateChanges have been processed, the app then calls chat_manager::finish_processing_stream_state_changes, passing the processed stream state changes back to Game Chat 2, to indicate that the resources associated with the processed stream state changes can be released.
Note
If you call this method, you must call chat_manager::finish_processing_stream_state_changes after you have finished processing stream state changes. If you call this method again without first calling chat_manager::finish_processing_stream_state_changes, an error occurs.
For more information about processing stream state changes, see Using the Game Chat 2 C++ API.
Requirements
Header: GameChat2.h
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles