AgoraLiveTranscodingUser Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

A class for providing user-specific CDN live audio/video transcoding settings.

  uid

User ID of the CDN live host.

@property (assign, nonatomic) NSUInteger uid

Declared In

AgoraObjects.h

  rect

Size and the position of the video frame relative to the top left corner.

@property (assign, nonatomic) CGRect rect

Declared In

AgoraObjects.h

  zOrder

The layer index of the video frame.

@property (assign, nonatomic) NSInteger zOrder

Discussion

From v2.3.0, the Agora SDK supports setting zOrder as 0.

An integer. The value range is [0,100].

  • 0: (Default) Bottom layer.
  • 100: Top layer.

Note: If the value is set lower than 0 or higher than 100, the AgoraErrorCodeInvalidArgument error occurs.

Declared In

AgoraObjects.h

  alpha

The transparency level of the user’s video.

@property (assign, nonatomic) double alpha

Discussion

The value ranges between 0.0 and 1.0:

  • 0.0: Completely transparent.
  • 1.0: (Default) Opaque.

Declared In

AgoraObjects.h

  audioChannel

The audio channel of the sound.

@property (assign, nonatomic) NSInteger audioChannel

Discussion

The default value is 0:

- 0: (Default) Supports dual channels. Depends on the upstream of the host.
- 1: The audio stream of the host uses the FL audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
- 2: The audio stream of the host uses the FC audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
- 3: The audio stream of the host uses the FR audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
- 4: The audio stream of the host uses the BL audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.
- 5: The audio stream of the host uses the BR audio channel. If the upstream of the host uses multiple audio channels, these channels will be mixed into mono first.

Note: If your setting is not 0, you may need a specialized player.

Declared In

AgoraObjects.h