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

#include <aws_ivs_realtime_errors.h>

Data Fields

int32_t code
aws_ivs_realtime_error_type type
int32_t platform_code
bool is_fatal
const char * source
const char * message

Detailed Description

An error delivered by a failed operation or asynchronous Stage event. A function's documented errors are not exhaustive. For any error, fatality says whether the Stage can still be used, and the code and message identify the failure when reporting it.

Field Documentation

◆ code

int32_t aws_ivs_realtime_error::code

Public or SDK-internal error code. Unknown codes represent internal errors.

◆ is_fatal

bool aws_ivs_realtime_error::is_fatal

Whether the error terminated the Stage or otherwise requires termination handling.

◆ message

const char* aws_ivs_realtime_error::message

Human-readable error detail. In a callback, valid only until the callback returns; copy it to retain it. Returned through out_error, valid until aws_ivs_realtime_error_destroy().

◆ platform_code

int32_t aws_ivs_realtime_error::platform_code

Platform-specific code such as an HTTP status or errno; zero when unavailable.

◆ source

const char* aws_ivs_realtime_error::source

Component that produced the error. In a callback, valid only until the callback returns; copy it to retain it. Returned through out_error, valid until aws_ivs_realtime_error_destroy().

◆ type

aws_ivs_realtime_error_type aws_ivs_realtime_error::type

Category of the error.


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