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

Layer position of the video frame. The value ranges between 0 and 100.

@property (assign, nonatomic) NSInteger zOrder

Discussion

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

- 0: (Default) Lowest.
- 100: Highest.

Note: If the value is set to < 0 or > 100, the ERR_INVALID_ARGUMENT error occurs.

Declared In

AgoraObjects.h

  alpha

Transparency of the video frame.

@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 broadcaster.
- 1: The audio stream of the broadcaster uses the FL audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
- 2: The audio stream of the broadcaster uses the FC audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
- 3: The audio stream of the broadcaster uses the FR audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
- 4: The audio stream of the broadcaster uses the BL audio channel. If the upstream of the broadcaster uses multiple audio channels, these channels will be mixed into mono first.
- 5: The audio stream of the broadcaster uses the BR audio channel. If the upstream of the broadcaster 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