文档中心
互动直播 (Legacy)
API 参考
Agora Unity API Reference for All Platforms
Agora Unity SDK API Reference
◆ width
int agora_gaming_rtc.LiveTranscoding.width |
推流视频的总宽度,默认值 360,单位为像素。
- 如果推视频流,
width
值不得低于 64,否则 Agora 会调整为 64。
- 如果推音频流,请将
width
和 height
设为 0。
◆ height
int agora_gaming_rtc.LiveTranscoding.height |
推流视频的总高度,默认值 640,单位为像素。
- 如果推视频流,
height
值不得低于 64,否则 Agora 会调整为 64。
- 如果推音频流,请将
width
和 height
设为 0。
◆ videoBitrate
int agora_gaming_rtc.LiveTranscoding.videoBitrate |
用于旁路推流的输出视频的码率。 单位为 Kbps。 400 Kbps 为默认值。用户可以根据 Video Profile 参考表中的码率值进行设置;如果设置的码率超出合理范围,Agora 服务器会在合理区间内自动调整码率值。
◆ videoFramerate
int agora_gaming_rtc.LiveTranscoding.videoFramerate |
用于旁路推流的输出视频的帧率。取值范围是 (0,30],单位为 fps。15 fps 为默认值。
- 注解
- Agora 会将所有高于 30 fps 的帧率统一设为 30 fps。
◆ lowLatency
bool agora_gaming_rtc.LiveTranscoding.lowLatency |
- 弃用:
- true: 低延时,不保证画质;
- false: (默认值)高延时,保证画质。
◆ videoGop
int agora_gaming_rtc.LiveTranscoding.videoGop |
用于旁路直播的输出视频的 GOP。单位为帧。默认值为 30 fps。
◆ videoCodecProfile
◆ backgroundColor
uint agora_gaming_rtc.LiveTranscoding.backgroundColor |
用于旁路直播的输出视频的背景色,格式为 RGB 定义下的十六进制整数,不要带 # 号,如 0xFFB6C1 表示浅粉色。默认0x000000,黑色。
◆ userCount
uint agora_gaming_rtc.LiveTranscoding.userCount |
◆ transcodingUsers
◆ transcodingExtraInfo
string agora_gaming_rtc.LiveTranscoding.transcodingExtraInfo |
预留参数:用户自定义的发送到旁路推流客户端的信息。用于填充 H.264/H.265 视频中 SEI 帧内容。长度限制 4096 字节。关于 SEI 的详细信息,详见 SEI 帧相关问题。
◆ metadata
string agora_gaming_rtc.LiveTranscoding.metadata |
- 弃用:
- 发送给 CDN 客户端的 metadata。
◆ watermark
RtcImage agora_gaming_rtc.LiveTranscoding.watermark |
用于旁路直播的输出视频上的水印图片。添加后所有旁路直播的观众都可以看到水印。水印图片的定义详见 RtcImage 。必须为 PNG 格式。
◆ watermarkCount
uint agora_gaming_rtc.LiveTranscoding.watermarkCount |
直播视频上的水印的数量。取值范围为 [0,100]。该参数与 watermark
搭配使用。
◆ backgroundImage
RtcImage agora_gaming_rtc.LiveTranscoding.backgroundImage |
用于旁路直播的输出视频上的背景图片。添加后所有旁路直播的观众都可以看到背景图片。背景图片的定义详见 RtcImage 。
◆ audioSampleRate
◆ backgroundImageCount
uint agora_gaming_rtc.LiveTranscoding.backgroundImageCount |
直播视频上的背景图的数量。取值范围为 [0,100]。该参数与 backgroundImage
搭配使用。
- 自从
- v3.6.1.1
◆ audioBitrate
int agora_gaming_rtc.LiveTranscoding.audioBitrate |
用于旁路推流的输出音频的码率。单位为 Kbps,默认值为 48,最大值为 128。
◆ audioChannels
int agora_gaming_rtc.LiveTranscoding.audioChannels |
用于旁路推流的输出音频的声道数,默认值为 1。取值范围为 [1,5] 中的整型,建议取 1 或 2:
- 1: 单声道(默认)
- 2: 双声道
- 3: 三声道
- 4: 四声道
- 5: 五声道
◆ audioCodecProfile