IVS Linux Broadcast SDK (C) 1.49.0
Loading...
Searching...
No Matches
aws_ivs_realtime_participant_info Struct Reference

#include <aws_ivs_realtime.h>

Data Fields

const char * participant_id
const char * user_id
bool is_local
size_t attributes_count
const char *const * attributes_keys
const char *const * attributes_values

Detailed Description

An immutable snapshot of a participant in a Stage.

Field Documentation

◆ attributes_count

size_t aws_ivs_realtime_participant_info::attributes_count

Free-form participant attributes as key/value metadata. Number of key/value pairs.

◆ attributes_keys

const char* const* aws_ivs_realtime_participant_info::attributes_keys

Keys for attributes; attributes_count entries, parallel to attributes_values by index. Null when attributes_count is 0. Valid only until the callback returns; copy keys you need to retain.

◆ attributes_values

const char* const* aws_ivs_realtime_participant_info::attributes_values

Values for attributes; parallel to attributes_keys by index. Valid only until the callback returns; copy values you need to retain.

◆ is_local

bool aws_ivs_realtime_participant_info::is_local

True if this is the local participant (the token used to join).

◆ participant_id

const char* aws_ivs_realtime_participant_info::participant_id

Unique participant ID within the Stage. Valid only until the callback returns; copy it to retain it.

◆ user_id

const char* aws_ivs_realtime_participant_info::user_id

User ID associated with the participant. May be empty. Valid only until the callback returns; copy it to retain it.


The documentation for this struct was generated from the following file: