AgoraLiveTranscoding 类

Inherits from NSObject
Declared in AgoraObjects.h

概览

管理旁路推流转码的类

  size

推流视频的总尺寸(宽和高),单位为像素。

@property (assign, nonatomic) CGSize size

详情

  • 如果推视频流,宽和高的值均不得低于 64,否则 Agora 会调整为 64。
  • 如果推音频流,请将宽和高都设为 0。

Declared In

AgoraObjects.h

  videoBitrate

用于旁路直播的输出视频的码率。单位为 Kbps。400 Kbps 为默认值。

@property (assign, nonatomic) NSInteger videoBitrate

详情

你可以根据 Video Profile 参考表中的码率值进行设置;如果设置的码率超出合理范围,Agora 服务器会在合理区间内自动调整码率值。

Declared In

AgoraObjects.h

  videoFramerate

用于旁路直播的输出视频的帧率。取值范围是 (0,30],单位为 fps。15 fps 为默认值。Agora 服务器会将高于 30 fps 的帧率设置改为 30 fps。

@property (assign, nonatomic) NSInteger videoFramerate

Declared In

AgoraObjects.h

  lowLatency

低延时模式

@property (assign, nonatomic) BOOL lowLatency

详情

DEPRECATED 自 v2.8.0 起废弃。Agora 不推荐使用。

  • YES: 低延时,不保证画质
  • NO:(默认值)高延时,保证画质

Declared In

AgoraObjects.h

  videoGop

用于旁路直播的输出视频的 GOP。单位为帧。默认值为 30 帧。

@property (assign, nonatomic) NSInteger videoGop

Declared In

AgoraObjects.h

  videoCodecProfile

用于旁路直播的输出视频的编码规格。

@property (assign, nonatomic) AgoraVideoCodecProfileType videoCodecProfile

详情

可以设置为 66、77 或 100,详见 AgoraVideoCodecProfileType

如果设置其他值,Agora 服务器会统一设为默认值 100。

Declared In

AgoraObjects.h

  transcodingUsers

用于管理参与旁路直播的视频转码合图的用户。最多支持 17 人同时参与转码合图,详见 AgoraLiveTranscodingUser

@property (copy, nonatomic) NSDictionary<NSNumber*AgoraLiveTranscodingUser*> *transcodingUsers

Declared In

AgoraObjects.h

  transcodingExtraInfo

预留参数:用户自定义的发送到旁路推流客户端的信息,用于填充 H264/H265 视频中 SEI 帧内容。长度限制:4096 字节。关于 SEI 的详细信息,详见SEI 帧相关问题

@property (copy, nonatomic) NSString *transcodingExtraInfo

Declared In

AgoraObjects.h

  watermark

用于旁路直播的输出视频上的水印图片

@property (strong, nonatomic) AgoraImage *watermark

详情

仅支持 PNG 格式的图片。添加后所有旁路直播的观众都可以看到水印。水印图片的定义详见 AgoraImage

Declared In

AgoraObjects.h

  backgroundImage

用于旁路直播的输出视频上的背景图片

@property (strong, nonatomic) AgoraImage *backgroundImage

详情

添加后所有旁路直播的观众都可以看到背景图片。背景图片的定义详见 AgoraImage

Declared In

AgoraObjects.h

  backgroundColor

用于旁路直播的输出视频的背景色

@property (strong, nonatomic) COLOR_CLASS *backgroundColor

详情

格式为 RGB 定义下的十六进制整数,不要带 # 号,如 0xFFB6C1 表示浅粉色。默认 0x000000,黑色。

COLOR_CLASS 为类型统称,具体为:

  • iOS: UIColor
  • macOS: NSColor

Declared In

AgoraObjects.h

  audioSampleRate

用于旁路直播的输出音频的采样率,详见 AgoraAudioSampleRateType

@property (assign, nonatomic) AgoraAudioSampleRateType audioSampleRate

Declared In

AgoraObjects.h

  audioBitrate

用于旁路直播的输出音频的码率。单位为 Kbps,默认值为 48,最大值为 128

@property (assign, nonatomic) NSInteger audioBitrate

Declared In

AgoraObjects.h

  audioChannels

用于旁路直播的输出音频的声道数,默认值为 1。取值范围为 [1,5] 中的整型,建议取 1 或 2。3、4、5需要特殊播放器支持:

@property (assign, nonatomic) NSInteger audioChannels

详情

  • 1: 单声道
  • 2: 双声道
  • 3: 三声道
  • 4: 四声道
  • 5: 五声道

Declared In

AgoraObjects.h

  audioCodecProfile

用于旁路直播输出音频的编码规格,默认值为 AgoraAudioCodecProfileLCAAC(0)。详见 AgoraAudioCodecProfileType。

@property (assign, nonatomic) AgoraAudioCodecProfileType audioCodecProfile

Declared In

AgoraObjects.h

+ defaultTranscoding

应用默认的转码设置

+ (AgoraLiveTranscoding *_Nonnull)defaultTranscoding

返回

应用默认设置的 AgoraLiveTranscoding 对象

Declared In

AgoraObjects.h

– addUser:

添加一个用户到已有的用户中。

- (int)addUser:(AgoraLiveTranscodingUser *_Nonnull)user

参数

user

参数合图的用户,定义详见 AgoraLiveTranscodingUser

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

Declared In

AgoraObjects.h

– removeUser:

删除转码合图用户

- (int)removeUser:(NSUInteger)uid

参数

uid

待删除的用户 ID

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

Declared In

AgoraObjects.h