game_chat_data_frame

Represents information about outgoing Game Chat 2 data that must be delivered to remote Game Chat 2 endpoints.

Syntax

typedef struct game_chat_data_frame {  
    uint32_t target_endpoint_identifier_count;  
    uint64_t* target_endpoint_identifiers;  
    game_chat_data_transport_requirement transport_requirement;  
    uint32_t packet_byte_count;  
    uint8_t* packet_buffer;  
} game_chat_data_frame  

Members

target_endpoint_identifier_count
Type: uint32_t The number of remote endpoint identifiers specified in target_endpoint_identifiers. target_endpoint_identifiers _Field_size_(target_endpoint_identifier_count)
Type: uint64_t* An array of one or more remote endpoint identifiers to which this data must be transmitted. The array has the number of members specified in target_endpoint_identifier_count. transport_requirement
Type: game_chat_data_transport_requirement The transport requirements for the data. packet_byte_count
Type: uint32_t The size of the data buffer that must be transmitted to the remote endpoints specified by target_endpoint_identifiers. packet_buffer _Field_size_(packet_byte_count)
Type: uint8_t* A pointer to the data buffer that must be transmitted to the remote endpoints specified by target_endpoint_identifiers.

Remarks

This structure represents information about outgoing Game Chat 2 data, such as audio data, that must be delivered to remote Game Chat 2 endpoints. game_chat_data_frame structures are reported by the chat_manager::start_processing_data_frames method. The app processes the data frames, and then promptly passes them back by calling the chat_manager::finish_processing_data_frames method. The memory for the target_endpoint_identifiers array remains valid until this object has been returned by calling chat_manager::finish_processing_data_frames. The possible endpoint identifier values in that array are those that have been previously specified by calls to the chat_manager::add_remote_user method.