AgoraLiveTranscodingUser Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

提供旁路推流时特定用户音频/视频转码设置的类

  uid

旁路推流的用户 ID

@property (assign, nonatomic) NSUInteger uid

Declared In

AgoraObjects.h

  rect

直播视频上用户视频在布局中相对左上角的位置和大小信息

@property (assign, nonatomic) CGRect rect

Declared In

AgoraObjects.h

  zOrder

直播视频上用户视频帧的图层编号

@property (assign, nonatomic) NSInteger zOrder

Discussion

SDK 从 v2.3.0 开始支持将 zOrder 设为 0。

整数，取值范围为 0 到 100:

  • 最小值为 0（默认值），表示该区域图像位于最下层
  • 最大值为 100，表示该区域图像位于最上层

Note: 如果取值小于 0 或大于 100，会返回错误 AgoraErrorCodeInvalidArgument。

Declared In

AgoraObjects.h

  alpha

直播视频上用户视频的透明度。取值范围为 [0.0,1.0]。0.0 表示该区域图像完全透明，而 1.0 表示该区域图像完全不透明。默认值为 1.0。

@property (assign, nonatomic) double alpha

Declared In

AgoraObjects.h

  audioChannel

主播音频所在的声道。取值范围为 [0,5]：

@property (assign, nonatomic) NSInteger audioChannel

Discussion

  • 0：(默认) 最多支持双声道，与主播端上行音频相关。
  • 1：该主播的音频在推流中位于 FL 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
  • 2：该主播的音频在推流中位于 FC 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
  • 3：该主播的音频在推流中位于 FR 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
  • 4：该主播的音频在推流中位于 BL 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。
  • 5：该主播的音频在推流中位于 BR 声道。如果主播端上行音频是多声道，会先把多声道混音成单声道。

Note: 取值为 1、2、3、4、5 时，你需要使用特殊的播放器。传入取值范围外的值时，声网服务器会在输出音频中移除该主播的音频。

Declared In

AgoraObjects.h