React Native API Reference
Hierarchy
- LiveTranscoding
Index
Constructors
Properties
Constructors
constructor
-
Parameters
-
transcodingUsers: TranscodingUser[]
-
Optional params: undefined | { advancedFeatures?: Map<String, boolean>; audioBitrate?: undefined | number; audioChannels?: AudioChannel; audioCodecProfile?: AudioCodecProfileType; audioSampleRate?: AudioSampleRateType; backgroundColor?: Color; backgroundImage?: AgoraImage; backgroundImageList?: AgoraImage[]; height?: undefined | number; lowLatency?: undefined | false | true; metadata?: undefined | string; userConfigExtraInfo?: undefined | string; videoBitrate?: undefined | number; videoCodecProfile?: VideoCodecProfileType; videoCodecType?: VideoCodecTypeForStream; videoFramerate?: VideoFrameRate; videoGop?: undefined | number; watermark?: AgoraImage; watermarkList?: AgoraImage[]; width?: undefined | number }
Returns LiveTranscoding
-
Properties
Optional audioBitrate
用于旁路推流的输出音频的码率。单位为 Kbps，默认值为 48，最大值为 128。
Optional audioChannels
用于旁路推流的输出音频的声道数，取值范围为 [1,5] 中的整型，默认值为 1。建议取 1 或 2，如果取值为 3、4或5，需要特殊播放器支持：
- 1：单声道
- 2：双声道
- 3：三声道
- 4：四声道
- 5：五声道
Optional audioCodecProfile
用于旁路推流的输出音频的编码规格。详见 AudioCodecProfileType。可以设置为 LC-AAC 或 HE-AAC。默认为 LC-AAC。
Optional audioSampleRate
自定义音频采样率。详见 AudioSampleRateType。
Optional backgroundColor
用于旁路直播的输出视频的背景色。
Optional backgroundImage
直播视频上的背景图。图片格式需为 PNG。
Optional backgroundImageList
直播视频上的背景图数组。
你可以使用 backgroundImageList 添加一张或多张背景图。
图片格式需为 PNG。直播视频上的水印和背景图的总数量需大于等于 0 且小于等于 10。
Optional height
推流视频的总高度，默认值 640，单位为像素。
- 如果推视频流，
height取值范围为 [64,1080]。如果取值低于 64，声网服务器会自动调整为 64；如果取值高于 1080，声网服务器会自动调整为 1080。 - 如果推音频流，请将
width和height设为 0。
Optional lowLatency
Optional metadata
发送给 CDN 客户端的 metadata。
transcodingUsers
用于管理参与直播推流的视频转码合图的用户。最多支持 17 人同时参与转码合图。
Optional userConfigExtraInfo
预留参数。 用户自定义的发送到旁路推流客户端的信息，用于填充 H264/H265 视频中 SEI 帧内容。长度限制：4096字节。
Optional videoBitrate
用于旁路推流的输出视频的码率。 单位为 Kbps。 400 Kbps 为默认值。用户可以根据码率参考表参考表中的码率值进行设置； 如果设置的码率超出合理范围，声网服务器会在合理区间内自动调整码率值。
Optional videoCodecProfile
用于旁路直播的输出视频的编码规格。详见 VideoCodecProfileType。 可以设置为 BASELINE、MAIN 或 HIGH （默认值）级别。如果设置其他值，声网服务器会统一设为默认值 100。
Optional videoCodecType
用于旁路直播的输出视频的编解码类型。
Optional videoFramerate
用于旁路推流的输出视频的帧率。取值范围是 (0,30]，单位为 fps。默认值为 15 fps。
声网会将所有高于 30 fps 的帧率统一设为 30 fps。
Optional videoGop
用于旁路直播的输出视频的 GOP。单位为帧。默认值为 30 fps。
Optional watermark
直播视频上的水印。图片格式需为 PNG。
Optional watermarkList
直播视频上的水印数组。
你可以使用 watermarkList 添加一张或多张水印。图片格式需为 PNG。
直播视频上的水印和背景图的总数量需大于等于 0 且小于等于 10。
Optional width
推流视频的总宽度，默认值 360，单位为像素。
- 如果推视频流，
width取值范围为 [64,1920]。如果取值低于 64，声网服务器会自动调整为 64；如果取值高于 1920，声网服务器会自动调整为 1920。 - 如果推音频流，请将
width和height设为 0。
管理 CDN 直播推流转码的接口。