Agora Java API Reference for Android
Classes | Public Types | Public Attributes | List of all members
agora::rtc::SimulcastConfig Struct Reference

#include <AgoraBase.h>

Classes

struct  StreamLayerConfig
 

Public Types

enum  StreamLayerIndex {
  STREAM_LAYER_1 = 0, STREAM_LAYER_2 = 1, STREAM_LAYER_3 = 2, STREAM_LAYER_4 = 3,
  STREAM_LAYER_5 = 4, STREAM_LAYER_6 = 5, STREAM_LOW = 6, STREAM_LAYER_COUNT_MAX = 7
}
 

Public Attributes

StreamLayerConfig configs [STREAM_LAYER_COUNT_MAX]
 
bool publish_fallback_enable
 

Detailed Description

The configuration of the multi-layer video stream.

Since
v4.6.0

Member Enumeration Documentation

◆ StreamLayerIndex

The index of multi-layer video stream

Enumerator
STREAM_LAYER_1 

0: The video stream of layer_1, which has a lower resolution and bitrate than STREAM_HIGH.

STREAM_LAYER_2 

1: The video stream of layer_2, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_1.

STREAM_LAYER_3 

2: The video stream of layer_3, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_2.

STREAM_LAYER_4 

3: The video stream of layer_4, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_3.

STREAM_LAYER_5 

4: The video stream of layer_5, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_4.

STREAM_LAYER_6 

5: The video stream of layer_6, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_5.

STREAM_LOW 

6: The low-quality video stream, which has the lowest resolution and bitrate.

STREAM_LAYER_COUNT_MAX 

7: Max count of video stream layers

Member Data Documentation

◆ configs

StreamLayerConfig agora::rtc::SimulcastConfig::configs[STREAM_LAYER_COUNT_MAX]

The array of StreamLayerConfig, which contains STREAM_LAYER_COUNT_MAX layers of video stream at most.

◆ publish_fallback_enable

bool agora::rtc::SimulcastConfig::publish_fallback_enable

Whether to enable fallback publishing. When set to true, it allows dynamic disabling of multiple streams when the performance or network of the publishing end is poor. The order of disabling is layer1->layer6.

  • true: Enable fallback publishing.
  • false: (Default) Disable fallback publishing.

The system guarantees that even under poor network conditions or limited device capabilities, at least the major stream and lowest-resolution minor stream will be maintained for basic video continuity.